પ્રમાણીકરણ
બિયરર ટૉકન તરીકે API કી મોકલો. આ એન્ડપૉઇન્ટ સ્પેશિફિકેશનમાં કોઈ ચોક્કસ પરવાનગી જણાવતું નથી, તેથી ધારણા બાંધવાને બદલે તમારી કીને તેની જરૂરિયાત મુજબ ન્યૂનતમ પરવાનગી આપો અને રિસ્પોન્સ તપાસો.
આ એન્ડપૉઇન્ટ કોઈ સંસ્થા આઈડી (organisation id) લેતું નથી. તમારી કી (key) પહેલેથી જ તે જે સંસ્થા સાથે સંબંધિત છે તેની ઓળખ કરે છે, અને પ્રતિસાદ (response) તે જ પૂરતો મર્યાદિત છે.
આયમાવો
કોઈપણ કૌંસમાં રહેલી બાબતને તમારા પોતાના મૂલ્યોથી બદલો અને કી પ્લેસહોલ્ડરને તમારા ડેશબોર્ડની કીથી બદલો.
curl -X POST https://api.zinndigital.com/v1/visibility/targets \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "domain": <string> }'साइन ઇન કરેલ છે? તમારા ડેશબોર્ડમાં આવેલું API કન્સોલ તમારી વાસ્તવિક સંસ્થાની આઈડી અને તમારી પોતાની કી ભરે છે, અને લાઇવ API સામે વિનંતી ચલાવે છે જેથી તમે વાસ્તવિક પ્રતિસાદ જોઈ શકો. આ અંતિમબિંદુને API કન્સોલમાં ખોલો
વિગતો
Adds a domain to the watch-list. A domain that is **not** hosted with us counts against the external-target allowance; the organisation's own sites do not. `category` and `market` decide what questions the answer engines are asked, and are the single most important thing a customer can supply — a reading taken on defaults is real and is worth less. `brand` is the trading name to look for in an answer, which is genuinely separate from the domain: a model that recommends a business by name without printing its URL has still mentioned them. `cadence_days: 0` pauses the schedule. It does **not** delete anything: history and settings survive and it resumes with no further action.
રિકવેસ્ટ બોડી
| નામ | પ્રકાર | જરૂરી | તે શું છે |
|---|---|---|---|
domain | string | હા | — |
label | string | ના | — |
brand | string | ના | — |
category | string | ના | — |
market | string | ના | — |
kinds | VisibilityAuditKind[] | ના | — |
cadence_days | integer | ના | — |
જવાબ
| નામ | પ્રકાર | જરૂરી | તે શું છે |
|---|---|---|---|
id | Uuid | હા | UUIDv7 identifier — sortable by creation time (docs/02 §8). |
domain | string | હા | The hostname |
label | string | ના | The customer's own label for this domain. |
brand | string | ના | The trading name to look for in an answer engine's reply. Genuinely separate from the domain — an answer that recommends a business by name without printing its URL has still me… |
category | string | ના | What this business sells, in the customer's own words. The questions asked of the answer engines are built from it, so it is the single field that decides whether an AI-visibili… |
market | string | ના | Where the business sells. Used with `category` to build the questions. |
is_external | boolean | હા | True when this is not a domain hosted with us — a competitor or a prospect. Only external targets count against the plan's allowance. |
site_id | string | ના | The site this target corresponds to, when it is one of ours. |
kinds | VisibilityAuditKind[] | હા | — |
cadence_days | integer | હા | Days between scheduled audits. `0` means paused — **not** deleted. History and settings survive and it resumes with no further action. |
next_due_at | string | ના | — |
last_audit_at | string | ના | — |
review_profiles | ReviewProfile[] | ના | — |
products | TrackedProduct[] | ના | The products this organisation has asked us to price-track. |
merchant_names | string[] | ના | How this business appears as a **seller** on the marketplaces. Confirmed by the customer and never inferred: Google Shopping publishes a seller name and no domain on its listing… |
keywords | TrackedKeyword[] | ના | The search phrases this organisation tracks its position for. Customer-supplied and never derived: asking a vendor which phrases a domain already ranks for would return exactly… |
આ એન્ડપોઇન્ટ જે ભૂલો પરત કરી શકે છે
401 · 403 · 422