Skip to main content
GET
Get a run

Authorizations

x-api-key
string
header
required

Bulkgrid API key

Path Parameters

runId
string
required

Query Parameters

includeResults
boolean

Response

Successful response

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
completed_at
string | null
required
config
required
Available options:
null
created_at
string
required
credential_id
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
done
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
error_code
string | null
required
error_count
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
error_details
required
Available options:
null
extraction_query
string | null
required
extraction_schema
required
Available options:
null
failed
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
in_progress
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
inline_credentials
required
Available options:
null
indexing_completed_at
string | null
required
indexing_started_at
string | null
required
indexing_time_ms
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
last_error
string | null
required
last_error_at
string | null
required
last_heartbeat
string | null
required
max_retries
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
message_ids
string[]
required
metadata
required
Available options:
null
needs_dispatch
boolean
required
priority
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
processing_time_ms
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
query
string | null
required
queued
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
requested_by_user_id
string<uuid> | null
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
retry_count
integer | null
required
Required range: -9007199254740991 <= x <= 9007199254740991
started_at
string | null
required
status
enum<string>
required
Available options:
pending,
processing,
completed,
failed,
cancelled
workspace_id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
type
enum<string>
required
Available options:
crawl,
deep_crawl,
extract,
source_sync
updated_at
string
required
urls
string<uri>[]
required
statistics
object
required
source
object | null
required
indexed_pages
integer
Required range: -9007199254740991 <= x <= 9007199254740991
indexing_done
integer
Required range: -9007199254740991 <= x <= 9007199254740991
indexing_failed
integer
Required range: -9007199254740991 <= x <= 9007199254740991
indexing_failed_pages
integer
Required range: -9007199254740991 <= x <= 9007199254740991
indexing_in_progress
integer
Required range: -9007199254740991 <= x <= 9007199254740991
indexing_queued
integer
Required range: -9007199254740991 <= x <= 9007199254740991
deletion_requested_at
string | null
crawl_results
object[]