logoドキュメント
AppPush
ドキュメントホーム
ユーザーガイド開発者ガイドデータとプライバシーベストプラクティス
検索
日本語
English
繁體中文
简体中文
日本語
ภาษาไทย
Español
ログイン
開発者ガイド / REST API / 統計 API

統計API

最新更新：2025-07-22

info これは統計APIの最新バージョンです。v4の主な改良点は以下の通りです：

  • アクセス認可にHTTP基本認証（HTTP Basic Authentication）を使用します。これにより、curlやブラウザプラグインなどの一般的なHTTPツールを使用してAPIリクエストを完了することができます。
  • プッシュコンテンツは完全にJSON形式を使用します。

概要

統計API v4はさまざまな統計データ照会機能を提供します。

認証

詳細については、REST API概要の認証方法を参照してください。

メッセージ統計

  • メッセージライフサイクルにおける各状態の統計データを照会します。
  • 各プッシュメッセージの統計データは最長で1か月間保存されます。

API URL

GET v4/status/detail

リクエスト例

curl -v https://pushapi-sgp.engagelab.com/v4/messages/details?message_ids=1613113584,1229760629 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" < GET /v4/messages/details?message_ids=1613113584,1229760629 HTTP/1.1 < Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
              
              curl -v https://pushapi-sgp.engagelab.com/v4/messages/details?message_ids=1613113584,1229760629 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

< GET /v4/messages/details?message_ids=1613113584,1229760629 HTTP/1.1
< Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
このコードブロックはフローティングウィンドウ内に表示されます

リクエストパラメータ

キーワード タイプ オプション 説明
message_ids String 必須
  • メッセージID。複数のmessage_idがある場合は、カンマ「,」で区切ります。
  • 最大100個のmessage_idをサポートします
    		•

    レスポンス例

    < HTTP/1.1 200 OK < Content-Type: application/json { "1229760629": { "targets": 11, "sent": 11, "delivered": 10, "impressions": 8, "clicks": 2, "sub": { "notification": {}, "message": {}, "live_activity": {}, "voip": {}, "inapp_message": {} }, "plan_id": "", "pushContent": {} }, "1613113584": { "targets": 11, "sent": 11, "delivered": 10, "impressions": 8, "clicks": 2, "sub": { "notification": { "target": 1600, "sent": 1440, "delivered": 1280, "impressions": 1120, "click": 0, "sub_android": { "engageLab_android": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "huawei": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "xiaomi": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "oppo": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "vivo": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "meizu": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "fcm": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "honor": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 } }, "sub_ios": { "engageLab_ios": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 }, "apns": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0 } } }, "message": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0, "sub_android": {}, "sub_ios": {} }, "live_activity": { "targets": 1, "sent": 1, "delivered": 1, "impressions": 0, "clicks": 0, "sub_ios": { "engageLab_ios": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "apns": { "targets": 1, "sent": 1, "delivered": 1, "impressions": 0, "clicks": 0 } } } }, "plan_id": "engageLab_notification", "pushContent": { "android": { "title": "push", "content": "hello, Push!" }, "ios": { "title": "ios", "content": "pushContent", "subtitle": "engageLab_push" } } }, "1613113554": { "targets": 2, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0, "sub": { "notification": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "message": { "targets": 100, "sent": 90, "delivered": 80, "impressions": 70, "clicks": 0, "sub_android": { "engageLab_android": { "targets": 1, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "huawei": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "xiaomi": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "oppo": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "vivo": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "meizu": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "fcm": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "honor": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 } }, "sub_ios": { "engageLab_ios": { "targets": 1, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "apns": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 } } }, "live_activity": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "voip": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 }, "inapp_message": { "targets": 0, "sent": 0, "delivered": 0, "impressions": 0, "clicks": 0 } }, "plan_id": "engageLab_msg", "pushContent": { "message": { "title": "msg", "content": "push" } } } }
                  
              < HTTP/1.1 200 OK
< Content-Type: application/json

