Analytics API

API to retrieve information viewable on the analytics screen

Request Headers

Please refer here for request headers.

HTTP Request

GET https://ovp-s-api.smartstream.ne.jp/v1/merchants/:merchant_id/aggregations?

URL Parameters

Field	Type	Description	Example	Required
merchant_id	String	Merchant ID	nttsmc	Required

Query parameters

Field	Type	Description	Example
media_id	String	Media ID	*****
target	String	Type of information to retrieve	See table below
interval	String	Unit of retrieval period	See table below
group	String	Classification method for retrieved information	See table below
from	String	Retrieval start date and time	20180101000000
to	String	Retrieval end date and time	20181231235959

About retrieval method types (target)

Field	Description
play_count	Number of plays (count)
device_count	Number of devices
session_count	Number of sessions
play_time	Playback time (seconds)
average_play_time	Average playback time (seconds)
player_count	Number of player displays (count)
key_delivery_count	Number of DRM key retrievals (count)

If target is omitted, the default value play_count will be applied.

About retrieval period unit (interval)

Field	Description
month	Monthly
day	Daily
hour	Hourly
minute	Per minute

If interval is omitted, the default value day will be applied. Only DRM key retrieval count cannot be retrieved hourly or per minute.

About classification method of retrieved information (group)

Field	Description
all	Total
country	By country
player	By player
site	By site
device	By device
os	By OS
percentage	Percentage

Only DRM key retrieval count cannot be retrieved with options other than all.

Response

Field	Description
date	Target date and time
group	Classification of retrieved information

Response Example

HTTP/1.1 200 OK
{
  [
    {
      "date": "2018/12/01 14:34",
      "all": 10
    },
    {
      "date": "2018/12/01 14:35",
      "all": 12
    },
    ...
  ]
}