契約管理機能

配信実績取得

配信実績取得

指定された年月の配信実績情報を取得します。

補足説明 こちらのAPIは、権限が必要です。 権限がない場合は、カスタマーサポートデスクへお問い合わせください。

メソッドとURL

メソッド URL
GET https://{HOST名}/delivery_record

 

リクエスト

URLパラメーター

項目 説明
yearmonth yyyy-mm 取得対象の過去年月を指定します。 指定しない場合は当月の配信実績を返します。

レスポンス

ステータスコード

コード メッセージ 説明
200 OK リクエスト受付、正常終了。
400 Bad Request 構文不正。フォーマットやパラメーターの不正。
500 Internal Server Error 想定外のエラー。 しばらく経ってから再度実施し、状況が改善しなければ、弊社までお問い合わせください。

上記以外のステータスコードが返却される場合もあります。 その場合は、RFC2616規定のHTTPレスポンスステータスコード一覧をご確認ください。

HTTPレスポンスステータスコード一覧

ボディーパラメーター

JSON形式で取得されます。

項目 型 説明
total Number 全ユーザーの合計配信数
users Object Array ユーザー、日付ごとの配信数
user_id String ユーザーID
dates Object Array 日付ごとの配信数
date String 日付
count Number 配信数

 

サンプル

レスポンス

正常

{
  "total": 1000,
  "users": [
    {
      "user_id": "user1",
      "dates": [
        {
          "date": "20200101",
          "count": 300
        },
        {
          "date": "20200102",
          "count": 200
        }
      ]
    },
    {
      "user_id": "user2",
      "dates": [
        {
          "date": "20200103",
          "count": 100
        },
        {
          "date": "20200104",
          "count": 400
        }
      ]
    }
  ]
}

エラー

{
 "message": "Too Many Requests"
}

補足情報が返却されます。