{
    "1229760629": {
        "targets": 11,
        "sent": 11,
        "delivered": 10,
        "impressions": 8,
        "clicks": 2,
        "sub": {
            "notification": {},
            "message": {},
            "live_activity": {},
            "voip": {},
            "inapp_message": {}
        },
        "plan_id": "",
        "pushContent": {}
    },
    "1613113584": {
        "targets": 11,
        "sent": 11,
        "delivered": 10,
        "impressions": 8,
        "clicks": 2,
        "sub": {
            "notification": {
                "target": 1600,
                "sent": 1440,
                "delivered": 1280,
                "impressions": 1120,
                "click": 0,
                "sub_android": {
                    "engageLab_android": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "huawei": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "xiaomi": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "oppo": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "vivo": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "meizu": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "fcm": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "honor": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    }
                },
                "sub_ios": {
                    "engageLab_ios": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    },
                    "apns": {
                        "targets": 100,
                        "sent": 90,
                        "delivered": 80,
                        "impressions": 70,
                        "clicks": 0
                    }
                }
            },
            "message": {
                "targets": 100,
                "sent": 90,
                "delivered": 80,
                "impressions": 70,
                "clicks": 0,
                "sub_android": {},
                "sub_ios": {}
            },
            "live_activity": {
                "targets": 1,
                "sent": 1,
                "delivered": 1,
                "impressions": 0,
                "clicks": 0,
                "sub_ios": {
                    "engageLab_ios": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "apns": {
                        "targets": 1,
                        "sent": 1,
                        "delivered": 1,
                        "impressions": 0,
                        "clicks": 0
                    }
                }
            }
        },
        "plan_id": "engageLab_notification",
        "pushContent": {
            "android": {
                "title": "push",
                "content": "hello, Push!"
            },
            "ios": {
                "title": "ios",
                "content": "pushContent",
                "subtitle": "engageLab_push"
            }
        }
    },
    "1613113554": {
        "targets": 2,
        "sent": 0,
        "delivered": 0,
        "impressions": 0,
        "clicks": 0,
        "sub": {
            "notification": {
                "targets": 0,
                "sent": 0,
                "delivered": 0,
                "impressions": 0,
                "clicks": 0
            },
            "message": {
                "targets": 100,
                "sent": 90,
                "delivered": 80,
                "impressions": 70,
                "clicks": 0,
                "sub_android": {
                    "engageLab_android": {
                        "targets": 1,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "huawei": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "xiaomi": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "oppo": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "vivo": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "meizu": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "fcm": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "honor": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    }
                },
                "sub_ios": {
                    "engageLab_ios": {
                        "targets": 1,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    },
                    "apns": {
                        "targets": 0,
                        "sent": 0,
                        "delivered": 0,
                        "impressions": 0,
                        "clicks": 0
                    }
                }
            },
            "live_activity": {
                "targets": 0,
                "sent": 0,
                "delivered": 0,
                "impressions": 0,
                "clicks": 0
            },
            "voip": {
                "targets": 0,
                "sent": 0,
                "delivered": 0,
                "impressions": 0,
                "clicks": 0
            },
            "inapp_message": {
                "targets": 0,
                "sent": 0,
                "delivered": 0,
                "impressions": 0,
                "clicks": 0
            }
        },
        "plan_id": "engageLab_msg",
        "pushContent": {
            "message": {
                "title": "msg",
                "content": "push"
            }
        }
    }
}
    このコードブロックはフローティングウィンドウ内に表示されます

    レスポンスパラメータ

    成功レスポンスはJSONオブジェクトで、キーはmessage_idです。各メッセージには各フェーズのライフサイクル統計データが含まれています：

    | キーワード | タイプ | オプション | 意味 |

    キーワード タイプ オプション 意味
    targets Int64 必須 有効対象数。プッシュタスクの選択した対象オーディエンスを有効性フィルタリングした後の対象デバイス数。
    sent Int64 必須 送信数。有効対象デバイスのうち、Engagelabサーバーが正常に送信タスクを作成したデバイス数。
    delivered Int64 必須 配信数。通知メッセージが実際に配信されたデバイス数。5日後の配信はカウントされません。華為、魅族、iOSの場合は、精度を高めるためにコールバック設定が必要です。
    impressions Int64 必須 表示数。通知メッセージが正常に表示されたデバイス数。5日後の表示はカウントされません。
    clicks Int64 必須 クリック数。通知メッセージが正常に表示された後、ユーザーにクリックされた回数。5日後のクリックはカウントされません。
    sub Object 必須 統計データの詳細指標。以下の表を参照してください。
  • notification：通知バーメッセージタイプデータのサマリー統計。
  • message：カスタムメッセージデータのサマリー統計。
  • live_activity：リアルタイムアクティビティメッセージデータのサマリー統計。
  • voip：voipメッセージデータのサマリー統計。
    		•
    plan_id String 必須 プッシュ計画ID。メッセージが属するプッシュ計画タイプを識別します。
    pushContent Object 必須 プッシュコンテンツ詳細。さまざまなプラットフォームのプッシュコンテンツ情報を含みます：
    - android：Androidプラットフォームのプッシュコンテンツ（タイトル、コンテンツなどのフィールドを含む）
    - ios：iOSプラットフォームのプッシュコンテンツ（タイトル、コンテンツ、サブタイトルなどのフィールドを含む）
    - message：カスタムメッセージコンテンツ（タイトル、コンテンツなどのフィールドを含む）
    指標（indicator）
    キーワード タイプ オプション 説明
    sub_android Object オプション Androidプッシュチャネルのデータサマリーと統計
    engageLab_android Object オプション Android Engagelabチャネルのデータサマリーと統計
    huawei Object オプション 華為チャネルのデータサマリーと統計
    honor Object オプション 栄耀チャネルのデータサマリーと統計
    xiaomi Object オプション 小米チャネルのデータサマリーと統計
    oppo Object オプション OPPOチャネルのデータサマリーと統計
    vivo Object オプション vivoチャネルのデータサマリーと統計
    meizu Object オプション 魅族チャネルのデータサマリーと統計
    fcm Object オプション FCMチャネルのデータサマリー統計
    sub_ios Object オプション Appleプッシュチャネルのデータサマリーと統計
    engageLab_ios Object オプション iOS Engagelabチャネルのデータサマリーと統計
    apns Object オプション iOS APNsチャネルのデータサマリー統計

    プッシュ計画統計

    • このインターフェースはプッシュ計画の詳細な統計指標を取得するために使用されます。指定された時間範囲内の複数の計画の全ライフサイクルデータ（多次元細分化指標（プラットフォーム/ベンダー/メッセージタイプ）を含む）の一括照会をサポートします。

    呼び出しアドレス

    GET v4/status/plan/detail

    リクエスト例

    GET /v4/status/plan/detail?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-07
                  
              GET /v4/status/plan/detail?plan_ids=push_20231101,push_20231102&start_date=2023-11-01&end_date=2023-11-07
    このコードブロックはフローティングウィンドウ内に表示されます

    リクエストパラメータ

    パラメータ名 タイプ 必須かどうか 説明
    plan_ids string はい プッシュ計画IDのリスト。複数のIDは英文カンマで区切ります。最大100個のIDをサポート。
    start_date string はい 統計開始日（形式：yyyy-MM-dd）。以下の条件を満たす必要があります：
  • 1. 終了日 >= 開始日
  • 2. 日付間隔 ≤ 31日
    		•
    end_date string はい 統計終了日（形式：yyyy-MM-dd）

    返却パラメータの説明

    成功レスポンス

    • 返されるオブジェクトはキー値ペア構造で、キー名はリクエストされたplan_idです。
    • 各plan_idに対応するオブジェクトには以下のフィールドが含まれています：
    パラメータ名 タイプ 説明
    targets int64 有効対象デバイス数（重複排除と有効性フィルタリング後の総デバイス数）
    sent int64 実際に送信タスクが作成されたデバイス数
    delivered int64 実際に配信されたデバイス数（5日以内のデータのみカウント）
    impressions int64 メッセージ表示数（5日以内のデータのみカウント）
    clicks int64 ユーザークリック数（5日以内のデータのみカウント）
    sub object メッセージタイプの細分化統計（構造は以下のサブテーブルを参照）

    • subオブジェクトの構造

      メッセージタイプ 説明 サブ構造
      notification 通知バーメッセージの統計 sub_android（Androidベンダー統計）/sub_ios（iOS統計）を含む
      message カスタムメッセージの統計 sub_android/sub_iosを含む
      live_activity ライブアクティビティメッセージの統計 sub_iosのみを含む
      voip VOIPメッセージの統計 sub_iosのみを含む

    • プラットフォームベンダー統計フィールド

      パラメータ名 タイプ 説明
      targets int64 対応するベンダーの有効対象デバイス数
      sent int64 ベンダーチャネルを通じた実際の送信数
      delivered int64 ベンダーチャネルを通じた実際の配信数
      impressions int64 ベンダーチャネルを通じた表示数
      clicks int64 ベンダーチャネルを通じたクリック数

    レスポンス例

    成功レスポンス

    { "push_20231101": { "targets": 1500, "sent": 1450, "delivered": 1400, "impressions": 1350, "clicks": 120, "sub": { "notification": { "sub_android": { "huawei": { "targets":200, "sent":190, "delivered":185, "impressions":180, "clicks":15 }, "xiaomi": { "targets":180, "sent":175, "delivered":170, "impressions":165, "clicks":10 } }, "sub_ios": { "apns": { "targets":300, "sent":295, "delivered":290, "impressions":285, "clicks":25 } } }, "live_activity": { "sub_ios": { "apns": { "targets":50, "sent":48, "delivered":45, "impressions":40, "clicks":5 } } } } } }
                  
              {
  "push_20231101": {
    "targets": 1500,
    "sent": 1450,
    "delivered": 1400,
    "impressions": 1350,
    "clicks": 120,
    "sub": {
      "notification": {
        "sub_android": {
          "huawei": { "targets":200, "sent":190, "delivered":185, "impressions":180, "clicks":15 },
          "xiaomi": { "targets":180, "sent":175, "delivered":170, "impressions":165, "clicks":10 }
        },
        "sub_ios": {
          "apns": { "targets":300, "sent":295, "delivered":290, "impressions":285, "clicks":25 }
        }
      },
      "live_activity": {
        "sub_ios": {
          "apns": { "targets":50, "sent":48, "delivered":45, "impressions":40, "clicks":5 }
        }
      }
    }
  }
}
    このコードブロックはフローティングウィンドウ内に表示されます

    失敗レスポンス

    { "error": { "code": 21003, "message": "Parameter value is invalid" } }
                  
              {
  "error": {
    "code": 21003,
    "message": "Parameter value is invalid"
  }
}
    このコードブロックはフローティングウィンドウ内に表示されます

    ユーザー統計

    • 過去2か月間の特定期間のユーザー関連統計データを提供します：新規ユーザー、オンラインユーザー、アクティブユーザーを含みます。
    • 時間単位：HOUR（時間）、DAY（日）、MONTH（月）。

    リクエストAPI URL

    GET v4/status/users

    リクエスト例

    curl -v https://pushapi-sgp.engagelab.com/v4/status/users?time_unit=DAY&start=2014-06-10&duration=3 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" < GET /v4/users?time_unit=DAY&start=2014-06-10&duration=3 HTTP/1.1 < Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
                  
              curl -v https://pushapi-sgp.engagelab.com/v4/status/users?time_unit=DAY&start=2014-06-10&duration=3 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

