visibility

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

One audit, with every finding.

المصادقة

أرسل مفتاح واجهة برمجة التطبيقات (API) كرمز حامل (bearer token). لا يحدد نقطة النهاية هذه إذنًا محددًا في المواصفات، لذا امنح مفتاحك الحد الأدنى الذي محتاجه وتحقق من الاستجابة بدلاً من الافتراض.

لا يقبل هذا الطرف أي معرف للمؤسسة. يحدد مفتاحك بالفعل المؤسسة التي ينتمي إليها، وتكون الاستجابة محصورة في نطاقها.

جربه الآن

استبدل أي شيء بين أقواس زاوية بقيمك الخاصة، والعنصر النائب للمفتاح بمفتاح من لوحة تحكمك.

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

هل سجلت الدخول؟ تقوم وحدة تحكم واجهة برمجة التطبيقات في لوحة التحكم الخاصة بك بربط معرف مؤسستك الحقيقي ومفتاحك الخاص، وتنفذ الطلب مقابل واجهة برمجة التطبيقات المباشرة لتتمكن من رؤية الاستجابة الفعلية. افتح هذه النهاية الطرفية في وحدة تحكم 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}