visibility
GET /v1/visibility/audits/{auditId}
One audit, with every finding.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
curl -X GET https://api.zinndigital.com/v1/visibility/audits/{auditId} \
-H "Authorization: Bearer zdk_live_…"Вошли в систему? Консоль API в вашей панели управления автоматически подставляет реальный идентификатор вашей организации и ваш собственный ключ, а также выполняет запрос к работающему API, чтобы вы могли увидеть актуальный ответ. Откройте эту конечную точку в API-консоли
Подробнее
The full result of one audit: its score, its product-specific summary and every individual check that was made — including the ones that passed, which are half the product. An audit that listed only faults would show a healthy site an empty screen, which reads as "the audit did not run". score is null when nothing could be measured. It is not zero. Zero means we asked and the answer engines do not mention this site; null means we could not ask.
Параметры
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
auditId (path) | string | Да | — |
Ответ
| Имя | Тип | Обязательно | Что это |
|---|---|---|---|
id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target_id | Uuid | Да | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
kind | VisibilityAuditKind | Да | Which product an audit belongs to. ai_visibility — do the answer engines cite this site, and is it fit to be cited at all. reputation — ratings and recent reviews across… |
status | VisibilityAuditStatus | Да | partial is a first-class state, not a tidy-up. An AI-visibility run asks several engines and one may be unreachable; a crawl may stop at its page budget. Recording either as… |
trigger | string<scheduled, manual, staff> | Нет | — |
score | integer | Нет | 0–100, or null when nothing could be measured. null is not zero. Zero means we asked and this site is invisible; null means we could not ask. A client that renders the… |
summary | object | Нет | The product-specific payload — the engine answers and mention rate for ai_visibility, the per-platform ratings for reputation, the crawl totals for onpage. For onpage,… |
charged_micros | integer | Нет | What this run cost the customer in credit micros. 0 for a scheduled run included in the add-on. The response deliberately carries no figure for what it cost Zinn®. |
error | string | Нет | Why a failed or partial run ended as it did, in the provider's own words. |
started_at | string | Нет | — |
finished_at | string | Нет | — |
findings | VisibilityFinding[] | Нет | — |
Ошибки, которые может возвращать этот эндпоинт
401 · 403 · 404