Live Report Builder API
Get your report data outside of MixCommander (BI tools, etc.)
/ams/reports/{id}/data
GET
https://api.commander1.com/v2/{siteId}/ams/reports/{id}/data
Returns data for each metric of the report. Metrics and attribution models are listed in the response in a columns array. Values are listed in a rows array. Each row has a type and a list of values for each metric. The type defines if the row describes the total of all values or a single value of the level.
Path Parameters
Name | Type | Description |
---|---|---|
id | integer | Repord ID (public id or technical id) |
Query Parameters
Name | Type | Description |
---|---|---|
token | string | Authentication token. Optional if the query parameter is used instead. |
levels | array | To specify the values of the parent levels. Send value for each level_id (1 and 2 in examples below). Ex: levels[1]=SEA&levels[2]=generic |
filters | array | To specify the values of the filters. Send value(s) for each filter_id (1 and 2 in examples below). Ex: filters[1][]=fr&filters[1][]=it&filters[2][]=tab |
date | boolean | To specify the range period. Default is the last three months. The use of ISO 8601 standard is strongly recommended. Ex: date[start]=2020-11-30T23:00:00.000Z&date[end]=2020-12-31T22:59:59.999Z |
This API uses JSON API to fetch, create and modify the resources, and to format responses. Authentication and information exchange are ensured with JSON WEB TOKEN.
How to get the token
For each API, you'll have to ask a token to your account manager or support team.
Last updated