visibility

GET `/v1/visibility/audits/{auditId}`

One audit, with every finding.

Uthibitishaji

Tuma ufunguo wa API kama tokeni ya kubeba. Sehemu hii ya mwisho haitaji ruhusa maalum katika maelezo, kwa hivyo ipe ufunguo wako kiwango cha chini kabisa kinachohitajika na uangalie jibu badala ya kukisia.

Endpoint hii haichukui kitambulisho cha shirika. Ufunguo wako tayari unalitambua shirika linalohusika, na jibu limewekewa kikomo kwa shirika hilo pekee.

Jaribu

Badilisha chochote kilicho ndani ya mabano ya pembe na maadili yako mwenyewe, na kishikiliaji cha ufunguo na ufunguo kutoka kwa dashibodi yako.

curl -X GET https://api.zinndigital.com/v1/visibility/audits/{auditId} \
  -H "Authorization: Bearer zdk_live_…"

Umeingia kwenye akaunti? Dashibodi yako ya kiweko cha API inajaza kitambulisho chako halisi cha shirika na ufunguo wako mwenyewe, na kuendesha ombi dhidi ya API ya moja kwa moja ili uweze kuona jibu halisi. Fungua sehemu hii ya mwisho (endpoint) kwenye konsole ya API

Maelezo

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.

Vigezo

Jina	Aina	Inayohitajika	Kilicho hiki
`auditId (path)`	`string`	Ndiyo	—

Majibu

Jina	Aina	Inayohitajika	Kilicho hiki
`id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`target_id`	`Uuid`	Ndiyo	UUIDv7 identifier — sortable by creation time (docs/02 §8).
`kind`	`VisibilityAuditKind`	Ndiyo	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`	Ndiyo	`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>`	Hapana	—
`score`	`integer`	Hapana	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`	Hapana	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`	Hapana	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`	Hapana	Why a failed or partial run ended as it did, in the provider's own words.
`started_at`	`string`	Hapana	—
`finished_at`	`string`	Hapana	—
`findings`	`VisibilityFinding[]`	Hapana	—

Hitilafu ambazo mwisho huu unaweza kurudisha

401 · 403 · 404

GET /v1/visibility/audits/{auditId}