visibility
GET /v1/visibility/audits/{auditId}
One audit, with every finding.
Πισtoποίηση
Στείλτε ένα κλειδί API ως διακριτικό φορέα (bearer token). Αυτό το τελικό σημείο δεν ορίζει μια συγκεκριμένη άδεια στην προδιαγραφή, οπότε δώστε στο κλειδί σας τα ελάχιστα δυνατά δικαιώματα και ελέγξτε την απόκριση αντί να κάνετε υποθέσεις.
Αυτό το τελικό σημείο δεν δέχεται αναγνωριστικό οργανισμού. Το κλειδί σας προσδιορίζει ήδη τον οργανισμό στον οποίο ανήκει, και η απάντηση περιορίζεται σε αυτόν.
Δοκιμάστε το
Ατικatastήstε ό,τι βρίskεtai μέσα σe γώniaδeς μe τis δikές sas timές, kai to placeholder klεidioύ μe éna klεidi apó ton pinaka ελέgchou sas.
curl -X GET https://api.zinndigital.com/v1/visibility/audits/{auditId} \
-H "Authorization: Bearer zdk_live_…"Συνδεθήκατε; Η κονσόλα API στον πίνακα ελέγχου σας συμπληρώνει το πραγματικό αναγνωριστικό του οργανισμού σας και το δικό σας κλειδί, και εκτελεί το αίτημα στο ζωντανό 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.
Παράμετροι
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
auditId (path) | string | Ναι | — |
Απάντηση
| Όνομα | Τύpος | Υποχρεωτικό | Τι είναι |
|---|---|---|---|
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