Download OpenAPI specification:Download
API for querying Application Analytics.
The API for querying Application Analytics. Application Analytics is only available for when the user is authenticated.
Query
Object describing the query sent to analytics API.
| metrics required | Array of strings = 1 items Items Enum: "request_count" "request_per_minute" "response_latency_average" "response_size_average" "response_size_sum" "request_size_average" "request_size_sum" A property of your API (such as request count or latency) that you wish to query on. Your chosen metric is aggregated within the specified dimensions, meaning that if you query 'request count by application', you'll receive the total number of requests each application received within the given time frame. |
| dimensions | Array of strings [ 0 .. 2 ] items Default: [] Items Enum: "api" "application" "status_code" "status_code_grouped" "time" The dimensions for the query. A query may have up to 2 dimensions, including time. If no dimensions are provided, the report will simply return the provided metric aggregated across all available data. |
| granularity | string Enum: "tenSecondly" "thirtySecondly" "minutely" "fiveMinutely" "tenMinutely" "thirtyMinutely" "hourly" "twoHourly" "twelveHourly" "daily" "weekly"
|
RelativeTimeRangeDto (object) or AbsoluteTimeRangeDto (object) Default: {"type":"relative","time_range":"1h"} The time range to query. | |
Array of ApiFilter (object) or ApplicationFilter (object) or StatusCodeFilter (object) or StatusCodeGroupedFilter (object) Default: [] |
{- "time_range": {
- "type": "relative",
- "time_range": "24h",
- "tz": "EST"
}, - "metrics": [
- "request_per_minute"
], - "filters": [
- {
- "field": "api",
- "operator": "in",
- "value": [
- "417e47e8-ae7b-48a1-9b34-3f6835161de1"
]
}
]
}{- "meta": {
- "display": { },
- "metric_names": [
- "request_per_minute"
], - "metric_units": {
- "request_per_minute": "count/minute"
}, - "start": "2023-08-04T14:08:00.000Z",
- "end": "2023-08-05T14:08:00.000Z",
- "granularity_ms": 86400000,
- "truncated": false,
- "limit": 50,
- "query_id": "portal-api-3c0abb98-90bd-4e80-a495-ac268acc493e"
}, - "data": [
- {
- "event": {
- "request_per_minute": 1340.8666666666666
}, - "timestamp": "2023-08-04T14:08:00.000Z"
}
]
}