API リファレンス：サイト

サイト（sites）の操作です。共通の決まり（認証・レート制限・エラーの形）は概要を、型の詳細はスキーマを参照してください。

AI・コーディングエージェント向けにこのページの Markdown 版とllms.txtがあります。

• GET /api/v1/sites　サイトの一覧（listSites）
• GET /api/v1/sites/{site_id}　サイトの取得（設置コードつき）（getSite）
• POST /api/v1/sites/{site_id}/url-rules/test　URL がどのキャンペーンに当たるかのテスト（testSiteUrlRules）
• GET /api/v1/sites/{site_id}/tag-config　タグに配る設定の取得（getSiteTagConfig）
• GET /api/v1/sites/{site_id}/pp-checks　プライバシーポリシー確認の結果の一覧（listSitePpChecks）
• GET /api/v1/sites/{site_id}/pp-checks/{check_id}　プライバシーポリシー確認の結果の取得（getSitePpCheck）

GET /api/v1/sites

サイトの一覧

operationId：listSites　必要なスコープ：sites:read

パラメータ

名前	場所	型	必須	説明
limit	クエリ	integer	—	1〜200・既定値 50
cursor	クエリ	string（null 可）	—	—

応答

ステータス	説明	型
200	成功	SiteListOut
401	APIキーが無効・失効（authentication_error）	Error
403	スコープ不足（permission_error / scope_insufficient）・プランの上限（plan_limit_exceeded）・APIキーではできない操作（session_required 等）	Error
422	パラメータ不正（invalid_request）。param に対象の項目名、message に理由（日本語）	Error
429	レート制限の超過（rate_limit_error）。上限はテナント単位（テナント内の全キーの合計）の直近60秒の回数で、プラン別に Free 60 / Starter 60 / Growth 300 / Pro 1,000 回。個別の設定がある場合は応答ヘッダ X-RateLimit-Limit の値が正。Retry-After（秒）の後に再試行する	Error
5XX	サーバ側の失敗（api_error）。request_id を添えて問い合わせてください。時間をおいた再試行で解消することがある（POST は同じ Idempotency-Key を付けて再試行する）	Error

GET /api/v1/sites/{site_id}

サイトの取得（設置コードつき）

operationId：getSite　必要なスコープ：sites:read

パラメータ

名前	場所	型	必須	説明
site_id	パス	string（uuid）	必須	—
nonce	クエリ	boolean	—	true にすると、設置コード（snippets）の <script> に nonce="__CSP_NONCE__" を付けて返す。自サイトの CSP（script-src 'nonce-…'）でタグを許可する時に使う。__CSP_NONCE__ は自サイトがリクエストごとに発行する nonce の値へ置き換えて出力する（固定値にすると CSP が効かない） 既定値 false

応答

ステータス	説明	型
200	成功	SiteDetailOut
401	APIキーが無効・失効（authentication_error）	Error
403	スコープ不足（permission_error / scope_insufficient）・プランの上限（plan_limit_exceeded）・APIキーではできない操作（session_required 等）	Error
404	対象が見つからない（not_found）。他のテナントの ID を指した時も同じ 404	Error
422	パラメータ不正（invalid_request）。param に対象の項目名、message に理由（日本語）	Error
429	レート制限の超過（rate_limit_error）。上限はテナント単位（テナント内の全キーの合計）の直近60秒の回数で、プラン別に Free 60 / Starter 60 / Growth 300 / Pro 1,000 回。個別の設定がある場合は応答ヘッダ X-RateLimit-Limit の値が正。Retry-After（秒）の後に再試行する	Error
5XX	サーバ側の失敗（api_error）。request_id を添えて問い合わせてください。時間をおいた再試行で解消することがある（POST は同じ Idempotency-Key を付けて再試行する）	Error

POST /api/v1/sites/{site_id}/url-rules/test

URL がどのキャンペーンに当たるかのテスト

operationId：testSiteUrlRules　必要なスコープ：campaigns:read

URL のマッチテスト。評価するのは配信中のタグ設定そのもの。

タグが実際に使う設定と同じ判定で、どのキャンペーンのどの役割に当たるかを返す（書き込みなし）。

パラメータ

名前	場所	型	必須	説明
site_id	パス	string（uuid）	必須	—

リクエストの本文（JSON）

型：MatchTestIn（必須）

項目	型	必須	説明
url	string	必須	—

応答

