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… |
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