Skip to main content
GET
/
console
/
v1
/
metrics
Read Single Metric Value
curl --request GET \
  --url https://statsigapi.net/console/v1/metrics \
  --header 'STATSIG-API-KEY: <api-key>'
{
  "message": "Metric read successfully.",
  "data": [
    {
      "value": 0,
      "unit_type": "overall",
      "numerator": null,
      "denominator": null,
      "metric_name": "TestMetricCapi",
      "metric_type": "sum"
    },
    {
      "value": 0,
      "unit_type": "userID",
      "numerator": null,
      "denominator": null,
      "metric_name": "TestMetricCapi",
      "metric_type": "sum"
    }
  ]
}

Authorizations

​
STATSIG-API-KEY
string
header
required

Headers

​
x-respect-review-settings
string

Optional header to respect review settings for mutation endpoints.

Query Parameters

​
id
string
required

The unique identifier of the metric with format <metric_id>::<type>

​
date
string
required

Expected valid date in the form of YYYY-MM-DD

Example:

"2024-01-01"

Response

Get metric data on given date response

​
message
string
required

A simple string explaining the result of the operation.

​
data
object[]
required

Array of results returned by pagination limit.

​
pagination
object
required

Pagination metadata for checking if there is next page for example.

⌘I