Log monitoring metrics API - GET all metrics
Lists all log metric configurations.
The request produces an application/json
payload.
This request is currently in preview and is subject to change. Changes may not be compatible with your current configuration.
GET |
|
Parameters
The request doesn't provide any configurable parameters.
Response format
The StubList object
An ordered list of short representations of DESK entities.
Element | Type | Description |
---|---|---|
values | EntityShortRepresentation[] | An ordered list of short representations of DESK entities. |
The EntityShortRepresentation object
The short representation of a DESK entity.
Element | Type | Description |
---|---|---|
id | string | The ID of the DESK entity. |
name | string | The name of the DESK entity. |
description | string | A short description of the DESK entity. |
{
"values": [
{
"id": "6a98d7bc-abb9-44f8-ae6a-73e68e71812a",
"name": "DESK entity 1",
"description": "DESK entity 1 for the REST API example\n"
},
{
"id": "ee70f7d3-9a4e-4f5f-94d2-c9d6156f1618",
"name": "DESK entity 2"
},
{
"id": "8cdabe77-9e1a-4be8-b3df-269dd6fa9d7f"
}
]
}
Example
In this example, the request lists all custom log metrics in the mySampleEnv environment.
The API token is passed in the Authorization header.
The result is truncated to three entries.
Curl
curl -X GET \
https://mySampleEnv.live.DESK.com/api/config/v1/customMetric/log \
-H 'Authorization: Api-token abcdefjhij1234567890'
Request URL
https://mySampleEnv.live.dexp.ae/api/config/v1/customMetric/log
Response body
{
"values": [
{
"id": "calc:log.mainappwarnings",
"name": "Main app warnings"
},
{
"id": "calc:log.samplemetric",
"name": "Sample metric"
},
{
"id": "calc:log.hosterrors",
"name": "Host errors"
}
]
}
Response code
200