visibility
GET /v1/visibility/plan
What visibility add-ons this organisation holds.
Authentification
Envoyez une clé d'API en tant que jeton du porteur (bearer token). Cet endpoint n'indique pas de permission spécifique dans la spécification, attribuez donc à votre clé le minimum requis et vérifiez la réponse plutôt que de faire des suppositions.
Cet endpoint ne prend aucun identifiant d'organisation. Votre clé identifie déjà l'organisation à laquelle elle appartient, et la réponse y est limitée.
Essayer
Remplacez tout ce qui se trouve entre crochets par vos propres valeurs, et le espace réservé à la clé par une clé de votre tableau de bord.
curl -X GET https://api.zinndigital.com/v1/visibility/plan \
-H "Authorization: Bearer zdk_live_…"Connecté ? La console d'API de votre tableau de bord saisit votre véritable ID d'organisation ainsi que votre propre clé, et exécute la requête sur l'API de production afin que vous puissiez voir la réponse réelle. Ouvrir ce point de terminaison dans la console API
Détails
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.
Réponse
| Nom | Type | Obligatoire | Qu'est-ce que c'est |
|---|---|---|---|
products | VisibilityAuditKind[] | Oui | — |
from_plan | VisibilityAuditKind[] | Oui | 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 capability… |
sellable | VisibilityAuditKind[] | Oui | — |
external_allowance | integer | Oui | — |
external_used | integer | Oui | — |
external_remaining | integer | Non | — |
byo_seo_providers | string[] | Non | 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 | Non | 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,… |
keyword_allowance | integer | Non | How many search phrases this organisation may track positions for. A third separate allowance, distinct from both external_allowance and product_allowance, because the… |
credit_balance_micros | integer | Non | The organisation's Zinn® credit balance in USD micros. |
Erreurs que cet point de terminaison peut renvoyer
401 · 403 · 404