Get Traversal Run Data

Reads a batch of scraped data produced by a Traversal run. Continue with the returned cursor until no cursor remains

Endpoint

GET /api/v3/jobs/{jobName}/traversal/runs/{runNum}/data

Path Parameters

Name Type Description
jobName string Required. Unique job name within the tenant. Reuse the same value to manage job config, start crawls, fetch URLs, inspect tasks and Traversal runs, and query indexed data
runNum unsigned long Required. Traversal run number used to read run status, errors, and data for the same job

Query Parameters

Name Type Description
path string Optional. Optional. Path to a TraversalConfig level in the Traversal tree. Use ‘/’ for the root level. Nested paths must start and end with ‘/’, for example ‘/products/’. Omit to read full leaf-level data for the run. Set a level path to stop at that Traversal level and limit the shape or size of returned JSON objects. See TraversalConfig for level names
cursor string Optional. Optional. Opaque DataCursor returned by the previous response. Omit or pass null to read the first batch
limit int Optional. Default: 10. Optional. Number of Traversal tasks at the selected path to read for this batch. Default: 10. One task can produce multiple JSON documents, so Data length can be greater than this limit

Responses

200 (Ok)

Returns TraversalData as TraversalData. Continue with DataCursor until the returned cursor is null.

400 (Bad Request)

Invalid request parameters. Refer to the response text for more information

403 (Forbidden)

Access restricted. Refer to the response text for more information

Data Contracts

TraversalData

Paged scraped data returned for a Traversal run

Fields:

Name Type Description
Data array of string Scraped data records serialized as JSON strings
DataCursor string or null Optional. Opaque cursor for fetching the next batch of data; null means there is no next page

Please rotate your device to landscape mode

This documentation is specifically designed with a wider layout to provide a better reading experience for code examples, tables, and diagrams.
Rotating your device horizontally ensures you can see everything clearly without excessive scrolling or resizing.

Return to Web Data Source Home