配信一覧取得 API、フォーマット一覧取得 API

概要

配信済みのインフォメーションを含め、全てのインフォメーションを返却します。

URL

配信一覧取得 API

https://${POPINFO_HOST}/mapi/3.0/info/

フォーマット一覧取得 API

https://${POPINFO_HOST}/mapi/3.0/draft/

メソッド

GET/POST

結果タイプ

複数を返却する

リクエストパラメータ

キー名	タイプ	説明
count	整数	参照したい配信の数
sort	文字列	次のうちのいずれかの文字列を指定 created_desc ... 新しい配信から順に返される(デフォルト) created_asc ... 古い配信から順に返される
page	整数	ページ番号
filter	object	詳細は後述

filter項目について

filterパラメータはベータ版です。予告なく仕様を変更する可能性がございます。

リクエストのサンプル

{
  "count": 5, 
  "sort": "created_asc", 
  "page": 3
}

filter による絞り込み

返却対象のインフォメーションを、指定された条件で絞り込みます。

Mongo Query Language のサブセットを条件指定に用います。また、Arrayとして、MQLを渡すことで、

mongo > db.info.find({...}).find({...})

へと展開されます。

利用可能なパラメーター名

name	型	説明
creator	文字列	インフォメーション作成者（ログインユーザー名）

利用可能なオペレーター

name	説明
$gt	より大きい・最近
$gte	より大きい・最近 (指定の値を含む)
$lt	より小さい・過去
$lte	より小さい・過去 (指定の値を含む)
$in	配列を取り、含まれるを表す。
$or	配列をとり、いずれかの条件とします。
$and	配列をとり、いずれもの条件とします。

レスポンス

キー名	タイプ	説明
page	整数	現在何ページ目を表示しているか
has_next	真偽値	次のページが存在するかどうか
total_results	整数	(現在は未使用。固定値で -1 を返却)
pages	整数	(現在は未使用。固定値で -1 を返却)
result	配列	以下参照

レスポンス(Result)

キー名	タイプ	表示条件	説明
id	整数	-	配信またはフォーマットのID
type	文字列	-	次のうちいずれかの文字列 instant ... 即時送信 scheduled ... 予約送信 location ... 位置連動型送信 wifi ... wifi連動型送信 bluetooth ... bluetooth連動型送信 continual ... 継続配信
content_type	文字列	-	text/plain ... テキスト配信 text/html ... HTML配信
platform	配列	-	配信対象のプラットフォーム iphone, androidのいずれか、もしくは両方
popup	文字列	-	ポップアップフリーワード。入稿時、popup_itemsでポップアップフリーワードを設定した際は、bodyキーの値が返される。 delivery_typeを3にした場合、空文字が返される。
title	文字列	-	件名。delivery_typeを2にした場合、空文字が返される。
content	文字列	-	本文。delivery_typeを2にした場合、空文字が返される。
delivery_type	整数	-	1 ... プッシュ通知/お知らせ表示利用 2 ... プッシュ通知のみ利用 3 ... お知らせ通知のみ利用
url	文字列	-	リンク先URL
category	文字列	-	カテゴリー
canceled	bool値	-	配信がキャンセルされたか否か
send_time	文字列	typeがscheduled、もしくは配信情報取得APIでのtypeがinstant	送信日時 (日本時間) ※ yyyy-mm-dd HH:MM:SS フォーマット
period	配列	typeが location, wifi, bluetooth, continualの場合	配信期間次の値を持つオブジェクトの配列 start ... 開始日時、JST(文字列) end ... 終了日時、JST(文字列)
status	文字列	配信情報取得API	finished ... 配信完了 canceled ... 配信キャンセル delivering ... 配信中
info_status	文字列	配信情報取得API	typeとstatusから生成される文字列次のルールに従って返される文字列 (予約
sent	object	配信情報取得API	配信人数 iphone, android, totalを持つオブジェクト iphone, android のうち配信対象のプラットフォームに含まれないものは、キー自体が返されません。また、個別集計が未対応の場合または仕様上人数を把握できない場合は、-1 が返されます
open	object	配信情報取得API	開封数オブジェクトの形式は sent と同じ
view	object	配信情報取得API	閲覧数オブジェクトの形式は sent と同じ
click	object	配信情報取得API	サイト閲覧数オブジェクトの形式は sent と同じ

レスポンスのサンプル

{
  "status": "OK",
  "result": [
    {
      "category": "カテゴリー",
      "status": "finished",
      "popup": "ポップアップ文字列",
      "title": "件名",
      "url": "http://google.com",
      "open": {
        "android": 1,
        "total": 2,
        "iphone": 1
      },
      "canceled": false,
      "click": {
        "android": 1,
        "total": 2,
        "iphone": 1
      },
      "content": "本文",
      "platform": [
        "iphone",
        "android"
      ],
      "info_status": "送信済み",
      "content_type": "text/plain",
      "send_time": "2016-02-24 03:41:20",
      "type": "instant",
      "id": 11,
      "sent": {
        "android": 36,
        "total": 72,
        "iphone": 36
      },
      "view": {
        "android": 1,
        "total": 2,
        "iphone": 1
      }
    }
  ],
  "page": 3,
  "has_next": true,
  "total_results": -1,
  "pages": -1
}

参照可能データ期間について

本APIで参照が保証できる配信情報は、登録日から1年以内の配信となります。 1年を経過した配信に対する本APIのレスポンスは、保証されません。 1年以上経過した配信を参照したい場合は、サポートまでお問い合わせください。