Admin Play History
Generated admin play history operations.
GET/v1/admin/play-historyRead or update the selected projectionadmin
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the admin scope, or a signed-in session
- OpenAPI operation ID
get_admin_play_history
Parameters
| Name | In | Type | Description |
|---|---|---|---|
accountId | query | string | |
libraryId | query | string | |
period | query | string | |
cursor | query | string | |
limit | query | integer | ""1–200 | |
media | query | string | |
q | query | string | |
sort | query | string | |
direction | query | string | |
timeZone | query | string | |
until | query | string |
Responses
200Successapplication/json
Example
{
"buckets": [
{
"end": "string",
"partial": true,
"start": "string"
}
],
"entries": [
{
"accountId": "id_8h2k4q",
"completed": true,
"device": "string",
"durationMs": 1800000,
"episode": 0,
"id": "id_8h2k4q",
"itemId": "id_8h2k4q",
"kind": "string",
"libraryId": "id_8h2k4q",
"location": "string",
"parentTitle": "Fargo",
"platform": "string",
"positionMs": 1800000,
"profile": "string",
"season": 0,
"startedAt": "2026-10-18T19:30:00Z",
"title": "Fargo",
"user": "string",
"watchedMs": 1800000
}
],
"from": "string",
"nextCursor": "eyJvIjoyMH0",
"period": "string",
"timeZone": "2026-10-18T19:30:00Z",
"total": 0,
"until": "string"
}Schema
bucketsarray of objectrequired
- endstringrequired
- partialbooleanrequired
- startstringrequired
entriesarray of objectrequired
- accountIdstringrequired
- completedbooleanrequired
- devicestring
- durationMsintegerrequired≥ 0
- episodeinteger
- idstringrequired
- itemIdstring
- kindstringrequired
- libraryIdstringrequired
- locationstringrequired
- parentTitlestring
- platformstring
- positionMsintegerrequired≥ 0
- profilestring
- seasoninteger
- startedAtstringrequired
- titlestringrequired
- userstringrequired
- watchedMsintegerrequired
- fromstringrequired
- nextCursorstringrequired
- periodstringrequired
- timeZonestringrequired
- totalinteger
- untilstringrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/admin/play-history" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/admin/play-history/dashboardRead owner Dashboard analyticsadmin
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the admin scope, or a signed-in session
- OpenAPI operation ID
get_admin_play_history_dashboard
Parameters
| Name | In | Type | Description |
|---|---|---|---|
period | query | string | |
accountId | query | string | |
libraryId | query | string | |
media | query | string | |
q | query | string | |
cursor | query | string | |
limit | query | integer | ""1–100 | |
topKind | query | string | |
timeZone | query | string | |
until | query | string |
Responses
200Successapplication/json
Example
{
"buckets": [
{
"end": "string",
"kinds": [
{
"kind": "string",
"plays": 0,
"watchedMs": 1800000
}
],
"partial": true,
"start": "string"
}
],
"busiestTimes": [
[
0
]
],
"from": "string",
"period": "string",
"quietestStartHour": 0,
"timeZone": "2026-10-18T19:30:00Z",
"top": [
{
"backdropRevision": "r12",
"countUnit": "string",
"itemId": "id_8h2k4q",
"people": 0,
"plays": 0,
"posterRevision": "r12",
"title": "Fargo"
}
],
"topKind": "string",
"until": "string"
}Schema
bucketsarray of objectrequired0–1201 items
- endstringrequired
kindsarray of objectrequired
- kindstringrequired
- playsintegerrequired
- watchedMsintegerrequired
- partialbooleanrequired
- startstringrequired
- busiestTimesarray of array of integerrequired7–7 items
- fromstringrequired
- periodstringrequired
- quietestStartHourinteger | any | nullrequired
- timeZonestringrequired
toparray of objectrequired0–6 items
- backdropRevisionstring
- countUnitstringrequired
- itemIdstringrequired
- peopleintegerrequired
- playsintegerrequired
- posterRevisionstring
- titlestringrequired
- topKindstringrequired
- untilstringrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittedinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/admin/play-history/dashboard" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/admin/play-history/peopleRead owner Dashboard analyticsadmin
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the admin scope, or a signed-in session
- OpenAPI operation ID
get_admin_play_history_people
Parameters
| Name | In | Type | Description |
|---|---|---|---|
period | query | string | |
accountId | query | string | |
libraryId | query | string | |
media | query | string | |
q | query | string | |
cursor | query | string | |
limit | query | integer | ""1–100 | |
topKind | query | string | |
timeZone | query | string | |
until | query | string |
Responses
200Successapplication/json
Example
{
"buckets": [
{
"end": "string",
"partial": true,
"start": "string"
}
],
"from": "string",
"items": [
{
"accountId": "id_8h2k4q",
"kinds": [
{
"kind": "string",
"plays": 0,
"watchedMs": 1800000
}
],
"plays": 0,
"profiles": [
"string"
],
"username": "Fargo",
"watchedMs": 1800000
}
],
"nextCursor": "eyJvIjoyMH0",
"period": "string",
"timeZone": "2026-10-18T19:30:00Z",
"until": "string"
}Schema
bucketsarray of objectrequired
- endstringrequired
- partialbooleanrequired
- startstringrequired
- fromstringrequired
itemsarray of objectrequired0–100 items
- accountIdstringrequired
kindsarray of objectrequired
- kindstringrequired
- playsintegerrequired
- watchedMsintegerrequired
- playsintegerrequired
- profilesarray of stringrequired
- usernamestringrequired
- watchedMsintegerrequired
- nextCursorstringrequiredlength 0–512
- periodstringrequired
- timeZonestringrequired
- untilstringrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittedinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/admin/play-history/people" \
-H "Authorization: Bearer $PORTICO_API_KEY"GET/v1/admin/play-history/summaryRead or update the selected projectionadmin
- Audience
- Clients · Native API
- Authorization
- API key or personal access token with the admin scope, or a signed-in session
- OpenAPI operation ID
get_admin_play_history_summary
Parameters
| Name | In | Type | Description |
|---|---|---|---|
period | query | string | |
timeZone | query | string | |
until | query | string | |
accountId | query | string | |
libraryId | query | string | |
media | query | string | |
q | query | string |
Responses
200Successapplication/json
Example
{
"buckets": [
{
"end": "string",
"partial": true,
"start": "string"
}
],
"converted": 0,
"from": "string",
"mostActive": [
{
"name": "Fargo",
"plays": 0
}
],
"mostPlayed": [
{
"name": "Fargo",
"plays": 0
}
],
"people": 0,
"period": "string",
"plays": 0,
"timeZone": "2026-10-18T19:30:00Z",
"until": "string",
"watchedMs": 1800000
}Schema
bucketsarray of objectrequired
- endstringrequired
- partialbooleanrequired
- startstringrequired
- convertedintegerrequired
- fromstringrequired
mostActivearray of objectrequired
- namestringrequired
- playsintegerrequired
mostPlayedarray of objectrequired
- namestringrequired
- playsintegerrequired
- peopleintegerrequired
- periodstringrequired
- playsintegerrequired
- timeZonestringrequired
- untilstringrequired
- watchedMsintegerrequired
defaultRequest refused or unavailableapplication/json
Example
{
"error": {
"code": "string",
"message": "string"
}
}Schema
errorobjectrequired
- codestringrequired
- messagestringrequired
Error codesinvalid_requestunauthorizednot_permittednot_foundinternaldatabase_busy
Example request
curl -X GET "http://127.0.0.1:32500/v1/admin/play-history/summary" \
-H "Authorization: Bearer $PORTICO_API_KEY"No operations match that filter.