links
GET /v1/content/targets/facets
Filter counts over the whole matching set, not the current page.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
組織 ID を入力する場所
このエンドポイントはクエリパラメータとして org_id を受け取ります。省略した場合はテナントサブツリー全体が対象になり、指定した場合は特定の組織のみに絞り込まれます。
組織IDは、ダッシュボードのAPIキー画面にキーのすぐ横に表示されています。これは、実行するすべての呼び出しで同じIDになります。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
curl -X GET https://api.zinndigital.com/v1/content/targets/facets \
-H "Authorization: Bearer zdk_live_…"ログインしていますか？ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く
詳細
Counts per suitability, product line, CMS and site group, computed over **every** site matching the current filters. Gated on `links.view`. ⭐ This is what makes "select all 214 matching" a number a customer can trust rather than an extrapolation from the 50 rows on screen. It accepts the same filter parameters as `listContentTargets`. ⛔ The `unknown` count **includes every site that has never been probed**. A facet that counted only stored rows would report `unknown: 0` on an estate where nothing had been checked — a blind instrument reporting that everything is fine.
パラメータ
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
org_id (query) | string | いいえ | — |
q (query) | string | いいえ | — |
suitability (query) | string<ready, needs_setup, unknown, unsuitable, blocked> | いいえ | — |
product_line (query) | string | いいえ | — |
stack_type (query) | string | いいえ | — |
group_id (query) | string | いいえ | — |
cms (query) | string | いいえ | — |
返信
| 名前 | タイプ | 必須 | これがその内容です |
|---|---|---|---|
total | integer | はい | — |
suitability | ContentTargetFacetCount[] | はい | — |
product_line | ContentTargetFacetCount[] | はい | — |
cms | ContentTargetFacetCount[] | はい | — |
group | ContentTargetFacetCount[] | はい | — |
このエンドポイントが返すエラー
401 · 403