> ## Documentation Index > Fetch the complete documentation index at: https://docs.utage-system.com/llms.txt > Use this file to discover all available pages before exploring further. # 登録経路作成 > 登録経路を作成し、登録用の `url` を発行します。「登録経路」画面の追加と同じ内容を保存します。 `type`（種類）はメールの配信アカウントでは `mail`、LINE の配信アカウントでは `line` が既定で、他の値は指定できません（400 `bad_request`）。メール・LINE併用の配信アカウントでは必須です（省略すると 422）。 広告連携（`ads_setting_id`・`ads_event`）は省略するとコンバージョンを送信しません。`ads_event` は広告連携設定の `events` の `value` から選びます。 コンバージョンを送信するのは `type=line` の登録経路で LINE 登録されたときだけです。`type=mail` の登録経路に指定しても保存されるだけで送信されません（画面でも `type=mail` では広告連携の欄は表示されません）。 登録時のラベル自動付与（`auto_label_type`）は、この登録経路で登録された読者に、指定した名前のラベルを付与します。このシナリオの配信アカウントで同じ名前（完全一致）のラベルを探して付与し、無ければ新規に作成して付与します。 `POST` ``` https://api.utage-system.com/v1/accounts/{account_id}/scenarios/{scenario_id}/trackings ``` ## OpenAPI ````yaml POST /accounts/{account_id}/scenarios/{scenario_id}/trackings openapi: 3.0.3 info: title: UTAGE API description: > UTAGEのパブリックAPIです。ファネル、メール・LINE配信、会員サイト、イベント・予約、決済、メディアなどのリソースをプログラムから操作できます。 ## 認証 すべてのリクエストにAPIキーによるBearer認証が必要です（要素タイプ・LINEメッセージタイプ・配信条件タイプの参照エンドポイントを除く）。 ``` Authorization: Bearer {api_key} ``` APIキーはUTAGE管理画面から発行できます。APIキーが未指定・無効・無効化済みの場合、またはアカウントが利用停止中の場合は `401 Unauthorized`（`error.code` は `unauthorized`）が返されます。 ## レート制限 リクエスト数には以下の制限があります。表の値は既定値で、契約内容により異なる場合があります。 | 分間上限 | 日間上限 | |----------|----------| | 60リクエスト/分（APIキー単位・暦の1分ごと） | 10,000リクエスト/日（アカウント単位・暦日ごと） | レスポンスヘッダーで分間上限の窓が終わる時刻を確認できます（分間の残数と日間の残数はヘッダーに含まれません）。 | ヘッダー | 説明 | |----------|------| | X-RateLimit-Limit | 接続元IP単位でAPI全体に掛かる制限の上限値（APIキー単位の分間上限ではありません） | | X-RateLimit-Remaining | 接続元IP単位の制限の残りリクエスト数（分間上限の残数ではありません） | | X-RateLimit-Reset | APIキー単位の分間上限で、現在の1分間の窓が終わる（次の分が始まる）UNIXタイムスタンプ | 上限を超えた場合は `429 Too Many Requests`（`error.code` は `rate_limit_exceeded`）が返されます。日間上限の超過時は `X-RateLimit-Reset` が翌日0:00になります（`X-RateLimit-Limit` / `X-RateLimit-Remaining` は超過時も接続元IP単位の値です）。認証不要のエンドポイントと読者作成（`POST /accounts/{account_id}/scenarios/{scenario_id}/readers`、`POST /accounts/{account_id}/line/friends/{friend_id}/readers`）はレート制限の対象外で、`X-RateLimit-Reset` ヘッダーは付きません。 データを作成するAPIには、これとは別にAPI経由の作成件数の上限があります。超過時は `429` で `total_limit_exceeded` / `hourly_limit_exceeded` / `monthly_limit_exceeded` が返され、`details.resource_type` に対象のリソース種別が含まれます。 ## エラーレスポンス エラー時は以下の形式で返されます。 ```json { "error": { "code": "error_code", "message": "エラーメッセージ" } } ``` エラーの種類によっては `error.details` に補足情報（バリデーションの項目別エラー、`retry_after`、`resource_type` など）が含まれます。 version: '1.0' contact: name: UTAGE サポート servers: - url: https://api.utage-system.com/v1 description: UTAGE API security: - BearerAuth: [] tags: - name: ファネル description: ファネルの作成・更新・一覧取得 - name: ステップ description: ファネル内のステップの作成・更新・並び替え・一覧取得 - name: ページ description: ステップ内のページの作成・更新・取得・削除・一覧取得 - name: 配信アカウント description: 配信アカウントの作成・一覧取得 - name: シナリオ description: シナリオの作成・一覧取得 - name: メディア description: 動画・音声・通常メディアの一覧取得・アップロード・名称変更 - name: 要素タイプ description: ファネルページ・レッスン・HTMLメールの要素タイプ定義、LINEメッセージタイプ・配信条件タイプの取得（認証不要） - name: ファネル統計 description: ファネルの集計データ・登録者・登録経路の取得 - name: 配信メッセージ description: 配信メッセージの作成・更新・テスト送信・配信統計、置き換え文字の取得 - name: 読者 description: 読者の作成・更新・取得、ラベル・配信履歴・開封/クリック履歴の取得 - name: LINE description: LINE友だち・カスタム送信者・1対1チャット・テンプレート・テンプレートグループ・リッチメニュー・自動応答の操作 - name: ラベル・共通読者・登録経路 description: ラベル・共通読者・アクション・登録経路の操作 - name: 登録経路 description: ファネルの登録経路・登録経路グループの作成・取得・更新・削除 - name: ファネルアクション description: ファネルアクション（管理画面「アクション設定」）の作成・取得・更新・削除とアクショングループの一覧取得 - name: 登録フォーム・読者項目 description: 読者項目と登録フォーム項目の作成・更新・取得・削除・並び替え - name: 連携 description: Googleスプレッドシート連携アカウント・広告連携設定の一覧取得 - name: 会員サイト description: 会員サイトの一覧取得・作成・取得・更新・削除・並び替え - name: コース description: 会員サイト配下のコースの一覧取得・作成・取得・更新・削除・並び替え - name: コースグループ description: コースグループの一覧取得・作成・取得・更新・削除 - name: バンドル description: バンドル（受講生に開放するコース・コミュニティグループのセット）の一覧取得・作成・取得・更新・削除・並び替え - name: レッスン description: 会員サイトのレッスン・レッスングループの操作と、レッスンごと受講状況・受講完了者の取得 - name: 受講生 description: 会員サイトの受講生の作成・更新・取得・削除、受講状況・操作履歴の取得、コース・バンドルの登録受講生一覧 - name: 登録コース・コミュニティ description: 受講生のバンドル・単一コース・コミュニティグループへの登録の追加・更新・解除・一覧取得 - name: コミュニティグループ description: 会員サイトのコミュニティグループの一覧取得 - name: イベント description: イベント（セミナー・説明会、個別相談・個別予約）の一覧取得・作成・取得・更新・削除 - name: 日程 description: イベントの日程の一覧取得・作成・取得・更新・削除 - name: 日程設定 description: 個別相談・個別予約タイプのイベントの日程設定（開催する曜日・時間帯・特定日の開催設定・担当者・日程の表示期間）の取得・更新 - name: 申込フォーム・申込者項目 description: イベントの申込フォームの基本項目・申込者項目の取得・更新 - name: 申込者 description: イベントの申込者の一覧取得・詳細取得・更新 - name: イベントグループ description: イベントグループ（イベント一覧の「グループ管理」）の作成・更新・一覧取得・削除 - name: 担当者 description: 担当者（個別相談・個別予約の「担当者設定」）の作成・更新・一覧取得・削除と連携用リンクの発行・削除 - name: 商品 description: 商品の一覧取得・作成・取得・更新・削除・並び替え - name: 商品グループ description: 商品グループの一覧取得・作成・取得・更新・削除 - name: 商品詳細 description: 商品配下の商品詳細（価格・支払方法・決済代行会社・支払回数・購入後の動作・通知設定）の作成・更新・並び替え・取得・削除 - name: 売上 description: 売上の一覧・詳細取得、領収書・請求書設定の更新、銀行振込の入金反映、削除、月別・日別売上集計 paths: /accounts/{account_id}/scenarios/{scenario_id}/trackings: post: tags: - ラベル・共通読者・登録経路 summary: 登録経路作成 description: > 登録経路を作成し、登録用の `url` を発行します。「登録経路」画面の追加と同じ内容を保存します。 `type`（種類）はメールの配信アカウントでは `mail`、LINE の配信アカウントでは `line` が既定で、他の値は指定できません（400 `bad_request`）。メール・LINE併用の配信アカウントでは必須です（省略すると 422）。 広告連携（`ads_setting_id`・`ads_event`）は省略するとコンバージョンを送信しません。`ads_event` は広告連携設定の `events` の `value` から選びます。 コンバージョンを送信するのは `type=line` の登録経路で LINE 登録されたときだけです。`type=mail` の登録経路に指定しても保存されるだけで送信されません（画面でも `type=mail` では広告連携の欄は表示されません）。 登録時のラベル自動付与（`auto_label_type`）は、この登録経路で登録された読者に、指定した名前のラベルを付与します。このシナリオの配信アカウントで同じ名前（完全一致）のラベルを探して付与し、無ければ新規に作成して付与します。 operationId: createScenarioTracking parameters: - $ref: '#/components/parameters/AccountId' - name: scenario_id in: path required: true description: シナリオID schema: type: string requestBody: required: true content: application/json: schema: type: object required: - name properties: name: type: string maxLength: 255 description: 管理名称 type: type: string nullable: true enum: - mail - line description: >- 種類。`mail`=メールの登録フォーム、`line`=LINE 登録。メールの配信アカウントは `mail`、LINE の配信アカウントは `line` が既定で、メール・LINE併用の配信アカウントでは必須 tracking_group_id: type: string nullable: true description: 登録経路グループのID（登録経路グループ一覧で取得）。省略・null は未分類。存在しないIDは 422 ads_setting_id: type: string nullable: true description: >- 広告連携設定のID（`GET /ads-settings` で取得）。省略・null は連携しない。存在しないIDは 422。コンバージョンを送信するのは `type=line` の登録経路だけ（`type=mail` では保存されるだけで送信されない） ads_event: type: string maxLength: 255 nullable: true description: >- 広告連携で送信するイベント（広告連携設定の `events` の `value`。広告連携設定を指定しないときは `ViewContent` / `Lead` / `CompleteRegistration` / `Purchase` / `AddToCart`）。省略・null は未指定（コンバージョンを送信しない）。選択できない値は 422 auto_label_type: type: string nullable: true enum: - none - tracking_name - custom default: none description: >- 登録時のラベル自動付与。`none`=利用しない、`tracking_name`=管理名称と同じ名前のラベルを付与、`custom`=`auto_label_name` の名前のラベルを付与 auto_label_name: type: string maxLength: 255 nullable: true description: >- ラベル名。`auto_label_type=custom` のとき必須。それ以外では省略するか null（指定すると 422） responses: '201': description: 作成された登録経路 content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/ScenarioTracking' '400': description: 配信アカウントの種類で指定できない `type` を指定した content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: bad_request message: このアカウントでは種類にlineを指定できません '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '422': $ref: '#/components/responses/ValidationError' '429': $ref: '#/components/responses/RateLimitExceeded' components: parameters: AccountId: name: account_id in: path required: true description: 配信アカウントID schema: type: string schemas: ScenarioTracking: type: object properties: id: type: string description: 登録経路ID（tracking_id） name: type: string description: 管理名称 type: type: string enum: - mail - line description: '種類（mail: メール、line: LINE）' tracking_group_id: type: string nullable: true description: グループID（未分類の場合は null） ads_setting_id: type: string nullable: true description: 広告連携設定のID（連携しない場合は null） ads_event: type: string nullable: true description: 広告連携のイベント（未設定は null） auto_label_type: type: string enum: - none - tracking_name - custom description: >- 登録時のラベル自動付与（none: 利用しない、tracking_name: 管理名称と同じ名前のラベルを付与、custom: 指定した名前のラベルを付与） auto_label_name: type: string nullable: true description: 自動付与するラベル名（`auto_label_type=custom` のときのみ。それ以外は null） url: type: string description: 登録用URL created_at: type: string nullable: true description: 作成日時（Y-m-d H:i:s） updated_at: type: string nullable: true description: 更新日時（Y-m-d H:i:s） ErrorResponse: type: object properties: error: type: object properties: code: type: string description: エラーコード message: type: string description: エラーメッセージ details: type: object nullable: true description: >- エラーの補足情報（`retry_after` / `resource_type`、項目別のエラーメッセージ等）。エラー種別により含まれる場合があります。`422` の項目別エラーの値は通常はメッセージの配列ですが、会員サイト更新・コース更新の変更時だけ行う検証では文字列です。 responses: Unauthorized: description: 認証エラー。APIキーが未指定・無効・無効化済み、またはアカウントが利用停止中。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: unauthorized message: APIキーが無効です NotFound: description: 指定されたリソースが見つかりません（`error.code` は `not_found`。`message` は資源ごとに異なります）。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: not_found message: ページが見つかりません ValidationError: description: >- バリデーションエラー（`error.code` は `validation_error`）。`details` に項目ごとのエラーメッセージが入ります（項目に紐づかない検証では `details` なし）。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: validation_error message: 入力内容に誤りがあります details: name: - 管理用タイトルは必須です RateLimitExceeded: description: >- レート制限超過（`rate_limit_exceeded`）。`X-RateLimit-Reset` の時刻（`details.retry_after` がある場合はその日時）以降に再試行してください。 content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' example: error: code: rate_limit_exceeded message: レート制限を超過しました securitySchemes: BearerAuth: type: http scheme: bearer description: APIキーをBearerトークンとして指定 ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.