Skip to main content
POST
Post Website Analysis

Authorizations

X-API-Key
string
header
required

Headers

Prefer
string | null

Request execution preference (RFC 7240). Use respond-async for asynchronous execution, wait=N to specify a synchronous timeout hint in seconds, or priority=low to route the task to the low-priority queue.

Example:

"respond-async"

Body

application/json
url
string<uri>
required

The URL of the website that was analyzed.

Minimum string length: 1

Response

Response

id
string<uuid>
required

The ID of the Website Analysis request

state
enum<string>
required

The status of the Website Analysis request

Available options:
PENDING,
EXECUTING,
COMPLETED,
FAILED,
CANCELLED
created_at
string<date-time>
required

The date and time when the Website Analysis was created.

Example:

"2026-08-31T10:31:07.779884"

updated_at
string<date-time> | null
required

The most recent date and time when the Website Analysis was updated.

Example:

"2026-08-31T10:31:07.779896"

url
string<uri>
required

The website URL that was analyzed as part of the Search.

Minimum string length: 1
Example:

"http://www.ray.com/"

business_id
string<uuid> | null

If the website analysis was performed on a business's website, this will be the ID of the business.

Example:

"58ee7b3f-f960-4080-87e0-c969557e3732"

reference_id
string | null

An optional reference ID associated with this request, inherited from the parent search.

Example:

"Search1234"

website_analysis
WebsiteAnalysisDetails (v1) · object | null

The details of the website analysis.

Example: