Skip to content

Generate Research Report

POST
/research-reports/generate

Generate ONE of the six reports. SPENDS CREDIT - heavily.

A long multi-pass run against the market, the customer’s own site and its competitors. This is the most expensive single operation in Studio.

Asynchronous: it returns once the run is dispatched. Poll GET /research-reports/workflow?website_url=... for progress.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Generate ONE research report. SPENDS CREDIT - a long multi-pass run.

object
report_number
required
integer
report_type
Any of:
string
website_url
required
string

Responses

202

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