Usage Statistics

This document describes Usage Statistics endpoints for retrieving metrics about Devices and Gateways in the system.

The API provides insights across different dimensions:

• Active usage (devices/gateways that were active in a period)
• Total counts (all entities stored in the system)
• Max usage (peak values within a month)
• Integration metrics (processed uplinks/downlinks and traffic volume)
• Sets (lists of active entities for a period)

A device is considered active if:

• It reports at least one uplink (UL) during the selected period, OR
• The Network Server sends at least one downlink (DL) to the gateway during the selected period.

A gateway is considered active if:

• It sends at least one message/event/statistics record during the period, AND/OR
• It receives at least one message during the period.

Represents the current number of provisioned entities in the system at the time of request (active + inactive).

Represents the maximum number of entities observed in the database during a given month.

⚠️ Note: Only one parameter is allowed per request: either day OR month.

Active endpoints return the number of devices or gateways that were active during a selected period.

/api/statistics/application/{applicationId}/devices/active?day=YYYY-MM-DD

/api/statistics/application/{applicationId}/devices/active?month=YYYY-MM

/api/statistics/provider/{providerId}/devices/active?month=YYYY-MM

/api/statistics/customer/{customerId}/devices/active?month=YYYY-MM

/api/statistics/subCustomer/{subCustomerId}/devices/active?month=YYYY-MM-DD

/api/statistics/all/customers/devices/active?month=YYYY-MM

/api/statistics/all/customers/devices/active?day=YYYY-MM-DD

Headers required:

• username
• password

/api/statistics/all/providers/devices/active?month=YYYY-MM

/api/statistics/all/providers/devices/active?day=YYYY-MM-DD

Headers required:

• username
• password (Sysadmin)

/api/statistics/all/subCustomers/devices/active?month=YYYY-MM

/api/statistics/all/subCustomers/devices/active?day=YYYY-MM-DD

Headers required:

• username
• password (Customer)

/api/statistics/provider/{providerId}/gateways/active?day=YYYY-MM-DD

/api/statistics/customer/{customerId}/gateways/active?month=YYYY-MM

/api/statistics/gatewayGroup/{gatewayGroupId}/gateways/active?day=YYYY-MM-DD

/api/statistics/all/customers/gateways/active?month=YYYY-MM

/api/statistics/all/customers/gateways/active?day=YYYY-MM-DD

Headers required:

• username
• password

/api/statistics/all/providers/gateways/active?month=YYYY-MM

/api/statistics/all/providers/gateways/active?day=YYYY-MM-DD

Headers required:

• username
• password (Sysadmin)

Returns total number of entities currently stored in DB (active + inactive).

/api/statistics/application/{applicationId}/devices/total

/api/statistics/provider/{providerId}/devices/total

/api/statistics/customer/{customerId}/devices/total

/api/statistics/subCustomer/{subCustomerId}/devices/total

/api/statistics/all/customers/devices/total

/api/statistics/all/providers/devices/total

/api/statistics/all/subCustomers/devices/total

Headers required (All* endpoints):

• username
• password

/api/statistics/provider/{providerId}/gateways/total

/api/statistics/customer/{customerId}/gateways/total

/api/statistics/gatewayGroup/{gatewayGroupId}/gateways/total

/api/statistics/all/customers/gateway/total

/api/statistics/all/providers/gateways/total

Headers required (All* endpoints):

• username
• password

Returns the maximum number of devices/gateways observed within a month.

⚠️ Only month parameter is supported.

/api/statistics/application/{applicationId}/devices/max?month=YYYY-MM

/api/statistics/provider/{providerId}/devices/max?month=YYYY-MM

/api/statistics/customer/{customerId}/devices/max?month=YYYY-MM

/api/statistics/subCustomer/{subCustomerId}/devices/max?month=YYYY-MM

/api/statistics/all/customers/devices/max?month=YYYY-MM

/api/statistics/all/providers/devices/max?month=YYYY-MM

/api/statistics/all/SubCustomers/devices/max?month=YYYY-MM

