visibility

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

One audit, with every finding.

Նույնականացում

Ուղարկեք API բանալին որպես bearer թոքեն։ Այս վերջնակետը բնութագրում չի նշում որոշակի թույլտվության մասին, ուստի տվեք ձեր բանալուն նվազագույն անհրաժեշտը և ենթադրություններ անելու փոխարեն ստուգեք պատասխանը:

Այս վերջնակետը կազմակերպության ID չի ընդունում: Ձեր բանալին արդեն իսկ նույնականացնում է այն կազմակերպությունը, որին պատկանում է, և պատասխանը սահմանափակված է դրանով:

Փորձել

Փոխարինեք անկյունային փակագծերում գտնվող ցանկացած բան ձեր սեփական արժեքներով, և բանալու տեղապահը՝ ձեր վահանակի բանալիով:

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

Մուտք գործե՞լ եք: Ձեր վահանակի API վահանակը լրացնում է ձեր իրական կազմակերպության ID-ն և ձեր սեփական բանալին և գործարկում է հարցումը ուղիղ 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 Goo…
`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

GET /v1/visibility/audits/{auditId}