Manage SocialCrawl Monitors
socialcrawl_monitorsCreate and manage stateful monitors that re-run any SocialCrawl recipe (a registry endpoint or a Prism composite) on a cadence (hourly/daily/weekly/cron), deliver each result to a signed webhook, raise alerts on metric thresholds/changes, and accumulate a per-run time-series. 'Prism answers once; monitors watch it for you.' Actions: create, list, get, runs, timeseries, pause, resume, delete. Managing monitors costs 0 credits; each scheduled run bills the underlying recipe's normal cost plus a 1-credit scheduling premium. Requires a valid SOCIALCRAWL_API_KEY.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Monitor id. Required for get/runs/timeseries/pause/resume/delete. | |
| to | No | runs/timeseries: ISO end of the time window. | |
| from | No | runs/timeseries: ISO start of the time window. | |
| name | No | create: optional human-readable label. | |
| limit | No | list/runs: page size (1-100, default 20). | |
| action | Yes | Monitor operation: 'create' a scheduled monitor, 'list' your monitors, 'get' one, 'runs' for its run history, 'timeseries' for its metric series, 'pause'/'resume' it, or 'delete' it. | |
| cursor | No | list/runs: pagination cursor. | |
| metric | No | timeseries: comma-separated metric keys to project (defaults to all stable computed keys). | |
| params | No | create: parameters passed to the recipe on every run (e.g., { keyword: 'acme' }). | |
| recipe | No | create: the recipe to run each cadence — any registered endpoint or Prism composite as 'platform/resource' (e.g., 'prism/brand-mentions', 'tiktok/profile'). | |
| status | No | Filter. For list: 'active' | 'paused' | 'all'. For runs: 'ok' | 'partial' | 'failed' | 'skipped'. | |
| cadence | No | create: 'hourly', 'daily', 'weekly', or a cron expression (e.g., '0 9 * * 1'). | |
| include | No | runs: set to 'result' to include each run's full stored result envelope. | |
| alert_rules | No | create: optional alert rules on the recipe's computed metrics — e.g., [{ metric: 'negative_share', op: 'pct_change_gt', value: 25 }]. | |
| webhook_url | No | create: HTTPS URL that receives each run's signed (HMAC-SHA256) result. | |
| output_schema | No | create: optional JSON schema to shape the delivered payload. | |
| webhook_secret | No | create: optional signing secret (8-200 chars); otherwise one is generated and returned once. | |
| suppress_webhook_unless_alert | No | create: only fire the webhook when an alert rule trips (default false). |