Content

Start Content Crawl Import

Deep-crawl the org's own website into the workspace. SPENDS PROVIDER CREDIT.

Billed per page crawled; max_pages is the ceiling on the spend. Only the org's registered website can be crawled. Returns the import job - poll GET /content-workspace/import/status/{job_id}.

post/content-workspace/import/crawl

Request

  • Base URL: https://be.graph8.com/api/v1
  • URL: https://be.graph8.com/api/v1/content-workspace/import/crawl
  • Auth: HTTP bearer

Headers

Authorizationstring nullable
X-Target-Org-Idstring nullable

Request body

start_urlstring required

Must be on the org's registered website.

include_pathsstring[] nullable

e.g. ['/blog', '/resources'].

exclude_pathsstring[] nullable

e.g. ['/author', '/tag'].

max_pagesinteger

The ceiling on pages crawled - and on the spend.

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.