ファネルツール - UTAGE API ドキュメント

概要

ファネル系ツールでは、ファネル（LP・セールスページ等のWebページ群）の作成・編集・削除を行えます。ファネルは以下の階層構造を持ちます。

ファネル
  └── ステップ
        └── ページ
              └── 要素（section > row > col > コンテンツ）

ファネル操作

funnel_list

ファネル一覧を取得します。名前で部分一致検索できます。 パラメータ:

パラメータ	型	必須	説明
`name`	string	-	ファネル名で部分一致検索
`page`	integer	-	ページ番号
`per_page`	integer	-	1ページあたりの件数

指示例:

「ファネル一覧を見せて」
「“セミナー”を含むファネルを検索して」

funnel_create

ファネルを新規作成します。作成後に funnel_step_create でステップ、funnel_page_create でページを追加します。 パラメータ:

パラメータ	型	必須	説明
`name`	string	必須	ファネル名（最大255文字）

指示例:

「“新商品LP”というファネルを作成して」

funnel_update

ファネルの名前・メモ・JavaScript設定を更新します。JS設定は全ページ共通で適用されます（HTML直接入力のページにも適用）。 パラメータ:

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID
`name`	string	-	ファネル名（最大255文字）
`memo`	string	-	メモ
`js_head`	string	-	headタグ内に挿入するJavaScript（GTMタグ等）
`js_body_top`	string	-	bodyタグ直後に挿入するJavaScript
`js_body`	string	-	body末尾に挿入するJavaScript

指示例:

「このファネルにGTMタグを設定して」

ステップ操作

funnel_step_list

ファネル配下のステップ一覧を取得します。各ステップの公開URL（step_url）を含みます。 パラメータ:

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID

指示例:

「このファネルのステップ一覧を見せて」
「ページのURLを確認したい」

funnel_step_create

ファネルにステップを新規作成します。ステップはページをグループ化する単位です。 パラメータ:

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID
`name`	string	必須	ステップ名（最大255文字）

指示例:

「“サンクスページ”というステップを追加して」

funnel_step_update

ステップ名を更新します。 パラメータ:

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID
`step_id`	string	必須	ステップID
`name`	string	-	ステップ名（最大255文字）

指示例:

「このステップ名を”オプトインページ”に変更して」

funnel_step_reorder

ステップの並び順を変更します。全ステップのIDを含める必要があります。 パラメータ:

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID
`step_ids`	array	必須	並び替え後のステップIDの配列（JSON文字列でも可）

指示例:

「ステップの順番を入れ替えて、サンクスページを最後にして」

ページ操作

funnel_page_list

ステップ配下のページ一覧を取得します。各ページの content_type、step_url、page_url を含みます。 パラメータ:

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID
`step_id`	string	必須	ステップID

指示例:

「このステップのページ一覧を見せて」

funnel_page_create

ページを新規作成します。content_type で要素構造（elements）またはHTML直接入力（raw_html）を選択できます。

主要パラメータ

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID
`step_id`	string	必須	ステップID
`title`	string	必須	管理名称
`content_type`	string	-	`elements`（デフォルト）または `raw_html`
`elements`	array	条件付き	要素配列（`content_type=elements` 時に必須）
`html_source`	string	条件付き	HTML文字列（`content_type=raw_html` 時に必須）
`page_title`	string	-	ブラウザのtitleタグ（`elements` のみ）
`pc_width`	integer	-	ページ幅(PC)（100=全幅、640-1200px）
`background_color`	string	-	背景色（`#RRGGBB`、全幅時のみ）

補足パラメータ

パラメータ	型	説明
`meta_title`	string	タイトル
`meta_description`	string	説明（最大500文字）
`meta_og_image`	string	OG画像(og:image)URL
`is_no_index`	integer	検索エンジン設定（0=許可、1=不許可）
`border_type`	string	ボーダー（`shadow`, `border`, `none`）
`swipe_type`	string	スワイプ（`none`, `vertical`, `horizontal`）
`background_image_src`	string	背景画像URL
`background_image_style`	string	背景画像スタイル
`js_head`	string	headタグ内JavaScript
`js_body_top`	string	body直後JavaScript
`js_body`	string	body末尾JavaScript
`css`	string	カスタムCSS
`is_high_speed_mode`	integer	高速表示モード（0=無効、1=有効）

ポップアップ関連パラメータ

パラメータ	型	説明
`use_popup`	integer	ポップアップ使用（0=無効、1=有効）
`popup_elements`	array	ポップアップ要素配列
`popup_action`	string	表示条件（`exit`, `exit_all`）
`popup_width`	integer	ポップアップ幅（600-1000px）
`popup_background_color`	string	ポップアップ背景色
`popup_vertical_align`	string	垂直配置（`top`, `centered`）

