Metric Definitions List

GET

Lists metric definitions matching a filter.

Query parameters

applies_to_typeenumOptional

The type of objects the metric definition applies to.

Allowed values: conversationissueticket
cursorstringOptional

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

include_custom_metricsbooleanOptionalDefaults to false

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’.

mode"after" or "before"Optional

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore
sort_bystringOptional

Fields to sort the records by and the direction to sort them.

status"active" or "inactive"Optional

The status of the metric definition.

Allowed values: activeinactive
type"time" or "value"Optional

The type of metric definitions sought.

Allowed values: timevalue

Response

This endpoint returns an object.
metric_definitionslist of objects

The list of metric definitions.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.