Get a monitor

GET/v1/monitors/{id}

0credits

Headers

Get your API key

x-api-keystringheader

API key (`sfk_...`)

Parameters

idstringrequiredpath

Monitor identifier.

min 1 chars

Response fields

Endpoint-specific response payload.

dataid

string

Stable identifier for the monitor.

min 1 chars

dataname

string

Display name for the monitor.

dataoperationId

string

Watchable public API operation this monitor polls.

dataparams

object

Canonicalized parameters used for each poll.

datastatus

string

Current lifecycle status of the monitor.

one of: active, paused, exhausted, broken

datastatusReason

stringnullable

Human-readable reason for the current status when set.

dataschedule

Polling schedule for a monitor: a fixed interval or a cron expression.

datanextRunAt

string

ISO-8601 timestamp for the monitor's next scheduled poll.

datawebhookEndpointId

stringnullable

Webhook endpoint this monitor delivers events to, if any.

dataspendCapCredits

integernullable

Optional monthly credit spend cap for this monitor.

≥ 0

dataspendThisMonth

integer

Credits spent by this monitor in the current billing month.

≥ 0

datacreatedAt

string

ISO-8601 timestamp for when the monitor was created.

dataupdatedAt

string

ISO-8601 timestamp for when the monitor was last updated.

Metadata describing the request and billing outcome.

metarequestId

string

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged

integer

Credits charged for this request.

≥ 0

metaversion

string

Public API version that served the response.

one of: v1

metacached

booleanoptional

True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present.

Headers

Code example

Responses