Skip to main content
POST
Post Website Analysis

Authorizations

X-API-Key
string
header
required

Headers

Idempotency-Key
string | null

An opaque key, ideally a UUID, that makes this request safe to retry. A second request with the same key, path, query and body answers with the resource the first one created, marked Idempotent-Replayed: true, instead of creating another; a sync request that finds it still running waits for it. The same key with a different request is refused with 422. Keys are scoped to your application and to this resource type, and are kept for the life of the resource.

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-10-29T05:44:48.057469"

updated_at
string<date-time> | null
required

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

Example:

"2026-10-29T05:44:48.057488"

url
string<uri>
required

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

Minimum string length: 1
Example:

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

idempotency_key
string | null

The Idempotency-Key header the request that created this resource carried, if any.

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:

"05e6169f-f9c2-416f-8da2-99b881b6cae3"

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: