visibility

GET /v1/visibility/audits/{auditId}

One audit, with every finding.

모든 visibility 엔드포인트

인증

Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.

이 엔드포인트는 조직 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

응답

이름유형필수설명
idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
target_idUuidUUIDv7 identifier — sortable by creation time (docs/02 §8).
kindVisibilityAuditKindWhich 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…
statusVisibilityAuditStatus`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 `…
triggerstring<scheduled, manual, staff>아니요
scoreinteger아니요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…
summaryobject아니요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_microsinteger아니요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®.
errorstring아니요Why a failed or partial run ended as it did, in the provider's own words.
started_atstring아니요
finished_atstring아니요
findingsVisibilityFinding[]아니요

이 엔드포인트가 반환할 수 있는 오류

401 · 403 · 404