visibility
GET /v1/visibility/audits/{auditId}
One audit, with every finding.
Tabbatar da Asali
Aiko da maɓallin API a matsayin bearer token. Wannan ma'anar ba ta bayyana takamaiman izini ba a cikin ƙayyadaddun bayanai, don haka ba wa maɓallin ku mafi ƙarancin abin da yake buƙata kuma ku bincika amsar maimakon yin zato.
Wannan wurin ƙarewa ba ya buƙatar ID na ƙungiya. Maɓallin ku ya riga ya gano ƙungiyar da yake ciki, kuma an iyakance amsa a kanta.
Gwada
May gurbin komai da ke cikin kusurwa da ƙimar ka, kuma may gurbin maballi da maballi daga allon sarrafa ka.
curl -X GET https://api.zinndigital.com/v1/visibility/audits/{auditId} \
-H "Authorization: Bearer zdk_live_…"An shiga? Na'urar sarrafa API da ke cikin sashin kulawarka tana cika ainihin lambar ƙungiyarka da maɓallinka naka, sannan tana gudanar da buƙatar a kan ainihin API don haka zaka iya ganin amsar gaske. Buɗe wannan tashar a cikin na'urar kula da API
Bayani
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.
Sigogi
| Suna | Nau'i | Ana buƙata | Abin da yake |
|---|---|---|---|
auditId (path) | string | Eh | — |
Martani
| Suna | Nau'i | Ana buƙata | Abin da yake |
|---|---|---|---|
id | Uuid | Eh | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target_id | Uuid | Eh | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
kind | VisibilityAuditKind | Eh | 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 | Eh | `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> | A'a | — |
score | integer | A'a | 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 | A'a | 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 | A'a | 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 | A'a | Why a failed or partial run ended as it did, in the provider's own words. |
started_at | string | A'a | — |
finished_at | string | A'a | — |
findings | VisibilityFinding[] | A'a | — |
Kuskuren da wannan matsaya za ta iya maido wa
401 · 403 · 404