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

Errors

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": "foo"
9 }'

201slasMetricDefinitionsCreateExample

1 {
2   "metric_definition": {
3     "id": "foo",
4     "created_by": {
5       "display_id": "foo",
6       "id": "foo",
7       "display_name": "foo",
8       "display_picture": {
9         "display_id": "foo",
10         "id": "foo",
11         "file": {
12           "type": "foo",
13           "name": "foo",
14           "size": 42
15         }
16       },
17       "email": "foo",
18       "full_name": "foo",
19       "state": "active"
20     },
21     "created_date": "2023-01-01T12:00:00.000Z",
22     "display_id": "foo",
23     "modified_by": {
24       "display_id": "foo",
25       "id": "foo",
26       "display_name": "foo",
27       "display_picture": {
28         "display_id": "foo",
29         "id": "foo",
30         "file": {
31           "type": "foo",
32           "name": "foo",
33           "size": 42
34         }
35       },
36       "email": "foo",
37       "full_name": "foo",
38       "state": "active"
39     },
40     "modified_date": "2023-01-01T12:00:00.000Z",
41     "name": "foo"
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	],
8	"name": "foo"
9	}'

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