visibility
GET /v1/visibility/plan
What visibility add-ons this organisation holds.
인증
Bearer 토큰으로 API 키를 전송하세요. 이 엔드포인트는 명세에 특정 권한을 명시하지 않으므로, 가정하기보다는 키에 필요한 최소한의 권한을 부여하고 응답을 확인하세요.
이 엔드포인트는 조직 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 capabili… |
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, wh… |
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 u… |
credit_balance_micros | integer | 아니요 | The organisation's Zinn® credit balance in USD micros. |
이 엔드포인트가 반환할 수 있는 오류
401 · 403 · 404