QueryResponseMeta
objectQuery response metadata.
The blob represents how to interpret large UUID strings in the data response. The structure is records of dimension_id -> ID -> entity metadata. Since entity names within Konnect may overlap, ids are returned and used for exact grouping. This blob may be used to join and display results in a more human friendly manner. Since IDs represent entities in the system at all points in time, historical data will still exist even if an entity is deleted. These such entities are marked with the deleted key.
Another special case is the OTHER entity. When the limit of cardinality is reached for a second dimension, the system will group all other entities into the OTHER grouping. This prevents returning an overwhelming number of long tail entities.
Example:{"applciation":{"bf16907c-8673-4f9d-aa83-111111111111":{"deleted":true,"name":"bf16907c-8673-4f9d-aa83-111111111111"},"bf16907c-8673-4f9d-aa83-1f2ea9215055":{"deleted":false,"name":"Api v1 Beta"}}}
Show Child Parameters
The metric requested in query.
Allowed values:request_countrequest_per_minuteresponse_latency_averageresponse_size_averageresponse_size_sumrequest_size_averagerequest_size_sum
>= 1 items<= 1 items
The unit of metric.
Show Child Parameters
Start of the query time range.
End of the query time range.
True if the limit of dimension values was reached and results were truncated. Limit value is 50.
Applied query cardinality limit.
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.
QueryResponseEvent
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
QueryResponseData
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.