< GET /v4/users?time_unit=DAY&start=2014-06-10&duration=3 HTTP/1.1
< Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
    このコードブロックはフローティングウィンドウ内に表示されます

    リクエストパラメータ

    キーワード タイプ オプション 説明
    time_unit String 必須 時間単位：
  • HOUR（時間）
  • DAY（日）
  • MONTH（月）
    		•
    start String 必須 開始時間
  • 単位が時間の場合は、開始時間は時間単位（日を含み、2桁未満の場合は0を埋める）。形式例：2022-06-11 09
  • 単位が日の場合は、開始時間は日付（日）。形式例：2022-06-11
  • 単位が月の場合は、開始時間は日付（月）。形式例：2022-06
    		•
    duration String 必須 期間
  • 単位が日の場合は連続した日数です。他の単位も同様です。
  • 60日以内のユーザー情報のみ照会できます。時間単位がHOURの場合は、当日の統計結果のみ出力できます。
    		•

    レスポンス例

    < HTTP/1.1 200 OK < Content-Type: application/json { "time_unit": "DAY", "start": "2014-06-10", "duration": 3, "items": [{ "time": "2014-06-12", "android": { "new": 1, "active": 1, "online": 2 }, "ios": { "new": 1, "active": 1, "online": 2 } }] }
                  
              < HTTP/1.1 200 OK
