Create a metric

Create a metric

Returns a newly created metric.

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

URL parameters

source_id

required integer

Source for which to create a metric

Headers

Authorization

required string

Bearer $TOKEN

Body parameters

team_name

string

Required if using global API token to specify the team which should own the resource

name

required string

Metric name

sql_expression

required string

SQL expression to use for the metric

aggregations

array

Aggregations to apply to the metric.
Valid aggregations are avg, count, uniq, max, min, anyLast, sum, p50, p90, p95, p99

type

required string

Metric type.
Valid types are string_low_cardinality, int64_delta, float64_delta, datetime64_delta, and boolean

201

Response body

{
  "data": {
    "id": "g-123",
    "type": "metric",
    "attributes": {
      "name": "level",
      "sql_expression": "JSONExtract(json, 'level', 'Nullable(String)')",
      "aggregations": [

      ],
      "type": "string_low_cardinality"
    }
  }
}

Example cURL

Non-agreggated metric Agreggated metric

Copied!

curl --request POST \
  --url https://telemetry.betterstack.com/api/v2/sources/123/metrics \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "log_type",
    "sql_expression": "getJSON(raw, '\''message_json.log_type'\'')",
    "type": "string_low_cardinality"
  }'

curl --request POST \
  --url https://telemetry.betterstack.com/api/v2/sources/123/metrics \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
    "name": "duration_ms",
    "sql_expression": "getJSON(raw, '\''message_json.duration_ms'\'')",
    "aggregations": ["avg", "p95", "min", "max"],
    "type": "float64_delta"
  }'

Explore documentation

Example cURL