visibility
GET /v1/visibility/audits/{auditId}
One audit, with every finding.
Kimlik Doğrulama
Bir API anahtarını bearer token olarak gönderin. Bu uç nokta, teknik özelliklerde belirli bir yetki belirtmemektedir; bu nedenle, varsaymak yerine anahtarınıza ihtiyaç duyduğu en az yetkiyi verin ve yanıtı kontrol edin.
Bu uç nokta hiçbir organizasyon kimliği almaz. Anahtarınız zaten ait olduğu organizasyonu tanımlar ve yanıt bu organizasyonla sınırlandırılır.
Dene
Köşeli parantez içindeki her şeyi kendi değerlerinizle ve anahtar yer tutucusunu panonuzdan bir anahtarla değiştirin.
curl -X GET https://api.zinndigital.com/v1/visibility/audits/{auditId} \
-H "Authorization: Bearer zdk_live_…"Oturum açtınız mı? Panonuzdaki API konsolu, gerçek organizasyon kimliğinizi ve kendi anahtarınızı otomatik olarak doldurur ve isteği canlı API üzerinde çalıştırarak gerçek yanıtı görmenizi sağlar. Bu uç noktayı API konsolunda açın
Ayrıntılar
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.
Parametreler
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
auditId (path) | string | Evet | — |
Yanıt
| Ad | Tür | Zorunlu | Ne olduğu |
|---|---|---|---|
id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target_id | Uuid | Evet | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
kind | VisibilityAuditKind | Evet | 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 Goo… |
status | VisibilityAuditStatus | Evet | `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> | Hayır | — |
score | integer | Hayır | 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 | Hayır | 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 | Hayır | 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 | Hayır | Why a failed or partial run ended as it did, in the provider's own words. |
started_at | string | Hayır | — |
finished_at | string | Hayır | — |
findings | VisibilityFinding[] | Hayır | — |
Bu uç noktanın dönderebileceği hatalar
401 · 403 · 404