The type of objects the metric definition applies to.
Allowed values: conversationissueticket
cursor
stringOptional
The cursor to resume iteration from. If not provided, then
iteration starts from the beginning.
include_custom_metrics
booleanOptional
Whether to include custom metrics in the response. If not set, then
custom metrics are excluded.
limit
integerOptional
The maximum number of records to return. The default is '50'.
mode
enumOptional
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: afterbefore
status
list of enumsOptional
The status of the metric definition.
Allowed values: activeinactive
Response
This endpoint returns an object
metric_definitions
list of objects
The list of metric definitions.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the
sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the
sort order. If not set, then no prior elements exist.