Fetch

Get Batched Status

Get persisted Batched Fetch status and paginated results with each URL's lifecycle state. CANCELLING means accepted cancellation is still draining.

get/v1/fetch/batched/{id}

Path parameters

idstring required

a non empty string

Query parameters

limitstring

Maximum number of results per page (default 10, max 100)

offsetstring

Offset from start (default 0)

includestring

JSON-encoded Include Options selecting captured content. When omitted, the original POST include is used. A provided include must be a subset of content captured by the POST.

Response

BatchedStatus

idstring required

Batched run ID

Page-level status: whether this page is stable and requested result content extracted successfully. CANCELLING means accepted cancellation is still draining; FAILED can indicate an unreadable persisted result.

Overall Batched Fetch status. This is the exact persisted status, including CANCELLING while active items drain.

totalUrlsnumber required

Total number of URLs in the Batched Fetch

Example response

{
  "results": [
    {
      "data": {
        "response": {
          "url": "https://stripe.com/docs/api",
          "originStatusCode": 200,
          "redirectStatusCode": 301,
          "headers": {
            "content-type": "text/html; charset=utf-8"
          }
        },
        "meta": {
          "title": "Stripe API Reference",
          "description": "Complete reference for the Stripe API.",
          "canonicalUrl": "https://stripe.com/docs/api",
          "language": "en",
          "charset": "utf-8",
          "favicon": "/favicon.ico",
          "icons": [
            {
              "href": "/favicon.ico",
              "rel": "icon",
              "type": "image/png",
              "sizes": "32x32"
            }
          ],
          "openGraph": {
            "title": "Stripe | Payment Processing Platform",
            "description": "Online payment processing for internet businesses.",
            "type": "website",
            "url": "https://stripe.com",
            "siteName": "Stripe",
            "locale": "en_US",
            "images": [
              {
                "url": "https://example.com/og-image.png",
                "width": 1200,
                "height": 630,
                "alt": "Product screenshot showing dashboard"
              }
            ]
          },
          "twitter": {
            "card": "summary",
            "site": "@stripe",
            "creator": "@johndoe",
            "title": "Stripe API Reference",
            "description": "Complete reference documentation for the Stripe API.",
            "image": "https://stripe.com/twitter-card.png"
          }
        },
        "html": "<html><body><h1>Welcome to our API</h1></body></html>",
        "markdown": "# API Documentation\n\nWelcome to our API. This guide will help you get started...",
        "screenshot": {
          "url": "https://s3.amazonaws.com/bucket/snapshots/abcd/screenshot.jpeg?X-Amz-Signature=...",
          "fullPage": true
        },
        "links": [
          {
            "url": "https://example.com/page",
            "text": "Click here"
          }
        ],
        "renderEngines": {
          "capture": "rust",
          "markdown": "rust",
          "tree": "rust"
        },
        "assets": [
          {
            "id": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
            "placeholder": "expand-asset:data-url:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
            "archiveKey": "data-url:sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
            "mimeType": "image/svg+xml",
            "sha256": "sha256:9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
            "bytes": 312
          }
        ]
      },
      "error": {
        "blockedType": "botProtection"
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.