QueryResponseMeta
objectQuery response metadata.
The dimension name and values returned in the response.
Show Child Parameters
The metric requested in query.
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 unit of metric.
Show Child Parameters
Unix timestamp in milliseconds specifying the lower bound to return data for the query. Provided from the query parameters.
Unix timestamp in milliseconds specifying the upper bound to return data for the query. Provided from the query parameters.
True if the limit of dimension values was reached and results were truncated. Limit value is 50.
The resulting time bucket for the returned data. If TIME was not specified as a dimension, granularity is the duration of the query.
Optional ID used to look up the query.
QueryResponseRecord
objectA response record.
Event within the response. Mapping from the requested metrics and dimensions to the values.
Show Child Parameters
An ISO-8601 timestamp. If TIME was requested as a dimension this will be the start of the time bucket. If not specified this is the start time of the query.
Example:2023-08-03T15:00:00.000Z
QueryResponseRecords
arrayQuery response data.
Event within the response. Mapping from the requested metrics and dimensions to the values.
Show Child Parameters
An ISO-8601 timestamp. If TIME was requested as a dimension this will be the start of the time bucket. If not specified this is the start time of the query.
Example:2023-08-03T15:00:00.000Z
GetConfigResponse
objectNull if analytics is not enabled.
Show Child Parameters
Error
objectstandard error
The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.
A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.
The error type.
Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.
A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.