visibility
POST /v1/visibility/targets/{targetId}/run
Run an audit now.
ప్రమాణీకరణ
ఒక API కీని బేరర్ టోకెన్గా పంపండి. ఈ ఎండ్పాయింట్ స్పెసిఫికేషన్లో నిర్దిష్ట అనుమతిని పేర్కొనలేదు, కాబట్టి ఊహించడం కంటే మీ కీకి అవసరమైన కనిష్ట అనుమతిని ఇవ్వండి మరియు ప్రతిస్పందనను తనిఖీ చేయండి.
ఈ ఎండ్పాయింట్ ఎలాంటి సంస్థ ఐడీని తీసుకోదు. మీ కీ ఇప్పటికే అది ఏ సంస్థకు చెందుతుందో గుర్తిస్తుంది మరియు ప్రతిస్పందన దానికే పరిమితం చేయబడుతుంది.
ప్రయత్నించండి
కోణీయ బ్రాకెట్లలో ఉన్న దేన్నైనా మీ స్వంత విలువలతో భర్తీ చేయండి, మరియు కీ ప్లేస్హోల్డర్ను మీ డాష్బోర్డ్ నుండి తీసుకున్న కీతో భర్తీ చేయండి.
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 ద్వారా ఆభ్యర్థనను రన్ చేస్తుంది. ఈ ఎండ్పాయింట్ను 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