API ReferenceSlas

List Metric Definitions

Lists metric definitions matching a filter.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

applies_to_typelist of enumsOptional
The type of objects the metric definition applies to.
Allowed values:
cursorstringOptionalformat: "text"
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
include_custom_metricsbooleanOptional
Whether to include custom metrics in the response. If not set, then custom metrics are excluded.
limitintegerOptional
The maximum number of records to return. The default is '50'.
modeenumOptional
The iteration mode to use, otherwise if not set, then "after" is used.
Allowed values:
sort_bylist of stringsOptional
Fields to sort the records by and the direction to sort them.
statuslist of enumsOptional
The status of the metric definition.
Allowed values:
typelist of enumsOptional
The type of metric definitions sought.
Allowed values:

Response

Success.
metric_definitionslist of objects
The list of metric definitions.
next_cursorstring or nullformat: "text"
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursorstring or nullformat: "text"
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

Errors