API ReferenceSlas

List Metric Definitions (POST)

Lists metric definitions matching a filter.

Headers

AuthorizationstringRequired

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

Request

This endpoint expects an object.
typelist of enumsOptional
The type of metric definitions sought.
Allowed values:
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. If “after”, then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If “before”, then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.

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:

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