Skip to main content
Read metric data with the Public API (V2). Fetch a timeseries for graphs, an aggregated list for tables, or discover which metrics and tags a site has. All endpoints authenticate with your personal API token and are scoped to a single site_id.

Query a timeseries

This endpoint returns one or more series of data points over a time range. Use it to draw graphs.

Request body

Each select entry takes a metric name, a tags object to filter on (values may use * as a wildcard), a field (see fields), an optional aggregation (see aggregations), and draw_null_as_zero (when true, missing points are filled with 0).

Response

Returns a Timeseries with the queried resolution, from, to, and a series array. Each series has an id, the metric name, its tags, the field it represents, min and max across the range, and a data array of points. Each point has a timestamp and a numeric value.

Query a list

This endpoint returns aggregated metric values grouped into rows. Use it to build tables.

Request body

A ListSelector is like a timeseries selector, with an extra id that names the selector’s value in each row’s data object. group_by entries are Name (group by metric name) or Tag (group by a tag value).

Response

Returns a List with the queried resolution, from, to, and a rows array. Each row has an id, a group object of the tag values that define it, and a data object of aggregated values keyed by selector id (for example, { "mean": 42.5 }).

List metric names

Return every metric name available for a site.
Returns an array of strings.

Get a metric’s type and tags

Return a metric’s type and the tag combinations it can be queried with.
Returns a metric_type (gauge, counter, or measurement) and available_tags, an array where each entry is one valid combination of tag keys.

Reference

Fields

The field selects which measurement to retrieve from a metric: For more type references, read the AppSignal V2 API Documentation.

Aggregations

The aggregation combines multiple values within a time bucket: sum, avg, min, max, first, or last.

Resolutions

resolution accepts MINUTELY, FIVE_MINUTELY, TEN_MINUTELY, FIFTEEN_MINUTELY, HOURLY, or DAILY.