< Content-Type: application/json
{
    "time_unit": "DAY",
    "start": "2014-06-10",
    "duration": 3,
    "items": [{
        "time": "2014-06-12",
        "android": {
      "new": 1,
            "active": 1,
            "online": 2
        },
    "ios": {
      "new": 1,
            "active": 1,
            "online": 2
        }
    }]
}
    このコードブロックはフローティングウィンドウ内に表示されます

    レスポンスパラメータ

    成功レスポンスはJSONオブジェクトです：

    キーワード タイプ オプション 説明
    time_unit String 必須 時間単位
  • HOUR（時間）
  • DAY（日）
  • MONTH（月）
    		•
    start String 必須 開始時間。
  • 単位が時間の場合は、開始時間は時間単位（日を含み、2桁未満の場合は0を埋める）。形式例：2022-06-11 09
  • 単位が日の場合は、開始時間は日付（日）。形式例：2022-06-11
  • 単位が月の場合は、開始時間は日付（月）。形式例：2022-06
    		•
    duration String 必須 期間
  • 単位が日の場合は連続した日数です。他の単位も同様です。
  • 60日以内のユーザー情報のみ照会できます。時間単位がHOURの場合は、当日の統計結果のみ出力できます。
    		•
    items JSON配列 必須 期間内の統計結果、期間ごとに区切られています
    • itemsフィールドの説明：
      • android：Androidプラットフォームのデータサマリー統計。
      • ios：Appleプラットフォームのデータサマリーと統計。
    キーワード タイプ オプション 説明
    new Int64 オプション 新規ユーザー
    active Int64 オプション アクティブユーザー

    メッセージライフサイクル状態の照会

    • message_idの下の対応するデバイスのメッセージライフサイクル状態を照会します。
    • 各プッシュメッセージの統計データは最長で1か月間保存されます。

    リクエストAPI URL

    GET v4/status/message

    リクエスト例

    curl -v https://pushapi-sgp.engagelab.com/v4/status/message?message_id=1613113584&registration_ids=1507bfd3a7c568d4761,1618cfd3a7c568d4761,17259fd3a7c568d4371 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1" < GET /v4/status?message_id=1613113584&registration_ids=1507bfd3a7c568d4761,1618cfd3a7c568d4761,17259fd3a7c568d4371 HTTP/1.1 < Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
                  
              curl -v https://pushapi-sgp.engagelab.com/v4/status/message?message_id=1613113584&registration_ids=1507bfd3a7c568d4761,1618cfd3a7c568d4761,17259fd3a7c568d4371 -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d1"

