Get Monitoring Breakdown Timeseries
GET {{baseUrl}}/data/v1/monitoring/metrics/:MONITORING_METRIC_ID/breakdown-timeseries
Gets timeseries of breakdown information for a specific dimension and metric. Each datapoint in the response represents 5 seconds worth of data.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
dimension | string | Dimension the specified value belongs to | |
timeframe[] | string | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=). |
The default for this is the last 60 seconds of available data. Timeframes larger than 10 minutes are not allowed, and must be within the last 24 hours.
|
| timeframe[]
| string | | Timeframe window to limit results by. Must be provided as an array query string parameter (e.g. timeframe[]=).
The default for this is the last 60 seconds of available data. Timeframes larger than 10 minutes are not allowed, and must be within the last 24 hours.
|
| filters[]
| string | | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.
To exclude rows that match a certain condition, prepend a !
character to the dimension.
Possible filter names are the same as returned by the List Monitoring Dimensions endpoint.
Example:
filters[]=operating_system:windows&filters[]=!country:US
| |filters[]
| string | | Limit the results to rows that match conditions from provided key:value pairs. Must be provided as an array query string parameter.
To exclude rows that match a certain condition, prepend a !
character to the dimension.
Possible filter names are the same as returned by the List Monitoring Dimensions endpoint.
Example:
filters[]=operating_system:windows&filters[]=!country:US
| |limit
| number | | Number of items to include in each timestamp'svalue
list.
The default is 10, and the maximum is 100.
|
| order_by
| string | | Value to order the results by |
| order_direction
| string | | Sort order. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"data":[{"values":[{"value":"FR","metric_value":0.008195679660675846,"concurrent_viewers":2680,"starting_up_viewers":10},{"value":"ES","metric_value":0.010317417106767573,"concurrent_viewers":36,"starting_up_viewers":1},{"value":"GB","metric_value":0.008232510579858339,"concurrent_viewers":26,"starting_up_viewers":1}],"date":"2023-05-18T19:36:30Z"},{"values":[{"value":"FR","metric_value":0.00724579660675846,"concurrent_viewers":2690,"starting_up_viewers":1},{"value":"ES","metric_value":0.014317417106767573,"concurrent_viewers":35,"starting_up_viewers":15},{"value":"GB","metric_value":0.007232510579851874,"concurrent_viewers":24,"starting_up_viewers":1}],"date":"2023-05-18T19:36:35Z"}],"timeframe":[1684438590,1684438600],"total_row_count":2}