visibility
GET /v1/visibility/audits/{auditId}
One audit, with every finding.
Autentizace
Odešlete klíč API jako bearer token. Tento koncový bod ve specifikaci uvádí specifické oprávnění, takže svému klíči udělte to nejmenší možné a místo předpokladů zkontrolujte odpověď.
Tento koncový bod nevyžaduje žádné ID organizace. Váš klíč již identifikuje organizaci, ke které patří, a odpověď je na ni omezena.
Vyzvednout
Nahraďte cokoli v závorkách vlastními hodnotami a zástupný symbol klíče klíčem z vašeho řídicího panelu.
curl -X GET https://api.zinndigital.com/v1/visibility/audits/{auditId} \
-H "Authorization: Bearer zdk_live_…"Přihlášeni? Konzole API ve vašem dashboardu automaticky doplní vaše skutečné ID organizace i váš vlastní klíč a odešle požadavek na živé API, abyste viděli reálnou odpověď. Otevřete tento koncový bod v konzoli API
Podrobnosti
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.
Parametry
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
auditId (path) | string | Ano | — |
Odpověď
| Název | Typ | Požadováno | Co to je |
|---|---|---|---|
id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target_id | Uuid | Ano | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
kind | VisibilityAuditKind | Ano | 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 | Ano | 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> | Ne | — |
score | integer | Ne | 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 | Ne | 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 | Ne | 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 | Ne | Why a failed or partial run ended as it did, in the provider's own words. |
started_at | string | Ne | — |
finished_at | string | Ne | — |
findings | VisibilityFinding[] | Ne | — |
Chyby, které může tento koncový bod vrátit
401 · 403 · 404