List scrapes

GET/v1/discover/scrapes

Authorization

bearerAuth

AuthorizationBearer <token>

API token issued from the dashboard (Settings → API Tokens). Sent as Authorization: Bearer <token>.

In: header

Query Parameters

status?string

Value in"pending" | "running" | "completed" | "failed" | "cancelled"

platform?string

Social platform identifier. X (Twitter) is x. github tracks a repo (owner/repo) or owner (owner) — watched free (daily stars + releases), no paid scrape.

creatorId?string

Match

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Formatuuid

limit?integer

Default50

Range1 <= value <= 200

offset?integer

Default0

Range0 <= value <= 9007199254740991

Response Body

`application/json`

cURL

curl -X GET "https://example.com/discover/scrapes"

{
  "success": true,
  "scrapes": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "platform": "youtube",
      "creatorId": "688ebf54-d343-4104-8711-82c2feac534a",
      "status": "pending",
      "itemCount": -9007199254740991,
      "creditsCharged": 0,
      "error": "string",
      "maxItems": -9007199254740991,
      "createdAt": "2019-08-24T14:15:22Z",
      "startedAt": "2019-08-24T14:15:22Z",
      "completedAt": "2019-08-24T14:15:22Z"
    }
  ],
  "pagination": {
    "limit": -9007199254740991,
    "offset": -9007199254740991,
    "hasMore": true
  }
}

{
  "error": "unauthorized"
}

Authorization

Query Parameters

Response Body

200application/json

401application/json

`application/json`

`application/json`