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.

namestringRequiredformat: "text">=1 character<=64 characters

A unique human readable name of the metric.

descriptionstringOptionalformat: "text"<=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     "conversation"
8   ],
9   "name": "x"
10 }'

201Created

1 {
2   "metric_definition": {
3     "created_by": {
4       "type": "dev_user",
5       "display_picture": {
6         "file": {
7           "type": "type",
8           "name": "name"
9         },
10         "id": "id",
11         "display_id": "display_id"
12       },
13       "id": "id",
14       "state": "active",
15       "display_id": "display_id",
16       "display_name": "display_name",
17       "email": "email",
18       "full_name": "full_name"
19     },
20     "id": "id",
21     "modified_by": {
22       "type": "dev_user",
23       "display_picture": {
24         "file": {
25           "type": "type",
26           "name": "name"
27         },
28         "id": "id",
29         "display_id": "display_id"
30       },
31       "id": "id",
32       "state": "active",
33       "display_id": "display_id",
34       "display_name": "display_name",
35       "email": "email",
36       "full_name": "full_name"
37     },
38     "created_date": "created_date",
39     "display_id": "display_id",
40     "modified_date": "modified_date",
41     "name": "name"
42   }
43 }

Delete Metric Definition

Up Next

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	"conversation"
8	],
9	"name": "x"
10	}'

1	{
2	"metric_definition": {
3	"created_by": {
4	"type": "dev_user",
5	"display_picture": {
6	"file": {
7	"type": "type",
8	"name": "name"
9	},
10	"id": "id",
11	"display_id": "display_id"
12	},
13	"id": "id",
14	"state": "active",
15	"display_id": "display_id",
16	"display_name": "display_name",
17	"email": "email",
18	"full_name": "full_name"
19	},
20	"id": "id",
21	"modified_by": {
22	"type": "dev_user",
23	"display_picture": {
24	"file": {
25	"type": "type",
26	"name": "name"
27	},
28	"id": "id",
29	"display_id": "display_id"
30	},
31	"id": "id",
32	"state": "active",
33	"display_id": "display_id",
34	"display_name": "display_name",
35	"email": "email",
36	"full_name": "full_name"
37	},
38	"created_date": "created_date",
39	"display_id": "display_id",
40	"modified_date": "modified_date",
41	"name": "name"
42	}
43	}