Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrapegraphai.com/llms.txt

Use this file to discover all available pages before exploring further.

All endpoints take the monitor cronId returned by POST /api/monitor.

​
List monitors

GET https://v2-api.scrapegraphai.com/api/monitor

curl -X GET https://v2-api.scrapegraphai.com/api/monitor \
  -H "SGAI-APIKEY: $SGAI_API_KEY"
Returns an array of monitor summaries (cronId, status, config, timestamps).

​
Get one monitor

GET https://v2-api.scrapegraphai.com/api/monitor/:cronId

curl -X GET https://v2-api.scrapegraphai.com/api/monitor/d9a09a07-... \
  -H "SGAI-APIKEY: $SGAI_API_KEY"
Returns the full monitor record, including the resolved config.

​
Update

PATCH https://v2-api.scrapegraphai.com/api/monitor/:cronId
Body accepts any subset of the create parameters — commonly interval, formats, webhookUrl, or fetchConfig. 
curl -X PATCH https://v2-api.scrapegraphai.com/api/monitor/d9a09a07-... \
  -H "SGAI-APIKEY: $SGAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "interval": "0 */6 * * *" }'

​
Pause / resume

POST https://v2-api.scrapegraphai.com/api/monitor/:cronId/pause
POST https://v2-api.scrapegraphai.com/api/monitor/:cronId/resume
Pausing halts future ticks but preserves the monitor record. Resuming puts it back on schedule immediately. 
curl -X POST https://v2-api.scrapegraphai.com/api/monitor/d9a09a07-.../pause \
  -H "SGAI-APIKEY: $SGAI_API_KEY"

curl -X POST https://v2-api.scrapegraphai.com/api/monitor/d9a09a07-.../resume \
  -H "SGAI-APIKEY: $SGAI_API_KEY"

​
Delete

DELETE https://v2-api.scrapegraphai.com/api/monitor/:cronId
Permanently removes the monitor and its tick history. 
curl -X DELETE https://v2-api.scrapegraphai.com/api/monitor/d9a09a07-... \
  -H "SGAI-APIKEY: $SGAI_API_KEY"

​
Activity (tick history)

GET https://v2-api.scrapegraphai.com/api/monitor/:cronId/activity
Returns recent ticks with captured data and change flags. 
curl -X GET https://v2-api.scrapegraphai.com/api/monitor/d9a09a07-.../activity \
  -H "SGAI-APIKEY: $SGAI_API_KEY"
Response (shape): 
{
  "ticks": [
    {
      "id": "fb7ada6e-97d2-4e66-9fee-ebf598a5d16a",
      "status": "completed",
      "createdAt": "2026-04-23T11:11:37.619Z",
      "elapsedMs": 14,
      "changed": true,
      "diffs": {}
    }
  ],
  "nextCursor": null
}
FieldDescription
ticks[].idUUID of the tick — use it to fetch the captured payload via the underlying Scrape reference.
ticks[].status"completed", "failed", or "running".
ticks[].elapsedMsHow long the fetch took, in milliseconds.
ticks[].changedWhether the capture differs from the previous tick.
ticks[].diffsPer-format diffs vs. the previous tick (empty on the first tick).
nextCursorPagination cursor — pass it back on a follow-up request to get older ticks. null when there are no more.