visibility
GET /v1/visibility/plan
What visibility add-ons this organisation holds.
Автентифікація
Надішліть ключ API як маркер носія (bearer token). Ця кінцева точка не вказує конкретного дозволу в специфікації, тому надайте своєму ключу мінімально необхідні права та перевірте відповідь, замість того щоб припускати.
Цей кінцевий пункт не потребує ідентифікатора організації. Ваш ключ уже ідентифікує організацію, якій він належить, і відповідь обмежується її межами.
Спробувати
Замініть усе в кутових дужках власними значеннями, а заповнювач ключа — ключем із вашої панелі керування.
curl -X GET https://api.zinndigital.com/v1/visibility/plan \
-H "Authorization: Bearer zdk_live_…"Увійшли в систему? Консоль API у вашій панелі керування автоматично підставляє ваш реальний ідентифікатор організації та ваш власний ключ, а також виконує запит до робочого API, щоб ви могли побачити справжню відповідь. Відкрийте цю кінцеву точку в консолі API
Деталі
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.
Відповідь
| Назва | Тип | Обов'язкове | Що це таке |
|---|---|---|---|
products | VisibilityAuditKind[] | Так | — |
from_plan | VisibilityAuditKind[] | Так | 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[] | Так | — |
external_allowance | integer | Так | — |
external_used | integer | Так | — |
external_remaining | integer | Ні | — |
byo_seo_providers | string[] | Ні | 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 | Ні | 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 | Ні | 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 | Ні | The organisation's Zinn® credit balance in USD micros. |
Помилки, які може повертати ця кінцева точка
401 · 403 · 404