Metric Definitions Update

POST

Updates a custom metric definition

Request

This endpoint expects an object.

idstringRequired

The ID of the metric definition to update.

descriptionstringOptional<=1024 characters

The updated description of the purpose and operation of the metric.

namestringOptional>=1 character<=64 characters

The updated unique human readable name of the metric.

status"active" or "inactive"Optional

Allowed values: activeinactive

The status of the metric. ‘active’ metrics can be used to create new SLAs, while ‘inactive’ metrics can not be used in new SLAs. Metrics can be updated between ‘active’ and ‘inactive’ states.

Response

This endpoint returns an object.

metric_definitionobject

POST

1 curl -X POST https://api.devrev.ai/metric-definitions.update \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "id": "id"
6 }'

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.update \
2	-H "Authorization: Bearer <token>" \
3	-H "Content-Type: application/json" \
4	-d '{
5	"id": "id"
6	}'

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	}