links

GET /v1/content/link-sets/{linkSetId}

One link set, with its resolved distribution.

すべての links エンドポイント

認証

ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。

このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。

試してみる

アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。

curl -X GET https://api.zinndigital.com/v1/content/link-sets/{linkSetId} \
  -H "Authorization: Bearer zdk_live_…"

ログインしていますか?ダッシュボード内のAPIコンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブAPIに対してリクエストが実行されるため、実際のレスポンスを確認することができます。 API コンソールでこのエンドポイントを開く

詳細

Gated on `links.view`. Carries the same `distribution` the list does — the resolved share of every (URL, wording) pair, computed by the function a recipe run actually uses, so the preview and the placements cannot disagree.

パラメータ

名前タイプ必須これがその内容です
linkSetId (path)stringはい

返信

名前タイプ必須これがその内容です
idstringはい
namestringはい
notesstringはい
is_archivedbooleanはいAn archived set is hidden from the picker and takes no new recipes; the recipes already using it keep working. Archiving is offered where deleting is refused.
entriesLinkSetEntry[]はい
created_atstringはい
updated_atstringはい
recipe_countintegerはいHow many recipes point at this set — so a delete button can say so first.
distributionobject[]はいThe resolved share of every (URL, wording) pair, summing to 100 — what will actually happen. Computed by the same function a run uses.
distribution_errorstringはいWhy there is no distribution, or empty. Separate from `distribution` because an empty list also means "this set has no links", and one value for two facts is not an answer.

このエンドポイントが返すエラー

401 · 403 · 404