visibility
GET /v1/visibility/plan
What visibility add-ons this organisation holds.
Аутентификација
Пошаљите API кључ као bearer токен. Ова крајња тачка не наводи конкретну дозволу у спецификацији, па свом кључу доделите најмања неопходна овлашћења и проверите одговор уместо да претпостављате.
Ова крајња тачка не прихвата id организације. Ваш кључ већ идентификује организацију којој припада, а одговор је ограничен на њу.
Испробајте
Замените све што је у угластим заградама сопственим вредностима, а чувар места кључа кључем са своје контролне табле.
curl -X GET https://api.zinndigital.com/v1/visibility/plan \
-H "Authorization: Bearer zdk_live_…"Пријављени сте? API конзола на вашој контролној табли попуњава ваш прави id организације и ваш сопствени кључ, и покреће захтев према живом 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,… |
mention_phrase_allowance | integer | Не | How many phrases this organisation may listen for across the web (brand mentions), across all its domains. -1 means unlimited; 0 means brand mentions is not held. |
mention_check_allowance | integer | Не | How many brand-mention checks a month the plan includes. -1 means unlimited. |
mention_checks_used | integer | Не | Brand-mention checks already used this calendar month (UTC) — the same figure the scheduled checks spend against, so the screen cannot promise room they will not honour. |
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… |
rank_check_cadence | object | Не | How often this organisation's rank phrases are checked right now, and why. null when rank tracking is not held. Read from the same helper the scheduled sweep asks at the point… |
allowances | SeoAllowances | Не | Every allowance a V1-parity SEO tier sells, metered at the point of use. Monthly: audits (site audits), refreshes (backlink profile readings), lists (keyword research… |
credit_balance_micros | integer | Не | The organisation's Zinn® credit balance in USD micros. |
Грешке које ова крајња тачка може вратити
401 · 403 · 404