Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Crawl API

Get a crawl session

get/workspaces/{workspace_domain}/projects/{project_name}/crawl/suites/{suite_id}/sessions/{session_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

session_idstring required
Example:MNbyVedg

The ID of the crawl session

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 session

status'IN_PROGRESS' | 'ERROR' | 'TERMINATED' | 'FINISHED'

Status of the crawl session

session_numberinteger

Sequential number of the session

pipeline_idinteger

ID of the pipeline that triggered the session

pipeline_namestring

Name of the pipeline that triggered the session

execution_idstring

ID of the execution that triggered the session

action_idinteger

ID of the action that triggered the session

creator_idinteger

ID of the user who created the session

ci_provider'NONE' | 'BUDDY' | 'GITHUB_ACTION' | 'CIRCLE_CI'

CI provider that triggered the session

suite_idstring

ID of the suite the session belongs to

create_dateinteger

Creation date of the session (Unix timestamp)

status_change_dateinteger

Date of the last status change (Unix timestamp)

cli_versionstring

CLI version used for the session

run_idstring

Run ID of the session

run_urlstring

Run URL of the session

commentstring

Comment for the session

urls_countinteger

Number of URLs crawled in the session

namestring

Name of the session

project_namestring

Name of the project the session belongs to