> ## 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. # ファネルアクション詳細取得 > ファネルアクションの詳細（動作 `details` を含む）を取得します。 `GET` ``` https://api.utage-system.com/v1/funnel-actions/{action_id} ``` ## OpenAPI ````yaml GET /funnel-actions/{action_id} 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: /funnel-actions/{action_id}: get: tags: - ファネルアクション summary: ファネルアクション詳細取得 description: ファネルアクションの詳細（動作 `details` を含む）を取得します。 operationId: getFunnelAction parameters: - $ref: '#/components/parameters/FunnelActionId' responses: '200': description: ファネルアクションの詳細 content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/FunnelAction' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/RateLimitExceeded' components: parameters: FunnelActionId: name: action_id in: path required: true description: ファネルアクションID schema: type: string schemas: FunnelAction: type: object description: ファネルアクション（管理画面「アクション設定」） properties: id: type: string description: ファネルアクションID（action_id） name: type: string description: 管理名称 action_group_id: type: string nullable: true description: アクショングループID（未分類の場合は null） is_archived: type: boolean description: アーカイブ済みか details: type: array description: 動作の配列（配列の順に実行） items: $ref: '#/components/schemas/FunnelActionDetail' created_at: type: string description: 作成日時（Y-m-d H:i:s） updated_at: type: string description: 更新日時（Y-m-d H:i:s） FunnelActionDetail: type: object description: > ファネルアクションの動作（`details` の要素）。`type` で種類を指定し、種類ごとに使う項目が異なります。種類に関係しない項目は無視されます。取得時は種類に関係する項目だけを返します（参照先が見つからない場合は null）。 - `webhook`（webhook）: `url`（必須）、`data`。登録者情報の置き換え文字を展開した `data` の name / value を、`url` に form 形式で POST します - `share_funnel`（ファネルの共有ライセンスを発行）/ `share_funnel_cancel`（ファネルの共有ライセンスを停止）: `funnel_id`（必須） - `bundle_course`（バンドルへ登録）/ `bundle_course_cancel`（バンドルを停止）: `bundle_course_id`（必須） - `subscription_cancel`（継続課金を停止）: `product_id`（必須） - `google_spreadsheet`（Googleスプレッドシートへ追記）: `spreadsheet_account_id`（必須）、`spreadsheet_url`（必須）、`spreadsheet_sheet_name`（新規に指定するときは必須）、`sheet`（1件以上必須）。`sheet` の value を配列の順にA列から1行として追記します。Googleスプレッドシート連携が無効な環境では指定できません（`400 bad_request`） 更新で取得した動作をそのまま送り返す場合、参照先（ファネル・バンドル・商品・Googleアカウント）の再検証は行いません。 required: - type properties: type: type: string enum: - webhook - share_funnel - share_funnel_cancel - bundle_course - bundle_course_cancel - subscription_cancel - google_spreadsheet example: scenario description: >- 動作の種類（webhook: webhook、share_funnel: ファネルの共有ライセンスを発行、share_funnel_cancel: ファネルの共有ライセンスを停止、bundle_course: バンドルへ登録、bundle_course_cancel: バンドルを停止、subscription_cancel: 継続課金を停止、google_spreadsheet: Googleスプレッドシートへ追記） url: type: string maxLength: 1024 description: '`webhook` の送信先URL（https で始まる有効なURL）' data: type: array maxItems: 100 description: >- `webhook` で送信するパラメータ（name / value ともに必須・255文字以内。value には登録者情報の置き換え文字を使えます） items: type: object properties: name: type: string maxLength: 255 description: パラメータ名 value: type: string maxLength: 255 description: 送信する値 funnel_id: type: string nullable: true description: >- `share_funnel` / `share_funnel_cancel` で共有するファネルのID。共有範囲が「ライセンス登録者のみに共有」のファネルだけ指定できます（`GET /funnels?share_source_only=true` で取得） bundle_course_id: type: string nullable: true description: >- `bundle_course` / `bundle_course_cancel` で登録・停止するバンドルのID（`GET /members/{site_id}/bundles` で取得） product_id: type: string nullable: true description: >- `subscription_cancel` で停止する継続課金の商品ID（`GET /products` で取得。継続課金の商品詳細を持つ商品だけ指定できます） spreadsheet_account_id: type: string nullable: true description: >- `google_spreadsheet` で使うGoogleアカウント（管理画面でGoogle連携したアカウント）のID（`GET /google-spreadsheet-accounts` で取得） spreadsheet_url: type: string nullable: true maxLength: 255 description: >- `google_spreadsheet` の書き込み先スプレッドシートのURL（`https://docs.google.com/spreadsheets/d/{ID}/edit` のように ID の直後に `/` を含む形式） spreadsheet_sheet_name: type: string nullable: true maxLength: 255 description: >- `google_spreadsheet` の書き込み先シートのタブ名。保存時にシートIDに変換され、取得時もタブ名で返します（Googleスプレッドシート連携が無効な環境、または Google に接続できない場合は null）。更新でGoogleアカウント・URLを変えない場合は省略すると現在のシートを維持します。該当するタブ名が無い場合は `422 validation_error` sheet: type: array maxItems: 100 description: '`google_spreadsheet` で書き込む列（1件以上。配列の順にA列から書き込み）' items: type: object properties: name: type: string nullable: true maxLength: 255 description: 列（管理用の列名。書き込み先の列の照合には使いません） value: type: string nullable: true maxLength: 255 description: 値（登録者・決済・ファネル・イベント情報の置き換え文字を使えます。空で空セル） 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: ページが見つかりません 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.