Explore documentation
  1. Welcome to Telemetry 👋
  2. Quick start guide
  3. Wide events vs. metrics
  4. Ingesting data
    1. Better Stack collector
    2. OpenTelemetry
    3. Vector
    4. Ingesting via HTTP API
    5. Ingesting metrics
    6. Ingesting logs
    7. Migrating to Better Stack
  5. Using the product
    1. AI SRE ↗
    2. MCP server ↗
    3. Transforming ingested data
    4. Querying data
    5. Tracing
    6. Grafana
    7. Alerts
  6. Telemetry API
    1. Getting an API token
    2. Sources & collectors
      1. Sources API
      2. Collectors API
      3. Collector metrics targets API
      4. Metrics API
        1. List all metrics GET
        2. Create a metric POST
        3. Update a metric PATCH
        4. Remove a metric DELETE
      5. Source groups API
    3. Dashboards
    4. Explorations
    5. Alerts API
    6. Connections API
    7. Query API ↗
    8. Usage API ↗
  7. Alternative to
    1. Lightstep

List all metrics

Returns a list of metrics and labels for a specified source.

GET https://telemetry.betterstack.com/api/v2/sources/{source_id}/metrics

URL parameters

source_id
required integer

Source for which to retrieve metrics

Query parameters

page
integer

Page number

per_page
integer

Number of metrics per page. Default 50, maximum 250.

Headers

Authorization
required string

Bearer $TOKEN

200

Returns a paginated list of metrics and labels.

Response body

{
  "data": [
    {
      "id": "g-123",
      "type": "metric",
      "attributes": {
        "name": "level",
        "sql_expression": "JSONExtract(raw, 'level', 'Nullable(String)')",
        "aggregations": [],
        "type": "string_low_cardinality"
      }
    },
    {
      "id": "m-124",
      "type": "metric",
      "attributes": {
        "name": "tid",
        "sql_expression": "JSONExtract(raw, 'thread_id', 'Nullable(Int64)')",
        "aggregations": [
          "anyLast",
          "count"
        ],
        "type": "int64_delta"
      }
    }
  ],
  "pagination": {
    "first": "https://telemetry.betterstack.com/api/v2/sources/95/metrics?page=1",
    "last": "https://telemetry.betterstack.com/api/v2/sources/95/metrics?page=2",
    "prev": null,
    "next": "https://telemetry.betterstack.com/api/v2/sources/95/metrics?page=2"
  }
}

Response attributes

id
string

The ID of the metric, prefixed with m- for a metric with aggregations or g- for a label without them.

type
string

The resource type, always metric.

attributes.name
string

The name of the metric or label.

attributes.sql_expression
string

The SQL expression that extracts the value.

attributes.aggregations
array

The aggregations applied to the metric, any of avg, count, uniq, max, min, sum and histogram, or an empty array for a label; sources on the legacy schema can also return anyLast, p50, p90, p95 and p99.

attributes.type
string

The data type of the value, one of string, string_low_cardinality, int64_delta, int64, uint64_delta, uint64, float64_delta, datetime64_delta or boolean.

pagination.first
string

URL of the first page. Read more about pagination.

pagination.last
string

URL of the last page.

pagination.prev
string or null

URL of the previous page, or null on the first page.

pagination.next
string or null

URL of the next page, or null on the last page.

Example cURL

Example
curl --request GET \
  --url https://telemetry.betterstack.com/api/v2/sources/123/metrics \
  --header "Authorization: Bearer $TOKEN"


Previous article

Remove a collector metric target

Next article

Create a metric