visibility
GET /v1/visibility/plan
What visibility add-ons this organisation holds.
ማረጋገጫ
የኤፒአይ ቁልፍ (API key) እንደ ቢረር ቶከን (bearer token) ይላኩ። ይህ የመጨረሻ ነጥብ (endpoint) በመግለጫው ውስጥ የተወሰነ ፈቃድ አልገለጸም፣ ስለዚህ ከማሰብ ይልቅ ለቁልፍዎ የሚያስፈልገውን አነስተኛ ፈቃድ ይስጡት እና ምላሹን ያረጋግጡ።
ይህ ኤንድፖይ መክፈቻ (endpoint) የድርጅት መታወቂያ (organisation id) አይወስድም። የእርስዎ ቁልፍ (key) እሱ የሚመለከተውን ድርጅት አስቀድሞ ይለያል፣ እና ምላሹም ለዚሁ የተወሰነ ነው።
ሞክሩት
በቅንፍ ውስጥ ያለውን ማንኛውንም ነገር በራስዎ እሴቶች ይተኩ፣ እና ቁልፍ ቦታ ያዢውን ከዳሽቦርድዎ በመጣ ቁልፍ ይተኩ።
curl -X GET https://api.zinndigital.com/v1/visibility/plan \
-H "Authorization: Bearer zdk_live_…"ገብተዋል? የመቆጣጠሪያ ማዕከልዎ ውስጥ ያለው የኤፒአይ ኮንሶል ትክክለኛውን የድርጅት መታወቂያዎን እና የራስዎን ቁልፍ ይሞላል፣ እና ትክክለኛውን ምላሽ ማየት እንዲችሉ ጥያቄውን በቀጥታ ከሚሰራው ኤፒአይ ጋር ያካሂደዋል። ይህን ኤንድፖይንት በ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