< GET /v4/status?message_id=1613113584&registration_ids=1507bfd3a7c568d4761,1618cfd3a7c568d4761,17259fd3a7c568d4371 HTTP/1.1
< Authorization: Basic N2Q0MzFlNDJkZmE2YTZkNjkzYWMyZDA0OjVlOTg3YWM2ZDJlMDRkOTVhOWQ4ZjBkMQ==
    このコードブロックはフローティングウィンドウ内に表示されます

    リクエストパラメータ

    キーワード タイプ オプション 説明
    message_id String 必須 メッセージID
    registration_ids String 必須
  • デバイスID。複数のregistration_idsがある場合は、カンマ「,」で区切ります。
  • 最大1000個のregistration_idsをサポートします
    		•

    レスポンス例

    < HTTP/1.1 200 OK < Content-Type: application/json { "1507bfd3a7c568d4761": { "status": "plan" }, "1618cfd3a7c568d4761": { "error_message": "The `registration_id` does not belong to the appkey" }, "17259fd3a7c568d4371": { "error_message": "internal error" }, "17259fd3a7c568d4xxx":{ "error_message": "regid illegal" } }
                  
              < HTTP/1.1 200 OK
< Content-Type: application/json
{
    "1507bfd3a7c568d4761": {
        "status": "plan"
    },
    "1618cfd3a7c568d4761": {
        "error_message": "The  `registration_id` does not belong to the appkey"
    },
    "17259fd3a7c568d4371": {
        "error_message": "internal error"
    },
    "17259fd3a7c568d4xxx":{
        "error_message": "regid illegal"  
    }
}
    このコードブロックはフローティングウィンドウ内に表示されます

    レスポンスパラメータ

    成功レスポンスはJSONオブジェクトで、このメッセージの下の各registration_idのメッセージの現在の状態を含んでいます。異常情報がある場合は、error_messageに含まれます。

    キーワード タイプ オプション 意味
    status String オプション 値の範囲：
  • plan：計画対象
  • target_valid：有効対象
  • target_invalid：無効対象
  • sent：送信済み
  • sent_failed：送信失敗
  • delivered：配信済み
  • delivered_failed：配信失敗
  • Impression：表示済み
  • click：クリック済み
    		•
    error_message String オプション エラー情報

    レスポンスコード

    HTTPステータスコード

    参照ドキュメント：HTTP-ステータスコード

    戻りコード

    コード 説明 詳細な説明 HTTPステータスコード
    0 成功 リクエスト成功 200
    21001 サポートされていないメソッドまたはURLエラー リクエストメソッド（GET/POST）エラーまたはURLエラー（インターフェースが存在しない） 404
    21003 パラメータ値が無効です 不正なパラメータ値 400
    23001 Basic認証に失敗しました HTTP基本認証に失敗しました 401
    23002 パラメータが不足しています！ 必要なパラメータが不足しています！ 400
    23004 time_unitの値がstartと一致しません！ time_unitとstartパラメータの値が一致しません 400
    23007 30日以内のmessage_idの照会のみをサポートしています！ 30日以内のメッセージのみ照会できます 400
    23100 サーバーエラー システム内部エラー 500
    27000 サーバー応答タイムアウト、後で再試行してください システム内部エラー 500
    27201 msgidが存在しないか、このアプリに属していません Msgidが存在しないか、このアプリに属していません 400
    icon
    お問い合わせ