Sign in

v1

latestOpenAPI 3.0.22026-08-061303782.1 MB
Devices

List Device Metrics

Finix collects and analyzes data from payment devices and terminals to generate logs, known as Device Metric objects. Each Device Metric log provides insights into device health, network connectivity, and payment processing performance.

Use this endpoint to retrieve a device's Device Metric logs.

For details on how to query endpoints using the available parameters, see Query Parameters.

get/devices/{device_id}/device_metrics

Path parameters

device_idstring required

The device whose logs you wish to view.

Query parameters

after_cursorstring

Return every resource created after the cursor value.

before_cursorstring

Return every resource created before the cursor value.

created_at.gtestring date-time
Example:2022-09-27T11:21:23

Filter where created_at is after the given date.

created_at.ltestring date-time
Example:2026-09-27T11:21:23

Filter where created_at is before the given date.

connection'CLOSED' | 'OPEN'
Example:OPEN

Query logs based on the device's connection status (i.e., whether the device has an open or closed connection).

connectivity_network_type'CELLULAR' | 'ETHERNET' | 'WIFI'
Example:WIFI

Query based on the type of network connection (e.g., Wi-Fi, cellular, ethernet).

connectivity_signal_strength'EXCELLENT' | 'GOOD' | 'POOR' | 'VERY_POOR'
Example:POOR

Query based on the network connection strength.

event_type'APP_BACKGROUNDED' | 'APP_OPENED' | 'CHARGE_STATUS' | 'SCHEDULED_INTERVAL' | 'SERVER_CONNECTED' | 'USER_INITIATED'
Example:SCHEDULED_INTERVAL

Query based on the type of event that triggered the generation of the Device Metric.

limitinteger
Example:10

The numbers of items to return.

payment_app_state'BACKGROUND' | 'FOREGROUND'
Example:BACKGROUND

Query based on whether the payment application was running in the background or foreground on the device.

payment_app_versionstring
Example:3.2.1

Query based on the exact version of the payment application.

payment_app_version.gtestring
Example:3.2.1

Query greater than or equal to the specified payment app version.

payment_app_version.ltestring
Example:3.2.1

Query less than or equal to the specified payment app version.

power_battery_level_percentinteger

Query the device's battery level percentage.

power_battery_level_percent.gteinteger

Query greater than or equal to the specified battery level percentage.

power_battery_level_percent.lteinteger

Query less than or equal to the specified battery level percentage.

power_battery_temperature_celsiusnumber double

Query based on the device's battery temperature in Celsius.

power_battery_temperature_celsius.gtenumber double

Query greater than or equal to the specified battery temperature in Celsius.

power_battery_temperature_celsius.ltenumber double

Query less than or equal to the specified battery temperature in Celsius.

power_battery_temperature_fahrenheitnumber double

Query based on the device's battery temperature in Fahrenheit.

power_battery_temperature_fahrenheit.gtenumber double

Query greater than or equal to the specified battery temperature in Fahrenheit.

power_battery_temperature_fahrenheit.ltenumber double

Query less than or equal to the specified battery temperature in Fahrenheit.

power_is_chargingboolean

Query whether the device was charging or not charging.

system_android_versionstring
Example:12

Query based on the Android operating system version installed on the device.

system_android_version.gtestring
Example:12

Query greater than or equal to the specified Android operating system version.

system_android_version.ltestring
Example:12

Query less than or equal to the specified Android operating system version.

system_firmware_versionstring
Example:2.1.0

Query based on the firmware version.

system_firmware_version.gtestring
Example:2.1.0

Query greater than or equal to the specified firmware version.

system_firmware_version.ltestring
Example:2.1.0

Query less than or equal to the specified firmware version.

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

List of Device resources

Example response

{
  "_embedded": {
    "devices": [
      {
        "merchant": "MUxxxxxxxxxxxxxxxxxx"
      }
    ]
  }
}