Download OpenAPI specification:Download
organizationSlug required | string |
websitePublicId required | string |
Authorization required | string Example: Bearer [YOUR-ACCESS-TOKEN] Your access token |
{- "data": {
- "crawl": {
- "public_id": "e53c3b53-d114-4825-a129-7e6ac0652aae",
- "updated_at": "2020-12-11T18:31:44.000000Z",
- "created_at": "2020-12-11T18:31:27.000000Z",
- "options": {
- "max_pages": 30,
- "max_depth": 4,
- "start_url": "",
- "rate_limit": "high",
- "use_manual_rate_limit": false,
- "manual_rate_limit": 60,
- "subdomains": false,
- "filters": [ ],
- "use_sitemap": true,
- "use_robots": false,
- "archive_pages_not_found": true
}, - "type": "sitemap",
- "initial_page_count": 2,
- "website": {
- "public_id": "e845a39f-54f5-4f46-a332-920e9743cf15",
- "name": "Sample Site",
- "hostname": "sample-one.test",
- "protocol": "http",
- "notes": null,
- "created_at": "2020-05-29T22:01:32.000000Z",
- "updated_at": "2020-12-10T20:31:03.000000Z"
}
}
}
}
List crawls
organizationSlug required | string |
limit | integer [ 5 .. 250 ] Default: 5 |
page | integer >= 1 Default: 1 |
status | string Default: "active" Enum: "all" "active" "finished" |
Authorization required | string Example: Bearer [YOUR-ACCESS-TOKEN] Your access token |
{- "data": [
- {
- "started_at": "string",
- "updated_at": "string",
- "pages_found": 0,
- "pages_added": 0,
- "pages_archived": 0,
- "status": "string",
- "type": "string",
- "website": "string",
- "website_public_id": "string",
- "public_id": "string",
- "max_pages": "string",
- "max_depth": "string",
- "error_message": null,
- "started_by": "string",
- "started_by_email": "string",
- "include_subdomains": true,
- "rate_limit": null,
- "filters": [
- { }
], - "start_url": "string",
- "sitemap_location": "string",
- "use_robots": true,
- "use_sitemap": true,
- "archive_pages_not_found": true
}
], - "meta": {
- "pagination": {
- "total": 0,
- "count": 0,
- "per_page": 0,
- "current_page": 0,
- "total_pages": 0,
- "links": { }
}
}
}
organizationSlug required | string |
publicId required | string |
Authorization required | string Example: Bearer [YOUR-ACCESS-TOKEN] Your access token |
{- "started_at": "string",
- "updated_at": "string",
- "pages_found": 0,
- "pages_added": 0,
- "pages_archived": 0,
- "status": "Queued",
- "type": "string",
- "public_id": "string",
- "max_pages": "string",
- "max_depth": "string",
- "error_message": null,
- "include_subdomains": true,
- "rate_limit": null,
- "filters": [
- { }
], - "start_url": "string",
- "sitemap_location": "string",
- "use_robots": true,
- "use_sitemap": true,
- "archive_pages_not_found": true
}
organizationSlug required | string |
group_filter | string |
sort_by | string |
sort_direction | string |
start | string |
end | string |
page | string |
limit | string |
Authorization required | string Example: Bearer [YOUR-ACCESS-TOKEN] Your access token |
{- "meta": {
- "pagination": {
- "total": 0,
- "count": 0,
- "per_page": 0,
- "current_page": 0,
- "total_pages": 0,
- "links": {
- "next": "string",
- "previous": "string"
}
}
}, - "data": [
- {
- "scan_date": "string",
- "created_at": "string",
- "finished_at": "string",
- "subtype": "string",
- "entities": "string",
- "type": "string",
- "status": "string",
- "public_id": "string",
- "format": "string",
- "region_type": "string",
- "has_download": "string",
- "report_type": "string",
- "emailed_to": "string"
}
]
}
organizationSlug required | string |
Authorization required | string Example: Bearer [YOUR-ACCESS-TOKEN] Your access token |
region | string Default: "none" Enum: "none" "all" "template" "content" |
website | string The public ID of the website to run the report on. Either website or group is required. |
group | string The public ID of the group to run the report on. Either website or group is required. |