ステータス	説明	型
200	成功	MatchTestOut
401	APIキーが無効・失効（authentication_error）	Error
403	スコープ不足（permission_error / scope_insufficient）・プランの上限（plan_limit_exceeded）・APIキーではできない操作（session_required 等）	Error
404	対象が見つからない（not_found）。他のテナントの ID を指した時も同じ 404	Error
409	状態の衝突（invalid_request）。idempotency_key_in_progress（同じ Idempotency-Key の要求が処理中）	Error
422	パラメータ不正（invalid_request）。param に対象の項目名、message に理由（日本語）	Error
429	レート制限の超過（rate_limit_error）。上限はテナント単位（テナント内の全キーの合計）の直近60秒の回数で、プラン別に Free 60 / Starter 60 / Growth 300 / Pro 1,000 回。個別の設定がある場合は応答ヘッダ X-RateLimit-Limit の値が正。Retry-After（秒）の後に再試行する	Error
5XX	サーバ側の失敗（api_error）。request_id を添えて問い合わせてください。時間をおいた再試行で解消することがある（POST は同じ Idempotency-Key を付けて再試行する）	Error

GET /api/v1/sites/{site_id}/tag-config

タグに配る設定の取得

operationId：getSiteTagConfig　必要なスコープ：sites:read

パラメータ

名前	場所	型	必須	説明
site_id	パス	string（uuid）	必須	—

応答

ステータス	説明	型
200	成功。タグに配る設定。画面表示用。形は契約外（予告なく変わる）＝この中の項目に依存した処理を組まない	object（項目は未掲載）
401	APIキーが無効・失効（authentication_error）	Error
403	スコープ不足（permission_error / scope_insufficient）・プランの上限（plan_limit_exceeded）・APIキーではできない操作（session_required 等）	Error
404	対象が見つからない（not_found）。他のテナントの ID を指した時も同じ 404	Error
422	パラメータ不正（invalid_request）。param に対象の項目名、message に理由（日本語）	Error
429	レート制限の超過（rate_limit_error）。上限はテナント単位（テナント内の全キーの合計）の直近60秒の回数で、プラン別に Free 60 / Starter 60 / Growth 300 / Pro 1,000 回。個別の設定がある場合は応答ヘッダ X-RateLimit-Limit の値が正。Retry-After（秒）の後に再試行する	Error
5XX	サーバ側の失敗（api_error）。request_id を添えて問い合わせてください。時間をおいた再試行で解消することがある（POST は同じ Idempotency-Key を付けて再試行する）	Error

GET /api/v1/sites/{site_id}/pp-checks

プライバシーポリシー確認の結果の一覧

operationId：listSitePpChecks　必要なスコープ：sites:read

パラメータ

名前	場所	型	必須	説明
site_id	パス	string（uuid）	必須	—
limit	クエリ	integer	—	1〜200・既定値 20
cursor	クエリ	string（null 可）	—	—

応答

ステータス	説明	型
200	成功	PpCheckListOut
401	APIキーが無効・失効（authentication_error）	Error
403	スコープ不足（permission_error / scope_insufficient）・プランの上限（plan_limit_exceeded）・APIキーではできない操作（session_required 等）	Error
404	対象が見つからない（not_found）。他のテナントの ID を指した時も同じ 404	Error
422	パラメータ不正（invalid_request）。param に対象の項目名、message に理由（日本語）	Error
429	レート制限の超過（rate_limit_error）。上限はテナント単位（テナント内の全キーの合計）の直近60秒の回数で、プラン別に Free 60 / Starter 60 / Growth 300 / Pro 1,000 回。個別の設定がある場合は応答ヘッダ X-RateLimit-Limit の値が正。Retry-After（秒）の後に再試行する	Error
5XX	サーバ側の失敗（api_error）。request_id を添えて問い合わせてください。時間をおいた再試行で解消することがある（POST は同じ Idempotency-Key を付けて再試行する）	Error

GET /api/v1/sites/{site_id}/pp-checks/{check_id}

プライバシーポリシー確認の結果の取得

operationId：getSitePpCheck　必要なスコープ：sites:read

パラメータ

名前	場所	型	必須	説明
site_id	パス	string（uuid）	必須	—
check_id	パス	string（uuid）	必須	—

応答

ステータス	説明	型
200	成功	PpCheckOut
401	APIキーが無効・失効（authentication_error）	Error
403	スコープ不足（permission_error / scope_insufficient）・プランの上限（plan_limit_exceeded）・APIキーではできない操作（session_required 等）	Error
404	対象が見つからない（not_found）。他のテナントの ID を指した時も同じ 404	Error
422	パラメータ不正（invalid_request）。param に対象の項目名、message に理由（日本語）	Error
429	レート制限の超過（rate_limit_error）。上限はテナント単位（テナント内の全キーの合計）の直近60秒の回数で、プラン別に Free 60 / Starter 60 / Growth 300 / Pro 1,000 回。個別の設定がある場合は応答ヘッダ X-RateLimit-Limit の値が正。Retry-After（秒）の後に再試行する	Error
5XX	サーバ側の失敗（api_error）。request_id を添えて問い合わせてください。時間をおいた再試行で解消することがある（POST は同じ Idempotency-Key を付けて再試行する）	Error