monitors

Get a monitor

Returns one monitor. A monitor owned by another account returns 404, never 403, so the response cannot be used to probe for existence. The signing secret is never returned here.

get/monitors/{id}

Request

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

Path parameters

idstring required
Example:mon_9Qv2xKpLd3

Monitor identifier returned by POST /v1/monitors.

Response

The monitor

cadenceunknown
created_atstring date-time
credits_spentinteger

Credits this monitor has spent across every run so far.

estimated_cost_per_runinteger

The recipe's own credit cost plus 1 credit for orchestration. A run that fails outright is refunded in full.

estimated_monthly_costinteger

estimated_cost_per_run multiplied by the runs the cadence produces in a month.

idstring
namestring
next_run_atstring date-time
output_schemaobject nullable
paramsobject

The recipe parameters frozen at create time. They are replayed verbatim on every run.

recipestring

The endpoint path this monitor re-runs, without the /v1/.

runs_totalinteger
status'active' | 'paused'
suppress_webhook_unless_alertboolean
updated_atstring date-time
webhook_format'full' | 'rows'

The webhook body: full (the default) or rows (flat rows, numbers-only monitors).

Example response

{
  "recipe": "prism/comments"
}

Changes

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