Sign in

v1

latestOpenAPI 3.1.02026-07-2658119246.0 KB
SERP

SERP Batch

post/v2/serp/batch

Request body

Example request

{
  "inputs": [
    {
      "country": "US",
      "device": "desktop",
      "domain": "com",
      "locale": "en",
      "location": "New York, New York, United States",
      "num_results": 10,
      "page": 1,
      "parse": true,
      "query": "nimble web data",
      "search_engine": "google_search",
      "callback_url": "https://example.com/webhook/callback",
      "storage_compress": true,
      "storage_object_name": "result-2024-01-15.json",
      "storage_type": "s3",
      "storage_url": "s3://bucket-name/path/to/object"
    }
  ],
  "shared_inputs": {
    "country": "US",
    "device": "desktop",
    "domain": "com",
    "locale": "en",
    "location": "New York, New York, United States",
    "num_results": 10,
    "page": 1,
    "parse": true,
    "query": "nimble web data",
    "search_engine": "google_search",
    "callback_url": "https://example.com/webhook/callback",
    "storage_compress": true,
    "storage_object_name": "result-2024-01-15.json",
    "storage_type": "s3",
    "storage_url": "s3://bucket-name/path/to/object"
  }
}

Response

Batch created successfully

batch_idstring required

Unique identifier for the batch.

batch_sizenumber required

Number of tasks in the batch.

Example response

{
  "tasks": [
    {
      "batch_id": "4b0a90bf-c951-42e4-95b3-a95a65ba69fc",
      "created_at": "2024-01-15T10:30:00Z",
      "download_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000/results",
      "error": "Connection timeout",
      "error_type": "timeout_error",
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "modified_at": "2024-01-15T10:35:00Z",
      "state": "pending",
      "status_code": 200,
      "status_url": "https://api.webit.live/api/v2/tasks/123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}