DisplayBlob

object
apiobject
applicationobject
status_codeobject
status_code_groupedobject
Example

QueryResponseMeta

object

Query response metadata.

* Additional properties are NOT allowed.
displayobject

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
metric_namesarray[string]

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

metric_unitsobject

The unit of metric.

Show Child Parameters
startstring(date-time)

Start of the query time range.

endstring(date-time)

End of the query time range.

truncatedboolean

True if the limit of dimension values was reached and results were truncated. Limit value is 50.

limitnumber

Applied query cardinality limit.

granularity_msinteger

The resulting time bucket for the returned data. If time was not specified as a dimension, granularity is the duration of the query.

query_idstring

Optional ID used to look up the query.

Example

QueryResponseEvent

object

A response record.

* Additional properties are NOT allowed.
eventobject

Event within the response. Mapping from the requested metrics and dimensions to the values.

Show Child Parameters
timestampstring(date-time)

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

Example

QueryResponseData

array

Query response data.

eventobject

Event within the response. Mapping from the requested metrics and dimensions to the values.

Show Child Parameters
timestampstring(date-time)

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

object
* Additional properties are NOT allowed.
analyticsobjectrequired

Null if analytics is not enabled.

* Additional properties are NOT allowed.
Show Child Parameters
Example