docs: add response to get reports by app example

This commit is contained in:
Stevan Freeborn
2023-04-17 16:25:23 -05:00
parent 041a7a00dd
commit a79fdb2e3d
7 changed files with 92 additions and 4 deletions
@@ -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 %}
@@ -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 %}
@@ -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 %}
@@ -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 %}
@@ -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 %}
@@ -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 %}
@@ -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 %}