/export/query/metrics - Kinetica Docs

URL: http://<db.host>:<db.port>/export/query/metrics

Export query metrics to a given destination. Returns query metrics.

Input Parameter Description

map of string to strings

Optional parameters.The default value is an empty map ( {} ).

Show options

Filter for multi query export.

Path to export target specified as a filename or existing directory.

Specifies which format to export the metrics.The default value is json.

json: Generic JSON output.
json_trace_event: Chromium/Perfetto trace event format.

Export query metrics for the currently running job.

Record limit per file for multi query export.

Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

String

‘OK’ or ‘ERROR’

String

Empty if success or an error message

String

‘export_query_metrics_response’ or ‘none’ in case of an error

String

Empty string

JSON or String

This embedded JSON represents the result of the /export/query/metrics endpoint:

Show data_str

map of string to strings

Additional information.The default value is an empty map ( {} ).

Show info

Comma separated list of filenames exported if applicable.

Exported metrics if no other destination specified.

Empty string in case of an error.

​Input Parameter Description

​Output Parameter Description

Input Parameter Description

Output Parameter Description