visibility
GET /v1/visibility/plan
What visibility add-ons this organisation holds.
Autenticazione
Invia una chiave API come bearer token. Questo endpoint non specifica un permesso specifico nella specifica, quindi assegna alla tua chiave i permessi minimi necessari e verifica la risposta invece di fare supposizioni.
Questo endpoint non richiede alcun ID organizzazione. La tua chiave identifica già l'organizzazione a cui appartiene e la risposta è limitata ad essa.
Provalo
Sostituisci qualsiasi elemento tra parentesi angolari con i tuoi valori e il segnaposto key con una chiave dalla tua dashboard.
curl -X GET https://api.zinndigital.com/v1/visibility/plan \
-H "Authorization: Bearer zdk_live_…"Hai effettuato l'accesso? La console API nella tua dashboard inserisce il tuo ID organizzazione reale e la tua chiave personale, ed esegue la richiesta sull'API live in modo da poter vedere la risposta effettiva. Apri questo endpoint nella console API
Dettagli
Which visibility products the organisation has (`ai_visibility`, `reputation`, `onpage`, `product_data`, `rank`, `backlinks`, `keyword_research`, `competitors`, `domain_score` — see `VisibilityAuditKind`), how many external domains it may watch, how many it is using, how many products it may price-track, and the Zinn® credit balance an on-demand run would draw on. `from_plan` lists the products granted by the plan or a bundle rather than by a standalone add-on. An upsell surface must read it and say "included in your plan" instead of offering to sell a capability the customer already holds — a product is a switch you cannot hold twice, unlike the target allowance, which stacks. `credit_balance_micros` is the customer's own balance in USD micros. The response deliberately carries **no** figure for what a run costs Zinn® and no margin: that is on the admin surface only.
Risposta
| Nome | Tipo | Obbligatorio | Che cos'è |
|---|---|---|---|
products | VisibilityAuditKind[] | Sì | — |
from_plan | VisibilityAuditKind[] | Sì | Products granted by the plan or a bundle rather than by a standalone add-on. An upsell surface reads this and says "included in your plan" instead of offering to sell a capabili… |
sellable | VisibilityAuditKind[] | Sì | — |
external_allowance | integer | Sì | — |
external_used | integer | Sì | — |
external_remaining | integer | No | — |
byo_seo_providers | string[] | No | SEO providers this organisation has connected its **own** API key for, by name (`majestic`, `ahrefs`, `moz`, `dataforseo_backlinks`). Their checks run against the customer's own… |
product_allowance | integer | No | How many products this organisation may price-track. A **separate** allowance from `external_allowance` on purpose: a target is a domain and costs the same whatever it sells, wh… |
keyword_allowance | integer | No | How many search phrases this organisation may track positions for. A **third** separate allowance, distinct from both `external_allowance` and `product_allowance`, because the u… |
credit_balance_micros | integer | No | The organisation's Zinn® credit balance in USD micros. |
Errori che questo endpoint può restituire
401 · 403 · 404