要素構造

content_type=elements の場合、ページは以下の階層構造で構成されます。

section          ← セクション（最上位）
  └── row        ← 行（横並びレイアウト）
        └── col  ← カラム（列）
              └── text, image, button, form ...  ← コンテンツ要素

[
  {
    "type": "section",
    "children": [
      {
        "type": "row",
        "children": [
          {
            "type": "col",
            "children": [
              {
                "type": "text",
                "content": "<p>テキストコンテンツ</p>"
              }
            ]
          }
        ]
      }
    ]
  }
]

使用可能な要素タイプとプロパティは、element_types_funnel と element_types_funnel_properties で取得できます。

pc_widthの注意点

設定値	動作	background_color
`640`-`1200`	コンテンツが中央配置、指定幅内に収まる	指定しない（崩れる）
`100`	要素がブラウザ全幅に広がる	必要に応じて指定（指定しないと左右が白くなる）

指示例:

「新しいLPページを作成して」
「HTMLで直接ページを作りたい」

funnel_page_get

ページの詳細情報を取得します。要素構造または html_source を含みます。 パラメータ:

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID
`step_id`	string	必須	ステップID
`page_id`	string	必須	ページID

指示例:

「このページの内容を見せて」
「ページの要素構造を確認したい」

ライセンス制のファネルのページでは403エラーが返ります。

funnel_page_update

ページを更新します。指定したフィールドのみ更新する部分更新です。未指定のフィールドは既存値が維持されます。

未指定のフィールドは既存値が維持されるため、変更したいフィールドのみ送信できます（nullに上書きされることはありません）。ただし elements / popup_elements は配列を指定した場合のみ、その内容で全置換されます（配列を指定しない場合は既存の要素が維持されます）。

パラメータ: funnel_page_create と同じパラメータに加えて、対象を特定する以下のパスパラメータが必須です。

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID
`step_id`	string	必須	ステップID
`page_id`	string	必須	ページID
`title`	string	任意	管理名称

注意事項:

content_type は作成後に変更できません

指示例:

「このページのヘッドラインを変更して」
「ページの背景色を変更して」

funnel_page_delete

ページを削除します。 パラメータ:

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID
`step_id`	string	必須	ステップID
`page_id`	string	必須	ページID

指示例:

「このページを削除して」

要素リファレンス

element_types_funnel

ページ構築に使える要素タイプの一覧を取得します。デフォルトは基本カテゴリ（layout, content, other）のみです。 パラメータ:

パラメータ	型	必須	説明
`include`	string	-	拡張カテゴリのカンマ区切り

includeの値:

値	説明	ユースケース
`form`	登録フォーム	LP・メルマガ登録・資料請求
`payment`	決済要素	商品販売ページ
`event`	イベント申込	説明会・セミナー・個別相談
`webinar`	自動ウェビナー	ウェビナーページ

// LP用のフォーム要素も含めて取得
include=form

// 決済とフォーム両方を取得
include=form,payment

指示例:

「使える要素の種類を見せて」
「フォーム要素を含めた要素一覧を取得して」

element_types_funnel_properties

指定した要素タイプのプロパティ定義を取得します。要素に設定可能なプロパティ（色・サイズ・配置等）の詳細仕様を返します。 パラメータ:

パラメータ	型	必須	説明
`types`	string	必須	要素タイプ名のカンマ区切り

// テキストとボタンのプロパティを取得
types=text,button

// 画像のプロパティを取得
types=image

レスポンス構造:

フィールド	説明
`global_common_properties`	全要素共通のプロパティ
`content_common_properties`	コンテンツ要素共通（padding, border, background）
`{type}.properties`	要素固有のプロパティ

指示例:

「ボタン要素で設定できるプロパティを教えて」
「テキスト要素と画像要素のプロパティ定義を取得して」

統計・登録者・登録経路

funnel_stats_get

ファネルの全体データを取得します。ステップ×ページ単位のPV・UU・登録数・登録率・売上件数・購入率・売上金額を集計します（管理画面「データ」画面と同等）。

**プレビュー機能。**仕様は今後変更される可能性があります。

パラメータ:

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID
`date_from`	string	-	集計開始日（YYYY-MM-DD）
`date_to`	string	-	集計終了日（YYYY-MM-DD）
`aggregation_method`	string	-	集計方法。`accrual_date`（発生日ベース、デフォルト）または `subscription_date`（初回登録日ベース）
`tracking_id`	string	-	登録経路IDで絞り込み
`utm_source`	string	-	UTMソースで絞り込み
`utm_medium`	string	-	UTMメディアで絞り込み
`utm_campaign`	string	-	UTMキャンペーンで絞り込み
`utm_term`	string	-	UTMタームで絞り込み
`utm_content`	string	-	UTMコンテンツで絞り込み

