Application Analytics
The API for querying Application Analytics. Application Analytics is only available for private portals.
Query Application Analytics
Query
Body
application/json
Body
Object describing the query sent to analytics API.
QueryApplicationAnalytics
Unix timestamp in milliseconds specifying the lower bound to return data for the query, inclusive.
Unix timestamp in milliseconds specifying upper bound to return data for the query, inclusive.
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. Some metrics, such as latency and response size, have more complicated aggregations: selecting P99 will result in the 99th percentile of the chosen metric.
Allowed values:REQUEST_COUNTREQUEST_PER_MINUTERESPONSE_LATENCY_P99RESPONSE_LATENCY_P95RESPONSE_LATENCY_P50RESPONSE_SIZE_P99RESPONSE_SIZE_P95RESPONSE_SIZE_P50REQUEST_SIZE_P99REQUEST_SIZE_P95REQUEST_SIZE_P50
>= 1 items<= 1 items
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.
Allowed values:API_PRODUCT_VERSIONAPPLICATIONSTATUS_CODESTATUS_CODE_GROUPEDTIME
Default:[]
>= 0 items<= 2 items
granularity_ms is only valid for queries that include a time dimension, and it specifies the time buckets in for the returned data.
Default:86400000
One OfDefault:[]
Show Child Parameters
Response
application/json
Response
A response from an Application Analytics query.
Query response metadata.
Show Child Parameters
A response record.
Show Child Parameters
Get Application Analytics Config
Get config for application analytics
Response
application/json
Response
Get config
GetConfigResponse
Null if analytics is not enabled.
Show Child Parameters
QueryApplicationAnalytics
objectUnix timestamp in milliseconds specifying the lower bound to return data for the query, inclusive.
Unix timestamp in milliseconds specifying upper bound to return data for the query, inclusive.
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. Some metrics, such as latency and response size, have more complicated aggregations: selecting P99 will result in the 99th percentile of the chosen metric.
Allowed values:REQUEST_COUNTREQUEST_PER_MINUTERESPONSE_LATENCY_P99RESPONSE_LATENCY_P95RESPONSE_LATENCY_P50RESPONSE_SIZE_P99RESPONSE_SIZE_P95RESPONSE_SIZE_P50REQUEST_SIZE_P99REQUEST_SIZE_P95REQUEST_SIZE_P50
>= 1 items<= 1 items
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.
Allowed values:API_PRODUCT_VERSIONAPPLICATIONSTATUS_CODESTATUS_CODE_GROUPEDTIME
Default:[]
>= 0 items<= 2 items
granularity_ms is only valid for queries that include a time dimension, and it specifies the time buckets in for the returned data.
Default:86400000
One OfDefault:[]
Show Child Parameters
FilterType
stringThe type of filter to apply. IN filters will limit results to only the specified values, while NOT_IN filters will exclude the specified values.
Allowed values:INNOT_IN