Skip to main content
GET
/
metrics
/
{metric_id}
Get metric details
curl --request GET \
  --url https://api.example.com/metrics/{metric_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "name": "<string>",
  "type": "<string>",
  "project_id": "<string>",
  "project_name": "<string>",
  "preset": true,
  "total_events": 123,
  "recent_events": [
    {
      "id": "<string>",
      "trace_id": "<string>",
      "value": {},
      "created_at": "<string>"
    }
  ],
  "description": "<string>",
  "collection_type": "<string>",
  "collection_config": {},
  "agent_name": "<string>",
  "sampling_rate": 123,
  "created_at": "<string>",
  "monitor": {
    "threshold": 123,
    "aggregation_method": "<string>",
    "comparison_operator": "<string>",
    "interval_value": 123,
    "interval_unit": "<string>",
    "latest_status": "<string>",
    "latest_value": 123
  }
}

Authorizations

Authorization
string
header
required

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

Path Parameters

metric_id
string<uuid>
required

Metric identifier.

Response

Successful Response

id
string
required
name
string
required
type
string
required
project_id
string
required
project_name
string
required
preset
boolean
required
total_events
integer
required
recent_events
MetricRecentEventRow · object[]
required
description
string | null
collection_type
string | null
collection_config
Collection Config · object
agent_name
string | null
sampling_rate
integer | null
created_at
string | null
monitor
MetricLinkedMonitorRow · object