BaaS@rakuza ドキュメント

プッシュ配信履歴一覧取得API

プッシュ配信履歴を一覧取得する。

メソッド

POST

パス

/push/list

リクエストボディ

Name型概要
tenant_id(必須)文字列テナントID
※別途お渡しした内容をご利用ください。
contents.push_start_dte_from(必須)文字列配信開始日時（From）
※配信開始日時がFrom～Toの履歴を取得します。From～Toは最長3ヶ月です。
contents.push_start_dte_to(必須)文字列配信開始日時（To）
※配信開始日時がFrom～Toの履歴を取得します。From～Toは最長3ヶ月です。
contents.push_status文字列ステータス
0:配信予約、1:配信中、2:データ反映中、3:配信済、9:配信中止
※指定したステータスに一致する履歴に絞り込みます。
contents.push_type数値予約種別
1:管理画面、2:API
※指定した予約種別が含まれる履歴に絞り込みます。
※複数指定する場合は、,で区切ってください。
contents.push_title文字列プッシュタイトル
※指定したプッシュタイトルが部分一致する履歴に絞り込みます。
contents.push_message文字列プッシュメッセージ
※指定したプッシュメッセージが部分一致する履歴に絞り込みます。
contents.limit数値取得する件数の上限数
※最大1,000件です（デフォルトは最大値と同じ1,000件）。
contents.offset数値取得開始位置

レスポンスボディ

Name型概要
status(必須)文字列ステータスコード
message(必須)文字列実行メッセージ
contents.result_cnt数値取得した履歴の件数
contents.data配列結果の配列
contents.detail_message文字列、配列エラーメッセージ

レスポンスの例

{
  "status": "1001",
  "message": "正常終了",
  "contents": {
    "result_cnt": "1",
    "data": [
      {
        "push_no": 1,
        "push_title": "タイトル",
        "push_message": "メッセージ",
        "multilang_messages": {
          "push_title": {
            "en": "タイトル",
            "ja": "タイトル"
          },
          "push_messages": {
            "en": "メッセージ",
            "ja": "メッセージ"
          }
        },
        "push_target_cnt": 1,
        "push_start_dte": "2025-06-10 21:30:00",
        "push_url": "https://example.com/",
        "push_custom_vars": "{\"hoge\":\"fuga\"}",
        "badge_num": 1,
        "expiration_dte": null,
        "expiration_time": 60,
        "push_type": "2",
        "push_type_name": "API",
        "distributor": "AdminSDK(管理者権限)",
        "insert_dte": "2025-06-11 15:57:43",
        "process_start_dte": "2025-06-11 16:10:03",
        "process_end_dte": "2025-06-11 16:10:03",
        "push_status": "3",
        "push_status_name": "配信済み",
        "has_error": "1",
        "push_done_cnt": 0,
        "push_error_cnt": 0,
        "push_read_cnt": 0,
        "user_search_condition": {
          "sex_cd": "0001∀equal"
        }
      }
    ]
  }
}