Monitors

List monitors

List monitors for the authenticated account.

GET/v1/monitors
0credits
x-api-keystringheader

API key (`sfk_...`)

Parameters
1
statusstringquery

Optional filter to only return monitors in this status.

one of: active, paused, exhausted, broken

Response fields
20

Endpoint-specific response payload.

Monitors owned by this account, newest first.

datamonitors[]id
string

Stable identifier for the monitor.

min 1 chars

datamonitors[]name
string

Display name for the monitor.

datamonitors[]operationId
string

Watchable public API operation this monitor polls.

datamonitors[]params
object

Canonicalized parameters used for each poll.

datamonitors[]status
string

Current lifecycle status of the monitor.

one of: active, paused, exhausted, broken

datamonitors[]statusReason
stringnullable

Human-readable reason for the current status when set.

datamonitors[]schedule

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

datamonitors[]nextRunAt
string

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

datamonitors[]webhookEndpointId
stringnullable

Webhook endpoint this monitor delivers events to, if any.

datamonitors[]spendCapCredits
integernullable

Optional monthly credit spend cap for this monitor.

≥ 0

datamonitors[]spendThisMonth
integer

Credits spent by this monitor in the current billing month.

≥ 0

datamonitors[]createdAt
string

ISO-8601 timestamp for when the monitor was created.

datamonitors[]updatedAt
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.

Code example

curl "https://api.socialfetch.dev/v1/monitors" \
  -H "x-api-key: YOUR_API_KEY"

Responses

Monitors owned by this account.