Copy of Video Session List API

Query paginated video session rows for drill-down and root-cause analysis.

Returns a paginated list of individual video sessions. Use it for drill-down analysis and root-cause investigation.

Endpoint

GET /mm-apis/listsessions/{customerId}

This endpoint is exclusive to Video Analysis. There is no session-list endpoint for ad analytics.

Authenticate each request with X-API-Key.

Query parameters

Parameter	Type	Required	Default	Description
period	string	Yes	—	start=<epoch>,end=<epoch>
metrics	string	Yes	—	Lead with the metric under investigation. Include fields such as starttime, endtime, assetname, watchtime, and sessionid
aggby	string	Yes	sessionid	Must be sessionid
sessiontype	string	No	ended	ended or started
allstatus	integer	No	0	0 or 1
filter	string	No	—	Dimension-level filters
qoefilter	string	No	—	Metric-level session filters
orderby	string	No	—	Sort by metric
order	string	No	desc	asc or desc
limit	integer	No	1000	Max records per page
offset	integer	No	0	Pagination offset

Use any metric or dimension from Metric and Dimensions Dictionary as the first field in metrics. Then add the session fields you want returned.

Common session metrics

Metric	API value	Description
Startup time (sec)	latency	Time from play attempt to first frame rendered for this session
Rebuffering percentage (%)	cirrbufferingratio	Percentage of this session's watch time spent rebuffering
Buffering time percentage (%)	bufferingratio	Percentage of watch time in any buffering state
Playback score	qualityofexperience	QoE score from 0 to 100 for this individual session
Playtime (mins)	playdur	Total content viewing time for this session
CDN change rate	cdn_change_rate	Frequency of CDN switches during this session
Errors	errors	Number of errors that occur during this session
Fatal errors	fatalerrors	Number of fatal errors during this session

Common session dimensions

Standard session fields

Field	Description
starttime	Session start time in epoch seconds
endtime	Session end time in epoch seconds
assetname	Name of the video asset played
watchtime	Total session watch time in seconds
sessionid	MediaMelon unique session identifier
sourcetype	Streaming format, such as HLS, DASH, or MP4

Example requests

Sessions with highest startup delay

curl --request GET \
  --url 'https://smartsight3.mediamelon.com/mm-apis/listsessions/199493832?period=start=1775749962,end=1775836362&metrics=latency,starttime,endtime,assetname,watchtime,sessionid,sourcetype&aggby=sessionid&orderby=latency&order=desc&limit=25' \
  --header 'X-API-Key: <your-api-key>'

Sessions with severe buffering on Android

curl --request GET \
  --url 'https://smartsight3.mediamelon.com/mm-apis/listsessions/199493832?period=start=1775749962,end=1775836362&metrics=cirrbufferingratio,starttime,endtime,assetname,watchtime,sessionid,sourcetype&aggby=sessionid&filter=[platform=Android]&qoefilter=cirrbufferingratio>10&orderby=cirrbufferingratio&order=desc&limit=25' \
  --header 'X-API-Key: <your-api-key>'

Sessions for a specific subscriber

curl --request GET \
  --url 'https://smartsight3.mediamelon.com/mm-apis/listsessions/199493832?period=start=1775749962,end=1775836362&metrics=qualityofexperience,starttime,endtime,assetname,watchtime,sessionid,sourcetype&aggby=sessionid&filter=[subscriberid=user-12345]&orderby=starttime&order=desc' \
  --header 'X-API-Key: <your-api-key>'