batches

Create a batch

Changed on

Starts a new batch of items to process.

post/v1/batches

Request

  • Base URL: https://api.olostep.com
  • URL: https://api.olostep.com/v1/batches
  • Auth: HTTP bearer

Request body

countrystring

ISO 3166-1 alpha-2 country to scrape from.

metadataobject

Set of up to 50 key-value string pairs you can attach to the object. Echoed back unchanged.

Response

Default Response

idstring required
object'batch' required
statusstring required
creatednumber required
completed_atnumber nullable
total_urlsinteger required
completed_urlsinteger required
number_retriedinteger
parserstring nullable
countrystring nullable
start_datestring
metadataobject
webhookstring nullable
completion_windowstring
credits_consumednumber nullable
cost_usdnumber nullable
warningstring

Changes

  • 13c766ab100cRevision changes
    • breaking

      the request property type changed from string to no type, and format from uri to no format

    • info

      added subschema #1 subschema #2 to the request property anyOf list

  • 24c12c29fa19Revision changes
    • breaking

      the /// request property's minLength was increased from 0 to 1

    • info

      the request property // became optional