Get setup state REST API

GET

/api/sites/{id}/setup-state

curl --request GET \
  --url http://127.0.0.1:25737/api/sites/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/setup-state \
  --cookie hk_token=<hk_token>

Reports whether a site has ever recorded AI fetches, chatbot events, custom events, ecommerce events, or web vitals so the dashboard can show setup guidance instead of empty reports. Requires site.view.

Authorizations

• cookieAuth

Parameters

Path Parameters

id

required

string format: uuid

Responses

200

Site setup state

Media typeapplication/json

object

has_ai_fetches

required

boolean

has_chatbot_events

required

boolean

has_custom_events

required

boolean

has_ecommerce_events

required

boolean

has_web_vitals

required

boolean

Example^generated

{
  "has_ai_fetches": true,
  "has_chatbot_events": true,
  "has_custom_events": true,
  "has_ecommerce_events": true,
  "has_web_vitals": true
}

403

Access denied

Media typeapplication/json

object

message

string

Example^generated

{
  "message": "example"
}