All reporting resources share a common set of request parameters, documented below. Note that the order of fields in the payload does not matter.
π
Code Examples
To better understand how these parameters can be used, see the Code Examples.
Report Parameters
REQUIRED.
Parameter | Type | Description |
| string | The start date and time for the range to show in the response (inclusive of the hour) Format: |
| string | The end date and time for the range to show in the response (inclusive of the hour). Format: To capture full day of an |
| string | Retrieve data based on timezone (default: |
| string | Time breakdown for the results being returned. Supported: |
|
| See Metrics |
|
| See Breakdown |
|
| See Filters |
|
| See Filters |
Pagination Parameters
OPTIONAL. If not in the request, default values will apply.
Parameter | Type | Description |
| integer | The page of results to be returned (default: |
| integer | Number of results to be returned (default: |
Sorting Parameters
OPTIONAL.
Parameter | Type | Description |
| string | Specify the name of the breakdown or metric to sort by |
| string | Specify |