DMPメトリックス | Documentation

このAPI拡張機能により、DMPイベントに関連づけられているデータからカスタム指標を集計できます。

これは /dmp/traffic、/dmp/traffic/event、/dmp/traffic/custom の拡張です。DMPイベントのフィードとAPIを利用するには、対応するドキュメントをご覧ください。
現在、数値型のカスタムパラメータデータに限られます。/dmp/push に送られるイベントは下表のフィールドでカスタムパラメータの指定を上書きする必要があります。
type が number の値は集計された上位リストで表示されず、 type が string の値は指標で集計されないことにご注意ください。

名前	タイプ	必須	説明
`group`	String	Yes	パラメータ名。例：'campaign', 'adspace', 'creative'
`type`	String	No	パラメータの type。例： 'number' または 'string'。指標として使用されるアイテムには数値（number）を、上位リストとして使用されるアイテムには文字列（string）を使います
`item`	String or Number	Yes	パラメータの値。例：'"sale"'、 '0.32'、 '42'。フォーマットは指定された type と一致する必要があります。つまり、文字列は "42" 、数値は 42 を使用します

リクエスト

/dmp/traffic、 /dmp/traffic/event 、/dmp/traffic/custom の前述のパラメータに加え、集計する指標のリストを指定することができます。

名前	タイプ	必須	説明
metrics	Array of Object	No	集計する指標の配列

各指標を指定するオブジェクトは以下の通りです。

名前	タイプ	必須	説明
`metric`	String	Yes	指標のエイリアス（名）
`type`	String	Yes	この指標に使用されるデータの type で、現在は 'dmp-custom' に制限されています
`group`	String	Yes	この指標に使用されるデータの group名で、現在は数値に制限されています（文字列は数値結果に影響ありません）
`operation`	String	Yes	データに対して実行される operation のタイプで、現在は 'sum'、'min'、'max' に制限されています
`history`	Boolean	No	true の場合、その結果にはこのリクエストに対して指定された historyResolution/historyBuckets にしたがって、付与した指標に対する historyData が含まれます。 NOTE: history は /dmp/traffic に対してのみ 'true' をセットでき、 /dmp/traffic/event または /dmp/traffic/custom にはセットできません

レスポンス

data と historyData フィールドに加えて、結果としてレスポンスには集計した指標のリストが含まれます。

名前	タイプ	説明
`metrics`	Array of Object	集計した指標の配列

各指標の結果オブジェクトは以下のフィールドを含みます。

名前	タイプ	必須	説明
`metric`	String	No	指標のエイリアス（名）
`data`	Number	No	この指標の集計数
`historyData`	Number	Yes	この指標の集計履歴。リクエストされた時にのみ集計されます

例

$ python cx.py /dmp/traffic '{"siteId":"1234", "start":"-10m", "metrics":[{"metric":"total", "type":"dmp-custom", "group":"value", "operation":"sum", "history":true}]}'
{
  "metrics": [
    {
      "metric": "total", 
      "historyData": [
        0.0, 
        0.0, 
        197.29999685287476, 
        288.99999809265137, 
        395.9000024795532, 
        282.2999975681305, 
        21.0, 
        0.0, 
        0.0, 
        0.0
      ], 
      "data": 1185.4999949932098
    }
  ], 
  "start": 1425990250, 
  "stop": 1425990850, 
  "data": {
    "events": 127
  }
}

$ python cx.py /dmp/traffic/event '{"siteId":"1234", "start":"-10m", "metrics":[{"metric":"total", "type":"dmp-custom", "group":"value", "operation":"sum"}], "groups":["type"]}'
{
  "start": 1425990310, 
  "stop": 1425990910, 
  "groups": [
    {
      "items": [
        {
          "metrics": [
            {
              "metric": "total", 
              "data": 0.0
            }
          ], 
          "item": "conversion", 
          "data": {
            "events": 75
          }
        }, 
        {
          "metrics": [
            {
              "metric": "total", 
              "data": 1406.8999979496002
            }
          ], 
          "item": "impression", 
          "data": {
            "events": 56
          }
        }, 
        {
          "metrics": [
            {
              "metric": "total", 
              "data": 164.60000038146973
            }
          ], 
          "item": "click", 
          "data": {
            "events": 5
          }
        }
      ], 
      "group": "type"
    }
  ]
}

Last updated: January 24, 2022