Return Data to Request Point

This endpoint allows users to fetch data efficiently and ensures seamless integration with their applications or workflows.

How It Works

The API enables users to send a scraping request and receive the results directly at the request point. This eliminates the need for data retrieval or the need to send to external storage and streamlines the data collection process, you can set your your desired format by using the “format” parameter, if no format was explicitly mentioned the default behavior will be JSON format.

Timeout Limit

This request is subject to a timeout limit. If the request exceeds the timeout limit, you will receive the following HTTP/202 response:

202

{
  "snapshot_id": "s_xxx",
  "message": "Your request is still in progress and cannot be retrieved in this call. Use the provided Snapshot ID to track progress via the Monitor Snapshot endpoint and download it once ready via the Download Snapshot endpoint."
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

dataset_id

string

required

Dataset ID for which data collection is triggered.

include_errors

boolean

Include errors report with the results.

format

enum<string>

default:json

Specifies the format of the response (default: JSON).

Available options:

json,

csv

Body

application/json · object[]

url

string

required

URL to scrape.

Response

200

text/plain

OK

The response is of type string.

Example:

"OK"