/api/statistics/provider/{providerId}/gateways/max?month=YYYY-MM

/api/statistics/customer/{customerId}/gateways/max?month=YYYY-MM

/api/statistics/gatewayGroup/{gatewayGroupId}/gateways/max?month=YYYY-MM

/api/statistics/all/customers/gateways/max?month=YYYY-MM

/api/statistics/all/providers/gateways/max?month=YYYY-MM

Integration metrics describe data processed by external integrations.

• Processed uplink: UL processed and forwarded (may fail delivery due to HTTP/MQTT issues)
• Processed downlink: DL received via HTTP/MQTT
• Volume: total payload size in bytes

/api/statistics/integration/{integrationId}/uplink/processed/count?month=YYYY-MM

/api/statistics/application/{applicationId}/uplink/processed/count?day=YYYY-MM-DD

/api/statistics/customer/{customerId}/uplink/processed/count?month=YYYY-MM

/api/statistics/subcustomer/{subcustomerId}/uplink/processed/count?day=YYYY-MM-DD

/api/statistics/integration/{integrationId}/uplink/processed/volume?month=YYYY-MM

/api/statistics/application/{applicationId}/uplink/processed/volume?day=YYYY-MM-DD

/api/statistics/customer/{customerId}/uplink/processed/volume?month=YYYY-MM

/api/statistics/subcustomer/{subcustomerId}/uplink/processed/volume?day=YYYY-MM-DD

/api/statistics/integration/{integrationId}/downlink/processed/count?day=YYYY-MM-DD

/api/statistics/application/{applicationId}/downlink/processed/count?month=YYYY-MM-DD

/api/statistics/customer/{customerId}/downlink/processed/count?month=YYYY-MM-DD

/api/statistics/subcustomer/{subcustomerId}/downlink/processed/count?day=YYYY-MM-DD

/api/statistics/integration/{integrationId}/downlink/processed/volume?day=YYYY-MM-DD

/api/statistics/application/{applicationId}/downlink/processed/volume?month=YYYY-MM-DD

/api/statistics/customer/{customerId}/downlink/processed/volume?month=YYYY-MM-DD

/api/statistics/subcustomer/{subcustomerId}/downlink/processed/volume?day=YYYY-MM-DD

These endpoints return lists of active devices or gateways for a given period.

If no data exists for the period → empty set is returned.

/api/statistics/application/{applicationId}/devices/active/set?month=YYYY-MM

/api/statistics/customer/{customerId}/devices/active/set?month=YYYY-MM

/api/statistics/gatewayGroup/{gatewayGroupId}/devices/active/set?month=YYYY-MM

/api/statistics/provider/{providerId}/devices/active/set?month=YYYY-MM

/api/statistics/subCustomer/{subCustomerId}/devices/active/set?month=YYYY-MM

/api/statistics/customer/{customerId}/gateways/active/set?month=YYYY-MM

/api/statistics/gatewayGroup/{gatewayGroupId}/gateways/active/set?month=YYYY-MM

/api/statistics/provider/{providerId}/gateways/active/set?month=YYYY-MM

Returns active sets using user credentials in tabular format.

/api/statistics/application/{applicationId}/devices/active/set/withCredentials/tabular?month=YYYY-MM

/api/statistics/customer/{customerId}/devices/active/set/withCredentials/tabular?month=YYYY-MM

/api/statistics/gatewayGroup/{gatewayGroupId}/devices/active/set/withCredentials/tabular?month=YYYY-MM

/api/statistics/provider/{providerId}/devices/active/set/withCredentials/tabular?month=YYYY-MM

/api/statistics/subCustomer/{subCustomerId}/devices/active/set/withCredentials/tabular?month=YYYY-MM

This API group provides:

• Operational visibility (active usage)
• System inventory (total counts)
• Peak load analytics (max values)
• Data processing insights (integration metrics)
• Detailed entity-level activity sets

All endpoints are designed for reporting, billing, monitoring, and system analytics.