Skip to content

Analyze Website

POST
/intelligence/analyze

Start researching a website (scrapes and runs models; billable). Poll the returned task.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
force

Re-run even when a recent analysis exists.

boolean
website_url
required

The company website to research.

string

Responses

200

Successful Response

object
data
required

An intelligence task, data record or document, as the app returns it.

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