Slas
List Metric Definitions
Lists metric definitions matching a filter.
AuthorizationBearer <token>
All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request.
How do I find my token?
In: header
Query Parameters
applies_to_type?array<metric-definition-applies-to>
The type of objects the metric definition applies to.
cursor?string
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
Format
textinclude_custom_metrics?boolean
Whether to include custom metrics in the response. If not set, then custom metrics are excluded.
limit?integer
The maximum number of records to return. The default is '50'.
Format
int32mode?string
The iteration mode to use, otherwise if not set, then "after" is used.
Value in
"after" | "before"sort_by?array<string>
Fields to sort the records by and the direction to sort them.
status?array<metric-definition-status>
The status of the metric definition.
type?array<metric-definition-metric-type>
The type of metric definitions sought.
Response Body
curl -X GET "https://api.devrev.ai/metric-definitions.list?applies_to_type=conversation&cursor=string&include_custom_metrics=true&limit=0&mode=after&sort_by=string&status=active&type=time"{
"metric_definitions": [
{
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"name": "string"
}
],
"next_cursor": "string",
"prev_cursor": "string"
}{
"detail": "string",
"message": "string",
"type": "artifact_already_attached_to_a_parent",
"existing_parent": "string",
"is_same": true
}{
"detail": "string",
"message": "string",
"type": "unauthenticated"
}{
"detail": "string",
"message": "string",
"type": "forbidden"
}{
"detail": "string",
"message": "string",
"type": "too_many_requests",
"retry_after": 0
}{
"detail": "string",
"message": "string",
"type": "internal_error",
"reference_id": "string"
}{
"detail": "string",
"message": "string",
"type": "service_unavailable"
}