# API リファレンス

> https://okaeri.tech/developers/reference/ の Markdown 版。

OKAERI の公開 API の全操作です。このリファレンスは機械可読の仕様（[openapi.json](https://api.okaeri.tech/api/v1/openapi.json)）から作っています。共通の決まりは[概要](https://okaeri.tech/developers/index.md)を参照してください。

- [サイト](https://okaeri.tech/developers/reference/sites.md)（6 件）
- [同意の設定](https://okaeri.tech/developers/reference/consent-settings.md)（1 件）
- [キャンペーン](https://okaeri.tech/developers/reference/campaigns.md)（7 件）
- [シナリオ](https://okaeri.tech/developers/reference/scenarios.md)（9 件）
- [文面](https://okaeri.tech/developers/reference/messages.md)（10 件）
- [リード](https://okaeri.tech/developers/reference/leads.md)（2 件）
- [配信](https://okaeri.tech/developers/reference/deliveries.md)（2 件）
- [配信スイッチ](https://okaeri.tech/developers/reference/delivery-status.md)（1 件）
- [除外リスト](https://okaeri.tech/developers/reference/suppressions.md)（3 件）
- [レポート](https://okaeri.tech/developers/reference/reports.md)（2 件）
- [Webhook](https://okaeri.tech/developers/reference/webhooks.md)（6 件）
- [スキーマ](https://okaeri.tech/developers/reference/schemas.md)（リクエスト・応答・Webhook の本文の型）

## 読み方

- パスはベース URL（`https://api.okaeri.tech`）からの完全な形です
- 必要なスコープは、API キーに付いている必要がある権限です（openapi.json の `x-okaeri-scopes`）
- 「null 可」は `null` が入ることがある項目です。「必須」はリクエストで省略できない項目です
- 値の一覧が「今後増えることがある」項目は、知らない値を受けても処理が止まらないようにしてください
- 型が「`object`（項目は未掲載）」の応答は、項目の一覧をまだこの文書に載せていないものです

## サイト

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

## 同意の設定

- [GET /api/v1/consent_settings](https://okaeri.tech/developers/reference/consent-settings.md#getConsentSettings)　同意の設定の取得（`getConsentSettings`）

## キャンペーン

- [GET /api/v1/campaigns](https://okaeri.tech/developers/reference/campaigns.md#listCampaigns)　キャンペーンの一覧（`listCampaigns`）
- [POST /api/v1/campaigns](https://okaeri.tech/developers/reference/campaigns.md#createCampaign)　キャンペーンの作成（`createCampaign`）
- [GET /api/v1/campaigns/{campaign_id}](https://okaeri.tech/developers/reference/campaigns.md#getCampaign)　キャンペーンの取得（`getCampaign`）
- [PATCH /api/v1/campaigns/{campaign_id}](https://okaeri.tech/developers/reference/campaigns.md#updateCampaign)　キャンペーンの更新（`updateCampaign`）
- [PUT /api/v1/campaigns/{campaign_id}/url-rules](https://okaeri.tech/developers/reference/campaigns.md#replaceCampaignUrlRules)　キャンペーンの URL ルールの置き換え（`replaceCampaignUrlRules`）
- [PUT /api/v1/campaigns/{campaign_id}/form-profile](https://okaeri.tech/developers/reference/campaigns.md#replaceCampaignFormProfile)　キャンペーンのフォーム項目の置き換え（`replaceCampaignFormProfile`）
- [POST /api/v1/campaigns/{campaign_id}/duplicate](https://okaeri.tech/developers/reference/campaigns.md#duplicateCampaign)　キャンペーンの複製（`duplicateCampaign`）

## シナリオ

- [GET /api/v1/campaigns/{campaign_id}/scenarios](https://okaeri.tech/developers/reference/scenarios.md#listCampaignScenarios)　キャンペーンのシナリオの一覧（`listCampaignScenarios`）
- [POST /api/v1/campaigns/{campaign_id}/scenarios](https://okaeri.tech/developers/reference/scenarios.md#createCampaignScenario)　シナリオの作成（`createCampaignScenario`）
- [GET /api/v1/scenarios/{scenario_id}](https://okaeri.tech/developers/reference/scenarios.md#getScenario)　シナリオの取得（`getScenario`）
- [PATCH /api/v1/scenarios/{scenario_id}](https://okaeri.tech/developers/reference/scenarios.md#updateScenario)　シナリオの更新（`updateScenario`）
- [DELETE /api/v1/scenarios/{scenario_id}](https://okaeri.tech/developers/reference/scenarios.md#deleteScenario)　シナリオの削除（`deleteScenario`）
- [PUT /api/v1/scenarios/{scenario_id}/steps](https://okaeri.tech/developers/reference/scenarios.md#replaceScenarioSteps)　シナリオのステップの置き換え（`replaceScenarioSteps`）
- [GET /api/v1/scenario_presets](https://okaeri.tech/developers/reference/scenarios.md#listScenarioPresets)　シナリオのテンプレートの一覧（`listScenarioPresets`）
- [POST /api/v1/campaigns/{campaign_id}/scenarios/from_preset](https://okaeri.tech/developers/reference/scenarios.md#createCampaignScenarioFromPreset)　テンプレートからシナリオを作成（`createCampaignScenarioFromPreset`）
- [POST /api/v1/scenarios/{scenario_id}/duplicate](https://okaeri.tech/developers/reference/scenarios.md#duplicateScenario)　シナリオの複製（`duplicateScenario`）

## 文面

- [GET /api/v1/messages](https://okaeri.tech/developers/reference/messages.md#listMessages)　文面の一覧（`listMessages`）
- [POST /api/v1/messages](https://okaeri.tech/developers/reference/messages.md#createMessage)　文面の作成（`createMessage`）
- [GET /api/v1/messages/{message_id}](https://okaeri.tech/developers/reference/messages.md#getMessage)　文面の取得（`getMessage`）
- [PATCH /api/v1/messages/{message_id}](https://okaeri.tech/developers/reference/messages.md#updateMessage)　文面の更新（`updateMessage`）
- [DELETE /api/v1/messages/{message_id}](https://okaeri.tech/developers/reference/messages.md#deleteMessage)　文面の削除（`deleteMessage`）
- [POST /api/v1/messages/{message_id}/duplicate](https://okaeri.tech/developers/reference/messages.md#duplicateMessage)　文面の複製（`duplicateMessage`）
- [GET /api/v1/message_variables](https://okaeri.tech/developers/reference/messages.md#listMessageVariables)　文面で使える変数の一覧（`listMessageVariables`）
- [GET /api/v1/message_examples](https://okaeri.tech/developers/reference/messages.md#listMessageExamples)　文面の例文の一覧（`listMessageExamples`）
- [POST /api/v1/message_previews](https://okaeri.tech/developers/reference/messages.md#previewMessage)　文面のプレビュー（`previewMessage`）
- [POST /api/v1/messages/estimate](https://okaeri.tech/developers/reference/messages.md#estimateSmsSegments)　SMS の文字数と課金通数の見積（`estimateSmsSegments`）

## リード

- [GET /api/v1/leads](https://okaeri.tech/developers/reference/leads.md#listLeads)　リードの一覧（`listLeads`）
- [GET /api/v1/leads/{lead_id}](https://okaeri.tech/developers/reference/leads.md#getLead)　リードの取得（流入元・時系列つき）（`getLead`）

## 配信

- [GET /api/v1/deliveries](https://okaeri.tech/developers/reference/deliveries.md#listDeliveries)　配信の一覧（`listDeliveries`）
- [GET /api/v1/deliveries/{delivery_id}](https://okaeri.tech/developers/reference/deliveries.md#getDelivery)　配信の取得（`getDelivery`）

## 配信スイッチ

- [GET /api/v1/delivery_status](https://okaeri.tech/developers/reference/delivery-status.md#getDeliveryStatus)　配信スイッチの状態の取得（`getDeliveryStatus`）

## 除外リスト

- [GET /api/v1/suppressions](https://okaeri.tech/developers/reference/suppressions.md#listSuppressions)　除外リストの一覧（`listSuppressions`）
- [POST /api/v1/suppressions](https://okaeri.tech/developers/reference/suppressions.md#createSuppression)　除外リストへの登録（1件）（`createSuppression`）
- [DELETE /api/v1/suppressions/{suppression_id}](https://okaeri.tech/developers/reference/suppressions.md#deleteSuppression)　除外リストからの削除（`deleteSuppression`）

## レポート

- [GET /api/v1/reports/funnel](https://okaeri.tech/developers/reference/reports.md#getFunnelReport)　ファネルと指標のレポート（`getFunnelReport`）
- [GET /api/v1/reports/daily](https://okaeri.tech/developers/reference/reports.md#getDailyReport)　日次推移のレポート（`getDailyReport`）

## Webhook

- [GET /api/v1/webhook_endpoints](https://okaeri.tech/developers/reference/webhooks.md#listWebhookEndpoints)　Webhook 送信先の一覧（`listWebhookEndpoints`）
- [POST /api/v1/webhook_endpoints](https://okaeri.tech/developers/reference/webhooks.md#createWebhookEndpoint)　Webhook 送信先の作成（`createWebhookEndpoint`）
- [GET /api/v1/webhook_endpoints/{endpoint_id}](https://okaeri.tech/developers/reference/webhooks.md#getWebhookEndpoint)　Webhook 送信先の取得（`getWebhookEndpoint`）
- [DELETE /api/v1/webhook_endpoints/{endpoint_id}](https://okaeri.tech/developers/reference/webhooks.md#deleteWebhookEndpoint)　Webhook 送信先の削除（`deleteWebhookEndpoint`）
- [GET /api/v1/webhook_endpoints/{endpoint_id}/deliveries](https://okaeri.tech/developers/reference/webhooks.md#listWebhookEndpointDeliveries)　Webhook の送信ログの一覧（`listWebhookEndpointDeliveries`）
- [POST /api/v1/webhook_deliveries/{delivery_id}/redeliver](https://okaeri.tech/developers/reference/webhooks.md#redeliverWebhookDelivery)　Webhook の再送（`redeliverWebhookDelivery`）