crawl_site
Initiate a background website crawl that saves data to the internal database and provides a crawl ID to monitor progress.
Instructions
Start a background Screaming Frog crawl that saves to SF's internal database.
Args: url: The URL to crawl (e.g. https://example.com) config_file: Optional path to a .seospiderconfig file for crawl settings. To limit the number of URLs crawled, set the limit in a config file (Configuration > Spider > Limits in the SF GUI) and pass it here. label: Optional label for identifying this crawl (e.g. 'freshgovjobs')
Returns: A crawl_id to use with crawl_status to check progress. The crawl runs in the background - use crawl_status to poll.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | Yes | ||
| config_file | No | ||
| label | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |