Admin Dashboard

Generated admin dashboard operations.

GET/v1/admin/dashboard/reportRead 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_dashboard_report

Parameters

Name	In	Type
`timeZone`	query	`string`
`until`	query	`string`
`period`	query	`string`
`window`	query	`string`
`peoplePeriod`	query	`string`
`topPeriod`	query	`string`
`topKind`	query	`string`
`accountId`	query	`string`
`libraryId`	query	`string`
`media`	query	`string`
`q`	query	`string`
`sort`	query	`string`
`direction`	query	`string`
`topAccountId`	query	`string`
`peopleCursor`	query	`string`
`peopleLimit`	query	`string`
`tableCursor`	query	`string`
`tableLimit`	query	`string`

Responses

200Successapplication/json

Example

{
  "context": {
    "timeZone": "2026-10-18T19:30:00Z",
    "until": "string"
  },
  "history": {
    "buckets": [
      {
        "end": "string",
        "kinds": [
          {}
        ],
        "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"
  },
  "load": {
    "buckets": [
      {
        "end": "string",
        "partial": true,
        "start": "string"
      }
    ],
    "from": "string",
    "observedAt": 0,
    "period": "string",
    "series": {
      "key": [
        {
          "detail": "string",
          "status": "available",
          "t": 0,
          "v": 0
        }
      ]
    },
    "status": {
      "key": {
        "detail": "string",
        "status": "string",
        "value": 0
      }
    },
    "timeZone": "2026-10-18T19:30:00Z",
    "until": "string",
    "window": "string"
  },
  "people": {
    "buckets": [
      {
        "end": "string",
        "partial": true,
        "start": "string"
      }
    ],
    "from": "string",
    "items": [
      {
        "accountId": "id_8h2k4q",
        "kinds": [
          {}
        ],
        "plays": 0,
        "profiles": [
          "string"
        ],
        "username": "Fargo",
        "watchedMs": 1800000
      }
    ],
    "nextCursor": "eyJvIjoyMH0",
    "period": "string",
    "timeZone": "2026-10-18T19:30:00Z",
    "until": "string"
  },
  "summary": {
    "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
  },
  "table": {
    "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"
  },
  "topPlayed": {
    "buckets": [
      {
        "end": "string",
        "partial": true,
        "start": "string"
      }
    ],
    "from": "string",
    "items": [
      {
        "backdropRevision": "r12",
        "countUnit": "string",
        "itemId": "id_8h2k4q",
        "people": 0,
        "plays": 0,
        "posterRevision": "r12",
        "title": "Fargo"
      }
    ],
    "period": "string",
    "timeZone": "2026-10-18T19:30:00Z",
    "topKind": "string",
    "until": "string"
  }
}

Schema

contextobjectrequired
- timeZonestringrequired
- untilstringrequired
historyobjectrequired
- 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
loadobjectrequired
- bucketsarray of objectrequired
  - endstringrequired
  - partialbooleanrequired
  - startstringrequired
- fromstringrequired
- observedAtintegerrequired
- periodstringrequired
- seriesobjectrequired
  - detailstring
  - statusstringrequiredone of "available", "limited"
  - tintegerrequired
  - vnumberrequired
- statusobjectrequired
  - detailstring
  - statusstringrequired
  - valuenumberrequired
- timeZonestringrequired
- untilstringrequired
- windowstringrequired
peopleobjectrequired
- 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
summaryobjectrequired
- bucketsarray of objectrequired
  - endstringrequired
  - partialbooleanrequired
  - startstringrequired
- convertedintegerrequired
- fromstringrequired
- mostActivearray of objectrequired
  - namestringrequired
  - playsintegerrequired
- mostPlayedarray of objectrequired
  - namestringrequired
  - playsintegerrequired
- peopleintegerrequired
- periodstringrequired
- playsintegerrequired
- timeZonestringrequired
- untilstringrequired
- watchedMsintegerrequired
tableobjectrequired
- 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
topPlayedobjectrequired
- bucketsarray of objectrequired
  - endstringrequired
  - partialbooleanrequired
  - startstringrequired
- fromstringrequired
- itemsarray of objectrequired
  - backdropRevisionstring
  - countUnitstringrequired
  - itemIdstringrequired
  - peopleintegerrequired
  - playsintegerrequired
  - posterRevisionstring
  - titlestringrequired
- periodstringrequired
- timeZonestringrequired
- topKindstringrequired
- 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/dashboard/report" \
  -H "Authorization: Bearer $PORTICO_API_KEY"

GET/v1/admin/dashboard/statusRead qualified owner Dashboard alerts and tasksadmin

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_dashboard_status

Responses

200Successapplication/json

Example

{
  "alerts": [
    {
      "action": {
        "kind": "string",
        "target": "string"
      },
      "code": "string",
      "count": 0,
      "major": true,
      "params": {
        "key": "string"
      },
      "severity": "string"
    }
  ],
  "observedAt": "2026-10-18T19:30:00Z",
  "scans": [
    {
      "analyzed": 0,
      "current": "string",
      "discovered": 0,
      "kind": "string",
      "libraryId": "id_8h2k4q",
      "libraryName": "Fargo",
      "phase": "string",
      "total": 0
    }
  ],
  "tasks": {
    "count": 0,
    "items": [
      {
        "id": "id_8h2k4q",
        "kind": "string",
        "libraryId": "id_8h2k4q",
        "libraryName": "Fargo",
        "phase": "string",
        "processed": 0,
        "state": "string",
        "total": 0,
        "unit": "string"
      }
    ]
  }
}

Schema

alertsarray of objectrequired
- actionobjectrequired
  - kindstringrequired
  - targetstringrequired
- codestringrequired
- countinteger
- majorbooleanrequired
- paramsobjectrequired
- severitystringrequired
observedAtstringrequired
scansarray of objectrequired
- analyzedintegerrequired
- currentstring
- discoveredintegerrequired
- kindstringrequired
- libraryIdstringrequired
- libraryNamestringrequired
- phasestringrequired
- totalinteger
tasksobjectrequired
- countintegerrequired
- itemsarray of objectrequired
  - idstringrequired
  - kindstringrequired
  - libraryIdstring
  - libraryNamestring
  - phasestringrequired
  - processedinteger
  - statestringrequired
  - totalinteger
  - unitstring

defaultRequest refused or unavailableapplication/json

Example

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Schema

errorobjectrequired
- codestringrequired
- messagestringrequired

Error codesunauthorizednot_permittedinvalid_requestinternaldatabase_busy

Example request

curl -X GET "http://127.0.0.1:32500/v1/admin/dashboard/status" \
  -H "Authorization: Bearer $PORTICO_API_KEY"