ジャーニー統計
統計データを照会します。「ジャーニー全体統計」「メッセージ送信統計」「Webhook送信統計」が含まれます。
ユーザージャーニー統計
ジャーニーの「エントリー数、目標コンバージョン、早期退出、正常退出、進行中」のデータを照会できます。
エンドポイント
GET /v1/stats/journey
認証
EngageLab REST API は HTTP 基本認証 の認証方式を採用しています。HTTP Header に以下を追加してください：
Authorization: Basic ${base64_auth_string}
Authorization: Basic ${base64_auth_string}
このコードブロックはフローティングウィンドウ内に表示されます
上記 base64_auth_string の生成アルゴリズムは：base64(api_key:api_secret)
- Header 名は "Authorization"、値は base64 エンコードされた "username:password" ペア（間にコロンを含む）です。
- MA API のコンテキストでは、username が APIKey、password が APISecret です。API タイプのデータソースを追加して APIKey と API Secret を取得してください。
リクエスト例
curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
-H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
-H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
このコードブロックはフローティングウィンドウ内に表示されます
リクエストパラメータ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| journey_id | String | はい | ジャーニーID。複数IDはカンマ区切り、最大100件まで |
| time_unit | String | はい | 時間単位。HOUR（時間）と DAY（日）の2つの値を取ります |
| start_time | String | はい | 開始日時、形式は yyyy-MM-dd |
| end_time | String | はい | 終了日時、形式は yyyy-MM-dd- 終了日時 >= 開始日時 - 開始から終了までの期間は最長31日間です。 |
レスポンスパラメータ
| フィールド | 型 | 説明 |
|---|---|---|
| code | Integer | API呼び出しの成否。0は成功または一部成功、その他の値は失敗を示します |
| message | String | API呼び出し結果の説明。成功時は success |
| data | Array<Object> | 返される統計情報 |
| journey_id | Long | ジャーニーID |
| time_unit | String | 時間単位。HOUR（時間）と DAY（日）の2つの値を取ります |
| error_code | Int | ジャーニー統計情報の取得成否。0は成功、その他の値は失敗を示します |
| detail | Array<Object> | 時間別/日別の明細 |
| time | String | レスポンス内の統計日付。形式は yyyy-MM-dd、yyyy-MM-dd HH |
| entry_count | Long | エントリー数 |
| conversion_count | Long | コンバージョン数 |
| completion_count | Long | 正常退出数 |
| early_exit_count | Long | 早期退出数 |
| in_progress_count | Long | 進行中の数。end_time または time 時点でジャーニー内に留まっている数 |
すべて成功
{
"code": 0,
"message": "success",
"data": [
{
"journey_id":123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"time": "2026-05-28",
"entry_count": 312,
"conversion_count": 24,
"early_exit_count": 41,
"completion_count": 247,
"in_progress_count": 156
}
]
},
{
"journey_id":234,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"time": "2026-05-28",
"entry_count": 312,
"conversion_count": 24,
"early_exit_count": 41,
"completion_count": 247,
"in_progress_count": 156
}
]
}]
}
{
"code": 0,
"message": "success",
"data": [
{
"journey_id":123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"time": "2026-05-28",
"entry_count": 312,
"conversion_count": 24,
"early_exit_count": 41,
"completion_count": 247,
"in_progress_count": 156
}
]
},
{
"journey_id":234,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"time": "2026-05-28",
"entry_count": 312,
"conversion_count": 24,
"early_exit_count": 41,
"completion_count": 247,
"in_progress_count": 156
}
]
}]
}
このコードブロックはフローティングウィンドウ内に表示されます
すべて失敗
{
"code": 50219,
"message": "The number of JourneyIDs exceeds 100."
}
{
"code": 50219,
"message": "The number of JourneyIDs exceeds 100."
}
このコードブロックはフローティングウィンドウ内に表示されます
一部成功
{
"code": 0,
"message": "success",
"data": [
{
"journey_id": 123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"time": "2026-05-28",
"entry_count": 312,
"conversion_count": 24,
"early_exit_count": 41,
"completion_count": 247,
"in_progress_count": 156
}
]
},
{
"journey_id": -1,
"error_code": 50221
}]
}
{
"code": 0,
"message": "success",
"data": [
{
"journey_id": 123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"time": "2026-05-28",
"entry_count": 312,
"conversion_count": 24,
"early_exit_count": 41,
"completion_count": 247,
"in_progress_count": 156
}
]
},
{
"journey_id": -1,
"error_code": 50221
}]
}
このコードブロックはフローティングウィンドウ内に表示されます
メッセージ送信統計
ジャーニー内の各メッセージコンポーネントの「送信、到達、クリック」などのデータを照会できます。
エンドポイント
GET /v1/stats/journey/message
リクエスト例
curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/message?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
-H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/message?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
-H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
このコードブロックはフローティングウィンドウ内に表示されます
リクエストパラメータ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| journey_id | String | はい | ジャーニーID。複数IDはカンマ区切り、最大100件まで |
| time_unit | String | はい | 時間単位。HOUR（時間）と DAY（日）の2つの値を取ります |
| start_time | String | はい | 開始日時、形式は yyyy-MM-dd |
| end_time | String | はい | 終了日時、形式は yyyy-MM-dd- 終了日時 >= 開始日時 - 開始から終了までの期間は最長31日間です。 |
レスポンスパラメータ
| フィールド | 型 | 説明 |
|---|---|---|
| code | Integer | API呼び出しの成否。0は成功または一部成功、その他の値は失敗を示します |
| message | String | API呼び出し結果の説明。成功時は success |
| data | Array<Object> | 返される統計情報 |
| journey_id | Long | ジャーニーID |
| time_unit | String | 時間単位。HOUR（時間）と DAY（日）の2つの値を取ります |
| error_code | Int | ジャーニー統計情報の取得成否。0は成功、その他の値は失敗を示します |
| detail | Array<Object> | 時間別/日別の明細 |
| time | String | レスポンス内の統計日付。形式は yyyy-MM-dd、yyyy-MM-dd HH |
| component_id | Long | メッセージコンポーネントID |
| component_name | String | メッセージコンポーネント名。例：APP_PUSH_1、EMAIL_2 |
| channel | String | チャネル種別 |
| entry_count | Long | エントリー数 |
| plan_count | Long | 計画目標数 |
| send_count | Long | 送信数 |
| delivery_count | Long | 到達数 |
| impression_count | Long | 表示回数 |
| open_count | Long | 開封数 |
| click_count | Long | クリック数 |
| conversion_count | Long | コンバージョン数 |
| revenue_count | Long | 収益発生回数 |
| revenue_amount | Number | 収益金額合計 |
すべて成功
{
"code": 0,
"message": "success",
"data": [
{
"journey_id": 123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"component_id": 8801,
"component_name": "EMAIL_1",
"channel": "Email",
"time": "2026-05-28",
"entry_count": 320,
"plan_count": 312,
"send_count": 290,
"delivery_count": 270,
"impression_count": 198,
"open_count": 155,
"click_count": 24,
"conversion_count": 8,
"revenue_count": 7,
"revenue_amount": 488.50
},
{
"component_id": 8801,
"component_name": "EMAIL_1",
"channel": "Email",
"time": "2026-05-29",
"entry_count": 305,
"plan_count": 298,
"send_count": 280,
"delivery_count": 261,
"impression_count": 185,
"open_count": 144,
"click_count": 19,
"conversion_count": 6,
"revenue_count": 5,
"revenue_amount": 312.00
}
]
}
]
}
{
"code": 0,
"message": "success",
"data": [
{
"journey_id": 123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"component_id": 8801,
"component_name": "EMAIL_1",
"channel": "Email",
"time": "2026-05-28",
"entry_count": 320,
"plan_count": 312,
"send_count": 290,
"delivery_count": 270,
"impression_count": 198,
"open_count": 155,
"click_count": 24,
"conversion_count": 8,
"revenue_count": 7,
"revenue_amount": 488.50
},
{
"component_id": 8801,
"component_name": "EMAIL_1",
"channel": "Email",
"time": "2026-05-29",
"entry_count": 305,
"plan_count": 298,
"send_count": 280,
"delivery_count": 261,
"impression_count": 185,
"open_count": 144,
"click_count": 19,
"conversion_count": 6,
"revenue_count": 5,
"revenue_amount": 312.00
}
]
}
]
}
このコードブロックはフローティングウィンドウ内に表示されます
Webhook 送信統計
ジャーニー内の各 Webhook コンポーネントの「リクエスト、成功」などのデータを照会できます。
エンドポイント
GET /v1/stats/journey/webhook
リクエスト例
curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/webhook?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
-H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
curl -X GET 'https://ma-api.engagelab.com/v1/stats/journey/webhook?journey_id=123&time_unit=DAY&start_time=2026-06-01&end_time=2026-06-07' \
-H 'Authorization: Basic OTY0NDFlNGQ3MzIwN2E2NTE3YWJmYmJjOmFwaV9zZWNyZXRfeHh4'
このコードブロックはフローティングウィンドウ内に表示されます
リクエストパラメータ
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
| journey_id | String | はい | ジャーニーID。複数IDはカンマ区切り、最大100件まで |
| time_unit | String | はい | 時間単位。HOUR（時間）と DAY（日）の2つの値を取ります |
| start_time | String | はい | 開始日時、形式は yyyy-MM-dd |
| end_time | String | はい | 終了日時、形式は yyyy-MM-dd- 終了日時 >= 開始日時 - 開始から終了までの期間は最長31日間です。 |
レスポンスパラメータ
| フィールド | 型 | 説明 |
|---|---|---|
| code | Integer | API呼び出しの成否。0は成功または一部成功、その他の値は失敗を示します |
| message | String | API呼び出し結果の説明。成功時は success |
| data | Array<Object> | 返される統計情報 |
| journey_id | Long | ジャーニーID |
| time_unit | String | 時間単位。HOUR（時間）と DAY（日）の2つの値を取ります |
| error_code | Int | ジャーニー統計情報の取得成否。0は成功、その他の値は失敗を示します |
| detail | Array<Object> | 時間別/日別の明細 |
| time | String | レスポンス内の統計日付。形式は yyyy-MM-dd、yyyy-MM-dd HH |
| component_id | Long | WebhookコンポーネントID |
| component_name | String | Webhookコンポーネント名。例：WEBHOOK_1 |
| entry_count | Long | Webhookコンポーネントへのエントリー数 |
| send_count | Long | リクエスト成功数 |
| send_failure_count | Long | リクエスト失敗数 |
すべて成功
{
"code": 0,
"message": "success",
"data": [
{
"journey_id": 123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"component_id": 9001,
"component_name": "WEBHOOK_1",
"time": "2026-05-28",
"entry_count": 520,
"send_count": 498,
"send_failure_count": 22
},
{
"component_id": 9001,
"component_name": "WEBHOOK_1",
"time": "2026-05-29",
"entry_count": 610,
"send_count": 600,
"send_failure_count": 10
}
]
}
]
}
{
"code": 0,
"message": "success",
"data": [
{
"journey_id": 123,
"time_unit": "DAY",
"error_code": 0,
"detail": [
{
"component_id": 9001,
"component_name": "WEBHOOK_1",
"time": "2026-05-28",
"entry_count": 520,
"send_count": 498,
"send_failure_count": 22
},
{
"component_id": 9001,
"component_name": "WEBHOOK_1",
"time": "2026-05-29",
"entry_count": 610,
"send_count": 600,
"send_failure_count": 10
}
]
}
]
}
このコードブロックはフローティングウィンドウ内に表示されます
エラーコード
共通エラーコード
| HTTP ステータスコード | code | message | 説明 |
|---|---|---|---|
| 401 | 40050 | authorization invalid | 認証に失敗しました。 |
| 429 | 55110 | Too many requests, please try again later. | リクエスト頻度が上限を超えました。 |
| 400 | 40001 | httpパラメータが不正です | HTTP メッセージまたは必須の path/query パラメータが不正です。 |
| 400 | 40002 | ビジネスパラメータが不正です | パラメータの形式、列挙値、または型の検証に失敗しました。 |
| 400 | 50034 | プロジェクトが存在しません | APIKey に紐づくプロジェクトが存在しません。 |
| 500 | -1 | サーバー内部エラー | サービス例外。 |
ジャーニー統計エラーコード
| HTTP ステータスコード | code | message | 説明 |
|---|---|---|---|
| 400 | 50202 | Journey does not exist. | ジャーニーが存在しないか、現在のプロジェクトに属していません。 |
| 400 | 50217 | Invalid time range. | start_time > end_time、または照会期間が31日を超えています。 |
| 400 | 50219 | The number of JourneyIDs exceeds 100. | JourneyID の数が100件の上限を超えています。 |
| 400 | 50220 | Invalid time_unit. | time_unit の値が不正です。HOUR と DAY のみサポートされています。 |
| 400 | 50221 | Invalid journey_id format. | 単一の JourneyID の形式が不正です（error_code フィールドで特定のジャーニー照会失敗を示します）。 |
