POST
Start Ecommerce Audit

Authorizations

X-API-Key
string
header
required

An API key of your account, from Settings > API Keys. It starts with gnz-.

Path Parameters

brand_id
integer
required

Body

application/json
engine
enum<string>
default:google-gemini

The surface of the engine that the audit reads.

Available options:
google-gemini,
google-ai-mode
include_competitors
boolean
default:true

Also audit each tracked competitor with a website.

Response

Successful Response

status
enum<string>
required

already_queued: an audit of the brand runs now, thus no second one starts.

Available options:
queued,
already_queued