monitors

Read a monitor's metric timeseries

Projects every stored run into a {t, metrics} series over the recipe's stable numeric keys, so a monitor doubles as a metric history without you storing anything. Reads snapshots only: it never calls an upstream and is free. On a numbers-only monitor (created with track) the response also carries series, one { row_id, metric, points: [{t, value}] } per row and metric, and points holds the numbers read off the page itself. Reads at most the newest 1,000 runs in the window.

get/monitors/{id}/timeseries

Request

  • Base URL: https://www.socialcrawl.dev/v1
  • URL: https://www.socialcrawl.dev/v1/monitors/{id}/timeseries
  • Auth: API key in header x-api-key

Path parameters

idstring required
Example:mon_9Qv2xKpLd3

Monitor identifier returned by POST /v1/monitors.

Query parameters

metricstring

Comma-separated metric keys to project. Defaults to every stable numeric key found across the runs.

fromstring date-time

ISO 8601 lower bound on the series.

tostring date-time

ISO 8601 upper bound on the series.

rowstring

Numbers-only monitors: comma-separated row ids to keep in series.

Response

The metric series

series_truncatedboolean

Numbers-only monitors only. True when the response hit its 100,000-point cap; narrow with row, metric, from and to.

metric_keysstring[]

Changes