Skip to content

Get Research Workflow Status

GET
/research-reports/workflow

How the six-report workflow is going for one website. FREE.

The poll target for /generate and /generate-all, and the read to make before /workflow/resume - it says which reports are actually incomplete, and therefore what resuming would cost.

Authorizations

Parameters

Query Parameters

website_url
required

The website the workflow is scoped to.

string

The website the workflow is scoped to.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

One Studio object, open-shaped. See the module docstring.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string