Sign in

v10

latestOpenAPI 3.1.02026-08-0375143791.1 KB
Batch

List batches

List your batches from newest to oldest. Filter by status or continue with a cursor.

get/batch/list

Query parameters

limitinteger

Batches per page. Defaults to 25.

Batches per page. Defaults to 25.

cursorstring

Cursor from the previous page.

Cursor from the previous page.

status'queued' | 'running' | 'cancelling' | 'completed' | 'cancelled' | 'failed'

Filter by status.

Filter by status.

qstring

Free-text search term, matched against the batch id, crawl source (start URL or sitemap domain), and tags.

Example:batch_1a2b

Free-text search term, matched against the batch id, crawl source (start URL or sitemap domain), and tags.

search_type'exact' | 'prefix'

prefix for as-you-type prefix matching (default), exact for full-token matching.

prefix for as-you-type prefix matching (default), exact for full-token matching.

tagsstring

Comma-separated list of tags to filter by (matches batches having any of them).

Example:docs,competitor

Comma-separated list of tags to filter by (matches batches having any of them).

Response

Your batches, newest first. Use next_cursor to page through the rest.

has_moreboolean

Whether another page is available.

next_cursorstring nullable

Cursor for the next page.

Example response

{
  "data": [
    {
      "id": "batch_9f2c8a",
      "tags": [
        "docs"
      ],
      "crawl": {
        "source": {
          "url": "https://example.com/docs"
        },
        "max_pages": 500,
        "url_pattern": "^https://example\\.com/docs/"
      },
      "input": {
        "reserved": 24817,
        "submitted": 25000,
        "duplicates": 183
      },
      "progress": {
        "succeeded": 18091,
        "failed": 311,
        "pending": 6415
      },
      "credits": {
        "reserved": 24817,
        "refunded": 6726,
        "net": 18091
      },
      "page_errors": [
        {
          "code": "WEBSITE_ACCESS_ERROR",
          "count": 204
        }
      ],
      "failure": {
        "code": "stalled",
        "message": "Batch stopped reporting progress and was finalized automatically"
      }
    }
  ]
}