visibility
POST /v1/visibility/targets/{targetId}/run
Run an audit now.
Упълномощаване
Изпратете API ключ като носител (bearer token). Тази точка за достъп не указва конкретно разрешение в спецификацията, затова дайте на ключа си най-малкото необходимо и проверете отговора, вместо да правите предположения.
Този ендпойнт не изисква идентификатор на организация. Вашият ключ вече идентифицира организацията, към която принадлежи, и отговорът е ограничен до нея.
Опитайте
Заменете всичко в квадратни скоби със собствени стойности, а ключовия заместващ символ – с ключ от вашето табло за управление.
curl -X POST https://api.zinndigital.com/v1/visibility/targets/{targetId}/run \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "kind": <VisibilityAuditKind> }'Влязохте ли в профила си? API конзолата във вашето табло за управление попълва действителното идентификационно число на вашата организация и вашия собствен ключ и изпълнява заявката спрямо реалното API, за да можете да видите действителния отговор. Отворете този крайpoint в API конзолата
Детайли
Starts an on-demand audit and returns `202` with a workflow id. The scheduled audit is included in the add-on; an on-demand run **spends Zinn® credits**, and the request is refused with `403` when the balance will not cover it. This is asynchronous by necessity, not by preference: one AI-visibility audit is a dozen provider calls and some answer engines take minutes. Poll the audit list for the result. The workflow id is deterministic per target and product, so pressing the button twice costs one audit rather than two.
Параметри
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
targetId (path) | Uuid | Да | The watched domain's id. |
Тяло на заявката
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
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… |
Отговор
| Име | Тип | Задължително | Какво представлява |
|---|---|---|---|
workflow_id | string | Да | — |
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… |
target_id | string | Да | — |
Грешки, които този крайpoint може да върне
401 · 403 · 404 · 422 · 503