From a79fdb2e3da622cb0a563899d9884dfb080d619e Mon Sep 17 00:00:00 2001 From: Stevan Freeborn <65925598+StevanFreeborn@users.noreply.github.com> Date: Mon, 17 Apr 2023 16:25:23 -0500 Subject: [PATCH] docs: add response to get reports by app example --- .../records/get_record_by_id/copy.md | 2 +- .../records/get_records_by_app/copy.md | 2 +- .../records/get_records_by_ids/copy.md | 2 +- .../records/get_records_by_query/copy.md | 2 +- .../reports/get_report_by_id/copy.md | 40 +++++++++++++++++++ .../reports/get_report_by_id/example.md | 28 +++++++++++++ .../reports/get_reports_by_app/example.md | 20 ++++++++++ 7 files changed, 92 insertions(+), 4 deletions(-) diff --git a/src/docs/version_002/resources/records/get_record_by_id/copy.md b/src/docs/version_002/resources/records/get_record_by_id/copy.md index 33eef50..e39c44e 100644 --- a/src/docs/version_002/resources/records/get_record_by_id/copy.md +++ b/src/docs/version_002/resources/records/get_record_by_id/copy.md @@ -42,6 +42,6 @@ This endpoint returns a single [record](#records) based on the given record id. - dataFormat - `string` -- The [format](#data-format) of the field data in the response. Valid values are `raw` and `formatted`. If not specified, `raw` will be used. +- The [format](#data-format) of the field data in the response. Valid values are `Raw` and `Formatted`. If not specified, `Raw` will be used. {% /table %} diff --git a/src/docs/version_002/resources/records/get_records_by_app/copy.md b/src/docs/version_002/resources/records/get_records_by_app/copy.md index 7b91fc8..0cbfd06 100644 --- a/src/docs/version_002/resources/records/get_records_by_app/copy.md +++ b/src/docs/version_002/resources/records/get_records_by_app/copy.md @@ -38,6 +38,6 @@ This endpoint returns a [paged](#pagination) collection of [records](#records) f - dataFormat - `string` -- The [format](#data-format) of the field data in the response. Valid values are `raw` and `formatted`. If not specified, `raw` will be used. +- The [format](#data-format) of the field data in the response. Valid values are `Raw` and `Formatted`. If not specified, `Raw` will be used. {% /table %} diff --git a/src/docs/version_002/resources/records/get_records_by_ids/copy.md b/src/docs/version_002/resources/records/get_records_by_ids/copy.md index 1689ee8..36f66c6 100644 --- a/src/docs/version_002/resources/records/get_records_by_ids/copy.md +++ b/src/docs/version_002/resources/records/get_records_by_ids/copy.md @@ -32,7 +32,7 @@ This endpoint returns a batch of [records](#records) that match the given ids. - dataFormat - `string` -- The [format](#data-format) of the field data in the response. Valid values are `raw` and `formatted`. If not specified, `raw` will be used. +- The [format](#data-format) of the field data in the response. Valid values are `Raw` and `Formatted`. If not specified, `Raw` will be used. {% /table %} diff --git a/src/docs/version_002/resources/records/get_records_by_query/copy.md b/src/docs/version_002/resources/records/get_records_by_query/copy.md index 0a10c8d..927641a 100644 --- a/src/docs/version_002/resources/records/get_records_by_query/copy.md +++ b/src/docs/version_002/resources/records/get_records_by_query/copy.md @@ -36,7 +36,7 @@ This endpoint returns a [paged](#pagination) collection of [records](#records) f - dataFormat - `string` -- The [format](#data-format) of the field data in the response. Valid values are `raw` and `formatted`. If not specified, `raw` will be used. +- The [format](#data-format) of the field data in the response. Valid values are `Raw` and `Formatted`. If not specified, `Raw` will be used. {% /table %} diff --git a/src/docs/version_002/resources/reports/get_report_by_id/copy.md b/src/docs/version_002/resources/reports/get_report_by_id/copy.md index 28d4df4..b4058b5 100644 --- a/src/docs/version_002/resources/reports/get_report_by_id/copy.md +++ b/src/docs/version_002/resources/reports/get_report_by_id/copy.md @@ -1 +1,41 @@ # Get Report by Id {% #get-report-by-id %} + +This endpoint returns the [Report Data](#report-data) for the given report. + +## Path Parameters + +{% table %} + +- Property Name +- Data Type +- Description + +--- + +- reportId +- `number` +- The id of the report. + +{% /table %} + +## Query Parameters + +{% table %} + +- Property Name +- Data Type +- Description + +--- + +- apiDataFormat +- `string` +- The [format](#data-format) of the field data in the response. Valid values are `Raw` and `Formatted`. If not specified, `Raw` will be used. + +--- + +- dataType +- `string` +- Indicate whether you want the report's report data or its chart data returned. Valid values are `ReportData` and `ChartData`. If not specified, `ReportData` will be used. + +{% /table %} diff --git a/src/docs/version_002/resources/reports/get_report_by_id/example.md b/src/docs/version_002/resources/reports/get_report_by_id/example.md index 01f9c0b..4c6af8f 100644 --- a/src/docs/version_002/resources/reports/get_report_by_id/example.md +++ b/src/docs/version_002/resources/reports/get_report_by_id/example.md @@ -1 +1,29 @@ # Retrieving data from a report + +{% code method="GET" heading="/Reports/{reportId}" defaultLanguage="bash" %} + +```bash + +``` + +```csharp + +``` + +```javascript + +``` + +```python + +``` + +{% /code %} + +{% code heading="RESPONSE" defaultLanguage="json" %} + +```json + +``` + +{% /code %} diff --git a/src/docs/version_002/resources/reports/get_reports_by_app/example.md b/src/docs/version_002/resources/reports/get_reports_by_app/example.md index 8d41c22..c7119c2 100644 --- a/src/docs/version_002/resources/reports/get_reports_by_app/example.md +++ b/src/docs/version_002/resources/reports/get_reports_by_app/example.md @@ -65,3 +65,23 @@ for report in response.data.reports: ``` {% /code %} + +{% code heading="RESPONSE" defaultLanguage="json" %} + +```json +{ + "pageNumber": 1, + "pageSize": 1, + "totalPages": 1, + "totalRecords": 1, + "items": [ + { + "appId": 195, + "id": 613, + "name": "Test 1" + } + ] +} +``` + +{% /code %}