Metric Definitions List Post

POST

Lists metric definitions matching a filter.

Request

This endpoint expects an object.
typelist of "time" or "value"Optional
Allowed values: timevalue

The type of metric definitions sought.

applies_to_typelist of enumsOptional
Allowed values: conversationissueticket

The type of objects the metric definition applies to.

cursorstringOptional

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

mode"after" or "before"Optional
Allowed values: afterbefore

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.

sort_bylist of stringsOptional

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

statuslist of "active" or "inactive"Optional
Allowed values: activeinactive

The status of the metric definition.

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.

Built with