WdsListTraversalRuns
Lists recent Traversal run summaries for the named job, newest first, so clients can find run numbers and completion state
Arguments
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| jobName | string | Yes | None | 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 |
| limit | int? | Yes | None | Optional. Number of newest runs to return, ordered by run number descending. Default: 10 |
The current MCP input schema requires the limit property. Pass null to use the server default of 10.
Return Type
Returns TraversalInfo[].
Technical return shape: array of TraversalInfo.
Structured Output
The MCP structured result is an object whose result property contains the TraversalInfo[] value.
Data Contracts
TraversalInfo
Status, counters, and config snapshot for one Traversal run
Fields:
| Name | Type | Description |
|---|---|---|
| RunNum | long | Traversal run number |
| StartDateUtc | datetime | Date and time when the run started, in UTC |
| CompleteDateUtc | datetime or null | Optional. Date and time when the run completed, in UTC; null means the run is still in progress |
| InProcessCrawlTasksCount | long | Number of download tasks currently in progress |
| SuccessfulDownloadTaskCount | long | Number of download tasks that completed successfully |
| FailedDownloadTaskCount | long | Number of failed download tasks |
| Config | TraversalConfig | TraversalConfig snapshot used for this run |
TraversalConfig
Multi-level crawl and scrape plan that defines level names, link selectors, field extraction rules, and nested branches
Fields:
| Name | Type | Description |
|---|---|---|
| Name | string | Name of this Traversal level. Use ‘/’ for the root; use names ending in ‘/’, such as ‘products/’, for branch levels so their data paths are addressable |
| CrawlParams | array of CrawlParams or null | Optional. Link extraction rules used to discover more pages at this level. Omitted, null, or empty performs no same-level link discovery |
| ScrapeParams | array of ScrapeParams or null | Optional. Field extraction rules used to collect data at this level. Omitted, null, or empty extracts no fields; names must be unique within the level |
| Branches | array of TraversalBranch or null | Optional. Nested Traversal branches reachable from this level. Omitted, null, or empty defines no child levels |
CrawlParams
Defines how links are extracted from a page and which discovered URLs remain in scope
Fields:
| Name | Type | Description |
|---|---|---|
| Selector | string | Selector used to find link-bearing elements. Use ‘CSS: |
| AttributeName | string or null | Optional. Attribute read from each matched element to obtain a link. Use ‘val’ for inner text. Omitted, null, or empty uses href |
| MaxDepth | int or null | Optional. Maximum URL path depth for discovered links. For example, example.com and example.com/index.html have depth 0, while example.com/path/ has depth 1. Omitted or null applies no depth limit |
ScrapeParams
Defines one named field extracted from pages by selector, attribute, and optional conversion
Fields:
| Name | Type | Description |
|---|---|---|
| Name | string | Name of the output field populated from this extraction rule. Names must be unique within one scrape request or Traversal level |
| Selector | string | Selector used to read matching elements. Use ‘CSS: |
| AttributeName | string or null | Optional. Attribute read from each matched element. Use ‘val’, or omit/pass null or empty, to return inner text |
| Convert | string or null | Optional. Conversion applied to scraped values. Use ‘md()’ for Markdown or ‘sr()’ for main readable content using Mozilla Readability. Omitted or null applies no conversion |
TraversalBranch
Describes a child Traversal branch and the link extraction rule used to reach it from the current level
TraversalBranch inherits the fields of TraversalConfig and adds this field:
| Name | Type | Description |
|---|---|---|
| EntryRule | CrawlParams | Link extraction rule that discovers pages belonging to this child branch |
Behavior
Read-only: yes; idempotent: yes; destructive: no; open-world: no.