---
title: "Stats API"
method: GET
path: "/stats"
tags: ["statistics"]
---

# Stats API

`GET /stats`

## Query parameters

- `type` string
- `fromDt` string
- `toDt` string
- `statDate` string
- `statId` string
- `displayId` integer
- `displayIds` integer[]
- `layoutId` integer[]
- `parentCampaignId` integer
- `mediaId` integer[]
- `campaignId` integer
- `returnDisplayLocalTime` boolean
- `returnDateFormat` string
- `embed` string

## Response `200`

successful operation

- StatisticsData[]
  - `type` string — Class Stats
  - `display` string
  - `displayId` integer
  - `layout` string
  - `layoutId` integer
  - `media` string
  - `mediaId` integer
  - `widgetId` integer
  - `scheduleId` integer
  - `numberPlays` integer
  - `duration` integer
  - `start` string
  - `end` string
  - `statDate` string
  - `tag` string

## Changes

- **2026-02-25** `41c04de98ec5` — 1 info
  - added the media type `application/json` for the response with the status `200`
- **2023-01-11** `c902f0bc774c` — 1 info
  - added the new optional `query` request parameter `parentCampaignId`
- **2020-09-02** `59a66c27e8e8` — 4 info
  - added the new optional `query` request parameter `displayIds`
  - added the new optional `query` request parameter `embed`
  - added the new optional `query` request parameter `returnDateFormat`
  - added the new optional `query` request parameter `returnDisplayLocalTime`
- **2020-02-17** `8e1275395104` — 1 breaking, 5 warning
  - removed the media type `application/json` for the response with the status `200`
  - deleted the `query` request parameter `displayIds`
  - deleted the `query` request parameter `embed`
  - deleted the `query` request parameter `parentCampaignId`
  - …2 more

[Change history](https://skmtc.dev/xibosignage/apis/xibo-api/changes/stats/get.md)

---

[API](https://skmtc.dev/xibosignage/apis/xibo-api.md) · [All operations](https://skmtc.dev/xibosignage/apis/xibo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/xibosignage/xibo-api/revisions/9136e3c2cb1d/schema)