Research

Generate Research Report

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.

post/research-reports/generate

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/research-reports/generate
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

website_urlstring required
report_numberinteger required
report_typestring nullable

Response

Successful Response

dataStudioContentPayload required

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

Changes

No recorded changes to this operation across all 2 revisions of this API.