ai

GET /v1/ai/reports

The AI reports this organization has bought.

All ai endpoints

Authentication

Send an API key as a bearer token. The key must carry the sites.view permission; a key without it is refused with 403, not 404.

This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X GET https://api.zinndigital.com/v1/ai/reports \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Every AI product's written report, with the fixes it raised — AI Webmaster site reviews and AI Update Guard pre-flight checks alike, newest first, distinguished by `kind`. An empty `report` while `status` is `fulfilling` means the run is still going — it does **not** mean nothing was found, and a client must render the difference. A `failure_reason` means the run was refused and the charge refunded. Requires `sites.view`.

Response

NameTypeRequiredWhat it is
dataAiReport[]Yes

Errors this endpoint can return

401 · 403 · 429