Create Metric Definition

POST

Creates a custom metric definition

Request

This endpoint expects an object.

applies_tolist of enumsRequired

Allowed values: conversationissueticket

The list of object types on which the metric can be applied.

namestringRequired>=1 character<=64 characters

A unique human readable name of the metric.

descriptionstringOptional<=1024 characters

Description of the purpose and operation of the metric.

Response

Success.

metric_definitionobject

POST

1 curl -X POST https://api.devrev.ai/metric-definitions.create \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "applies_to": [
6     "conversation"
7   ],
8   "name": "name"
9 }'

200Successful

1 {
2   "metric_definition": {
3     "id": "id",
4     "created_by": {
5       "type": "sys_user",
6       "id": "created_by",
7       "display_id": "created_by",
8       "display_name": "created_by",
9       "display_picture": {
10         "id": "id"
11       },
12       "email": "created_by",
13       "full_name": "created_by",
14       "state": "active"
15     },
16     "created_date": "2023-01-01T12:00:00Z",
17     "display_id": "display_id",
18     "modified_by": {
19       "type": "sys_user",
20       "id": "modified_by",
21       "display_id": "modified_by",
22       "display_name": "modified_by",
23       "display_picture": {
24         "id": "id"
25       },
26       "email": "modified_by",
27       "full_name": "modified_by",
28       "state": "active"
29     },
30     "modified_date": "2023-01-01T12:00:00Z",
31     "name": "name"
32   }
33 }

Built with

1	curl -X POST https://api.devrev.ai/metric-definitions.create \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"applies_to": [
6	"conversation"
7	],
8	"name": "name"
9	}'

1	{
2	"metric_definition": {
3	"id": "id",
4	"created_by": {
5	"type": "sys_user",
6	"id": "created_by",
7	"display_id": "created_by",
8	"display_name": "created_by",
9	"display_picture": {
10	"id": "id"
11	},
12	"email": "created_by",
13	"full_name": "created_by",
14	"state": "active"
15	},
16	"created_date": "2023-01-01T12:00:00Z",
17	"display_id": "display_id",
18	"modified_by": {
19	"type": "sys_user",
20	"id": "modified_by",
21	"display_id": "modified_by",
22	"display_name": "modified_by",
23	"display_picture": {
24	"id": "id"
25	},
26	"email": "modified_by",
27	"full_name": "modified_by",
28	"state": "active"
29	},
30	"modified_date": "2023-01-01T12:00:00Z",
31	"name": "name"
32	}
33	}