visibility

POST `/v1/visibility/targets/{targetId}/run`

Run an audit now.

ავტორიზაცია

API გასაღები გაგზავნეთ როგორც bearer token. ეს ენდპოინტი სპეციფიკაციაში არ მიუთითებს კონკრეტულ ნებართვას, ამიტომ მიანიჭეთ თქვენს გასაღებს მინიმალური საჭირო უფლებები და ვარაუდის ნაცვლად შეამოწმეთ პასუხი.

ეს ბოლო წერტილი არ იღებს ორგანიზაციის იდენტიფიკატორს. თქვენი გასაღები უკვე აიდენტიფიცირებს იმ ორგანიზაციას, რომელსაც ის ეკუთვნის, და პასუხი შემოფარგლულია მისით.

სცადეთ

შეSubstituted any value inside angle brackets with your own and the key placeholder with a key from your dashboard.

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 კონსოლი ავტომატურად ამატებს თქვენი რეალური ორგანიზაციის ID-სა და საკუთარ გასაღებს და ატარებს მოთხოვნას ცოცხალ API-ს წინააღმდეგ, რათა იხილოთ რეალური პასუხი. გაAღით ეს ენდპოინტი 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`	დიახ	—

შეცდომები, რომლებიც ამ ენდპოინტს შეუძლია დააბრუნოს

401 · 403 · 404 · 422 · 503

POST /v1/visibility/targets/{targetId}/run