monitors

List monitor runs

Returns the monitor's run history, newest first, each with the credits it used, its per-leg envelope, any alerts it fired, and the delivery record for its webhook. Reads stored runs; it never calls an upstream and is free. Pass include=result to get each run's stored result inline.

get/monitors/{id}/runs

Request

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

Path parameters

idstring required
Example:mon_9Qv2xKpLd3

Monitor identifier returned by POST /v1/monitors.

Query parameters

status'ok' | 'partial' | 'failed' | 'skipped'

Filter by run status.

fromstring date-time

ISO 8601 lower bound on scheduled_for.

tostring date-time

ISO 8601 upper bound on scheduled_for.

includestring
Example:numbers

result includes each run's stored result. numbers includes a numbers-only run's stored numbers and deltas. Comma-separate to get both (result,numbers).

cursorstring

Opaque cursor from a previous response's next_cursor.

limitinteger

Page size. Defaults to 20, capped at 100.

Response

A page of runs

next_cursorstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.