visibility
GET /v1/visibility/audits/{auditId}
One audit, with every finding.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/visibility/audits/{auditId} \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Paramètres
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
auditId (path) | string | Oui | — |
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
target_id | Uuid | Oui | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
kind | VisibilityAuditKind | Oui | 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 | Oui | 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> | Non | — |
score | integer | Non | 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 | Non | 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 | Non | 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 | Non | Why a failed or partial run ended as it did, in the provider's own words. |
started_at | string | Non | — |
finished_at | string | Non | — |
findings | VisibilityFinding[] | Non | — |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404