---
title: "Gets device ping data by registration key."
method: GET
path: "/devices/{registrationKey}/pingdata"
tags: ["Devices"]
---

# Gets device ping data by registration key.

`GET /devices/{registrationKey}/pingdata`

## Request

- Base URL: `https://api.reveldigital.com`
- URL: `https://api.reveldigital.com/devices/{registrationKey}/pingdata`
- Auth: OAuth 2 and API key in header `X-RevelDigital-ApiKey` and API key in query parameter `api_key`
  - Authorization code: `https://id.reveldigital.com/connect/authorize`
  - Token URL: `https://id.reveldigital.com/connect/token` scopes: `webapi`
- TypeScript: <https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/docs/devices/:registrationKey/pingdata/get.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `registrationKey` string, required

## Response `200`

OK

- PingData
  - `type` string, nullable: Ping type
  - `snap` string, byte, nullable: Snapshot (screenshot) of live player content
  - `player_version` string, nullable: Player version number
  - `os_version` string, nullable: Player OS version
  - `cpu_usage` number, float: CPU usage (percentage) Value range [0, 100]
  - `memory_usage` number, float: Memory usage (percentage) Value range [0, 100]
  - `mac_address` string, nullable: MAC address of primary player network interface
  - `disk_usage` number, float: Disk usage (percentage) Value range [0, 100]
  - `timestamp` string, date-time: Timestamp of this ping. Device is considered offline if this timestamp is older than 10 minutes
  - `bytes_received` integer: Bytes recieved by this player
  - `transfer_rate` integer: Current transfer rate over the primary network interface
  - `ip_address` string, nullable: IP address of the primary network interface
  - `latitude` number, double, nullable: Current location of the player (latitude)
  - `longitude` number, double, nullable: Current location of the player (longitude)
  - `current_schedule` string, nullable: Currently running schedule
  - `uptime` integer, nullable: Current uptime of the player (milliseconds)
  - `external_ip_address` string, nullable: IP address as seen by the server for this device
  - `download_pct_complete` integer, nullable: Package download progress (percentage)
  - `meta` object, nullable: Dictionary of meta data
  - `cpu_temperature` number, float, nullable: Current CPU temperature

---

[API](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api.md) - [All operations](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/reveldigital/apis/revel-digital-rest-api/revisions/39d5c8302822?raw)