Web Monitors API

Web monitors.

POST/v1/web/monitors

0 credits per successful callCache window 15 minutesFull API reference ↗

Coverage is rolling out during preview. Test the endpoint you need before integrating. Unavailable operations return an explicit error and use no credits.

Try this endpoint

Enter the documented inputs, run a protected browser test, and inspect the JSON response.

POST/v1/web/monitors

urlrequiredurl JSON body field for this endpoint.

Optional parameters (11)

nameoptionalname JSON body field for this endpoint.modeoptionalmode JSON body field for this endpoint.cadence_minutesoptionalcadence_minutes JSON body field for this endpoint.schedule_textoptionalschedule_text JSON body field for this endpoint.schedule_cronoptionalschedule_cron JSON body field for this endpoint.timezoneoptionaltimezone JSON body field for this endpoint.webhook_urloptionalwebhook_url JSON body field for this endpoint.queryoptionalquery JSON body field for this endpoint.goaloptionalgoal JSON body field for this endpoint.retention_daysoptionalretention_days JSON body field for this endpoint.judge_enabledoptionaljudge_enabled JSON body field for this endpoint.

No API key needed for this protected browser test. Production calls require a server-side SocialQuery key.

Request preview

Copy this request into your server-side integration, or run a test to inspect the response.

curl -X POST 'https://socialquery.dev/v1/web/monitors' \
  -H "x-api-key: $SOCIALQUERY_API_KEY" \
  -H "content-type: application/json" \
  -d '{"url":"https://example.com/post"}'

Request contract

Parameters

Pass these fields in the JSON request body. Production requests also require your server-side API key.

urlRequired: url JSON body field for this endpoint.
Example: https://example.com/post
nameOptional: name JSON body field for this endpoint.
Example: —
modeOptional: mode JSON body field for this endpoint.
Example: scrape
cadence_minutesOptional: cadence_minutes JSON body field for this endpoint.
Example: 10
schedule_textOptional: schedule_text JSON body field for this endpoint.
Example: —
schedule_cronOptional: schedule_cron JSON body field for this endpoint.
Example: —
timezoneOptional: timezone JSON body field for this endpoint.
Example: —
webhook_urlOptional: webhook_url JSON body field for this endpoint.
Example: https://example.com/post
queryOptional: query JSON body field for this endpoint.
Example: ai agents
goalOptional: goal JSON body field for this endpoint.
Example: —
retention_daysOptional: retention_days JSON body field for this endpoint.
Example: 10
judge_enabledOptional: judge_enabled JSON body field for this endpoint.
Example: false

Build a reliable integration.

Keep your key server-side

Pass your SocialQuery key in the x-api-key header. Never expose credentials in a browser bundle.

Check the response

Read success before using data. Preserve request_id when logging errors or contacting support.

Account for coverage

Test the fields you need. Provider availability varies, and unavailable operations use no credits.

More Web endpoints

View all →