slas

Metric Definitions List Post

POST
Lists metric definitions matching a filter.

Request

This endpoint expects an object.
applies_to_type
list of enumsOptional
The type of objects the metric definition applies to.
Allowed values: conversationticket
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
type
list of enumsOptional
The type of metric definitions sought.
Allowed values: timevalue

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.
POST
1curl -X POST https://api.devrev.ai/metric-definitions.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200
Successful
1{
2  "metric_definitions": [
3    {
4      "id": "id",
5      "created_date": "2023-01-01T12:00:00Z",
6      "display_id": "display_id",
7      "modified_date": "2023-01-01T12:00:00Z",
8      "name": "name"
9    }
10  ],
11  "next_cursor": "next_cursor",
12  "prev_cursor": "prev_cursor"
13}
Built with