Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Crawl API

Get a crawl suite

get/workspaces/{workspace_domain}/projects/{project_name}/crawl/suites/{suite_id}

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

project_namestring required
Example:my-project

The human-readable ID of the project

suite_idstring required
Example:MNbyVedg

The ID of the crawl suite

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

idstring

Unique identifier of the crawl suite

identifierstring

Unique identifier for the suite (auto-generated if not provided)

namestring

Name of the crawl suite

full_pageboolean

Whether to capture the full page

color_scheme'LIGHT' | 'DARK' | 'LIGHT_AND_DARK'

Color scheme for the crawl

device_type'EMULATED' | 'REAL'

Device type for the crawl

desktop_browsersstring[]

List of desktop browsers to crawl on

desktop_system'WINDOWS' | 'MACOS' | 'UBUNTU'

Desktop system for the crawl

ignored_urlsstring[]

URLs to ignore during crawling

project_namestring

Name of the project the suite belongs to

concurrents_limitinteger

Maximum number of concurrent crawls

create_dateinteger

Creation date of the suite (Unix timestamp)

last_update_dateinteger

Last update date of the suite (Unix timestamp)

session_countinteger

Number of sessions in the suite

crawl_urlstring

URL to crawl

followboolean

Whether to follow links during crawling

respect_robotsboolean

Whether to respect robots.txt rules

tokenstring

Authentication token for the suite