指示例:

「このファネルのデータを見せて」
「先月のファネル全体の登録率と売上を集計して」

funnel_stats_daily

ファネルの日ごとデータを取得します。指定ページの日別PV・UU・登録数・売上を集計します（管理画面「日ごとのデータ」画面と同等）。date_from／date_to 未指定時は直近7日間が対象です。

**プレビュー機能。**仕様は今後変更される可能性があります。

パラメータ:

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID
`page_ids`	string	-	対象ページIDのカンマ区切り。未指定時は全ページ
`date_from`	string	-	集計開始日（YYYY-MM-DD）
`date_to`	string	-	集計終了日（YYYY-MM-DD）
`aggregation_method`	string	-	集計方法。`accrual_date`（発生日ベース、デフォルト）または `subscription_date`（初回登録日ベース）
`tracking_id`	string	-	登録経路IDで絞り込み
`utm_source`	string	-	UTMソースで絞り込み
`utm_medium`	string	-	UTMメディアで絞り込み
`utm_campaign`	string	-	UTMキャンペーンで絞り込み
`utm_term`	string	-	UTMタームで絞り込み
`utm_content`	string	-	UTMコンテンツで絞り込み

指示例:

「このファネルの日ごとのデータを見せて」
「先週の日別の登録数の推移を教えて」

funnel_subscriber_list

ファネルの登録者（サブスクライバー）一覧を取得します。各ページのフォームから登録された氏名・連絡先・登録経路・UTM・登録日時を返します。

**プレビュー機能。**仕様は今後変更される可能性があります。

パラメータ:

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID
`step_id`	string	-	ステップIDで絞り込み
`page_id`	string	-	ページIDで絞り込み
`tracking_id`	string	-	登録経路IDで絞り込み
`mail`	string	-	メールアドレスで部分一致検索
`date_from`	string	-	登録日の開始（YYYY-MM-DD）
`date_to`	string	-	登録日の終了（YYYY-MM-DD）
`page`	integer	-	ページ番号（デフォルト1）
`per_page`	integer	-	1ページあたりの件数（デフォルト20、最大100）

指示例:

「このファネルの登録者一覧を見せて」
「特定のページから登録した人の連絡先を確認したい」

funnel_tracking_list

ファネルの登録経路一覧を取得します。メッセージの配信条件で登録経路ID（tracking_id）を指定する際に使用します。

**プレビュー機能。**仕様は今後変更される可能性があります。

パラメータ:

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID

指示例:

「このファネルの登録経路一覧を見せて」
「配信条件で使う登録経路ID（tracking_id）を調べたい」

funnel_tracking_stats

ファネルの登録経路別集計を取得します。登録経路ごとのPV・UU・登録数を返します（管理画面「登録経路分析」画面と同等）。

**プレビュー機能。**仕様は今後変更される可能性があります。

パラメータ:

パラメータ	型	必須	説明
`funnel_id`	string	必須	ファネルID
`date_from`	string	-	集計開始日（YYYY-MM-DD）
`date_to`	string	-	集計終了日（YYYY-MM-DD）

指示例:

「登録経路別のPVと登録数を見せて」
「どの流入経路が一番登録につながっているか教えて」

​概要

​ファネル操作

​funnel_list

​funnel_create

​funnel_update

​ステップ操作

​funnel_step_list

​funnel_step_create

​funnel_step_update

​funnel_step_reorder

​ページ操作

​funnel_page_list

​funnel_page_create

​主要パラメータ

​補足パラメータ

​ポップアップ関連パラメータ

​要素構造

​pc_widthの注意点

​funnel_page_get

​funnel_page_update

​funnel_page_delete

​要素リファレンス

​element_types_funnel

​element_types_funnel_properties

​統計・登録者・登録経路

​funnel_stats_get

​funnel_stats_daily

​funnel_subscriber_list

​funnel_tracking_list

​funnel_tracking_stats

概要

ファネル操作

funnel_list

funnel_create

funnel_update

ステップ操作

funnel_step_list

funnel_step_create

funnel_step_update

funnel_step_reorder

ページ操作

funnel_page_list

funnel_page_create

主要パラメータ

補足パラメータ

ポップアップ関連パラメータ

要素構造

pc_widthの注意点

funnel_page_get

funnel_page_update

funnel_page_delete

要素リファレンス

element_types_funnel

element_types_funnel_properties

統計・登録者・登録経路

funnel_stats_get

funnel_stats_daily

funnel_subscriber_list

funnel_tracking_list

funnel_tracking_stats