Skip to main content
GET
/
agents
/
{agentId}
/
custom-metrics
/
{metricId}
Get a specific custom metric
curl --request GET \
  --url https://eu-gcp-api.vg-stuff.com/v3/agents/{agentId}/custom-metrics/{metricId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "metric": {
    "id": "<string>",
    "key": "<string>",
    "description": "<string>",
    "type": "number",
    "isSystem": true,
    "options": [
      "<string>"
    ],
    "createdAtUNIX": 123,
    "updatedAtUNIX": 123
  }
}

​
Overview

Fetches detailed information about a single custom metric, including its configuration and metadata.

​
Use Cases

  • Metric Detail View: Display full configuration of a specific metric
  • Validation: Verify metric settings before updating
  • Reference: Get metric details for integration purposes

​
Example Response

{
  "success": true,
  "metric": {
    "id": "metric_abc123",
    "key": "customer_satisfaction",
    "description": "Customer satisfaction rating on a scale of 1-10",
    "type": "number",
    "isSystem": false,
    "createdAtUNIX": 1640000000,
    "updatedAtUNIX": 1640100000
  }
}
Make sure the metric ID exists. A 404 error will be returned if the metric is not found.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
agentId
string
required

The unique identifier of the agent

​
metricId
string
required

The unique identifier of the metric

Response

Successful response

​
success
boolean
required
​
metric
object
required