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     "id": "id",
4     "created_by": {
5       "type": "dev_user",
6       "id": "id",
7       "display_id": "display_id",
8       "display_name": "display_name",
9       "display_picture": {
10         "id": "id",
11         "display_id": "display_id",
12         "file": {}
13       },
14       "email": "email",
15       "full_name": "full_name",
16       "state": "active"
17     },
18     "created_date": "created_date",
19     "display_id": "display_id",
20     "modified_by": {
21       "type": "dev_user",
22       "id": "id",
23       "display_id": "display_id",
24       "display_name": "display_name",
25       "display_picture": {
26         "id": "id",
27         "display_id": "display_id",
28         "file": {}
29       },
30       "email": "email",
31       "full_name": "full_name",
32       "state": "active"
33     },
34     "modified_date": "modified_date",
35     "name": "name"
36   }
37 }

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	"id": "id",
4	"created_by": {
5	"type": "dev_user",
6	"id": "id",
7	"display_id": "display_id",
8	"display_name": "display_name",
9	"display_picture": {
10	"id": "id",
11	"display_id": "display_id",
12	"file": {}
13	},
14	"email": "email",
15	"full_name": "full_name",
16	"state": "active"
17	},
18	"created_date": "created_date",
19	"display_id": "display_id",
20	"modified_by": {
21	"type": "dev_user",
22	"id": "id",
23	"display_id": "display_id",
24	"display_name": "display_name",
25	"display_picture": {
26	"id": "id",
27	"display_id": "display_id",
28	"file": {}
29	},
30	"email": "email",
31	"full_name": "full_name",
32	"state": "active"
33	},
34	"modified_date": "modified_date",
35	"name": "name"
36	}
37	}