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