visibility
GET /v1/visibility/plan
What visibility add-ons this organisation holds.
認証
ベアラー トークンとして 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