KlientBrain AI VisibilityDocs

Site audits and Shopping through the API

Read your latest site check page by page, and your Shopping report, from your own scripts.

The API can read the same latest site check your Site check page shows, page by page, and the same figures your Shopping page shows. Any key can read them. For keys and how to send a request, see API access.

Addresses

Method and addressWhat it does
GET /projects/{id}/auditsYour latest site check, one entry per page, lowest AI readiness first as on the page. Each page has its errors and warnings in issues, every check in checks, its worst issue, and when it was checked. With AI readiness switched on, each page also has its score from 0 to 100, its band, its Technical, Content and AEO parts, and the reasons it lost points
GET /projects/{id}/shoppingYour Shopping report for the period: how often AI answers showed product cards and how many were yours (visibility), the results by engine, the brands, the merchants, the prompts, and the products, most shown first

Both take limit and cursor. The audits list pages the pages; the Shopping report pages the products. The Shopping report also takes from, to and engines, as the other reports do.

Before your first site check the audits list is empty, and before AI answers show any product cards the Shopping report has available set to false. Neither is an error. A site check run before 17 Oct 2026 checked the homepage only, so while that is your latest check the audits list has one entry, the homepage, with no AI readiness score.

The Shopping report answers only while Shopping is switched on for your workspace. To run a new site check, use the Site check page.

Errors

These addresses answer the same errors as the other reading addresses. If something goes wrong on our side while reading, they answer 503 api_not_available: wait a moment and send the same request again. See API errors and limits.

Need help?

Email support@klientbrain.com and tell us what you were doing.