Documentation (Beta)
Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage

Usage Statistics

Usage Statistics

When the Device can be reported as Active:

Device reports at least one UL per selected period or NS sends at least one DL to GW per selected period.

Total Device number - When Device is provisioned to NS at the moment of request then Device is reported in Total Number of Devices.

When the Gateway can be reported as Active:

Gateway reports at least one message/event/statistics per selected period and/or Gateway receives at least one message per selected period.

Total Gateways number - When Gateway is provisioned to NS at the moment of request then Gateway is reported in Total Number of Gateways.

Usage Statistics API

Active:

Shows the number of active devices/GW during the specified day or month. day and month parameters have the following formats respectively - YYYY-MM-DD and YYYY-MM.

Active Devices:

  • Get Application’s active devices
/api/statistics/application/{applicationId}/devices/active?day=YYYY-MM-DD

  • {applicationID} = application ID

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

  • Get Provider’s active devices
/api/statistics/provider/{providerId}/devices/active?month=YYYY-MM

  • {providerId} = provider ID. This parameter is available only for users with provider access token

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

  • Get Customer’s active devices
/api/statistics/customer/{customerId}/devices/active?month=YYYY-MM

  • {customerId} = customer ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

  • Get Sub-Customer’s active devices
/api/statistics/subCustomer/{subCustomerId}/devices/active?month=YYYY-MM-DD

  • {subCustomerId} = Sub-customer ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

  • Get All Customer’s active devices
/api/statistics/all/customers/devices/active?month=YYYY-MM

and/or

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

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note:

    • Can be specified only 1 parameter (month or day)
    • Should be added “password”, and “username” of relevant Provider to Headers
  • Get All Provider’s active devices
/api/statistics/all/providers/devices/active?month=YYYY-MM

and/or

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

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note:

    • Can be specified only 1 parameter (month or day)
    • Should be added “password”, and “username” of relevant Sysadmin to Headers
  • Get All Sub-Customer’s active devices
/api/statistics/all/subCustomers/devices/active?month=YYYY-MM

and/or

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

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note:

    • Can be specified only 1 parameter (month or day)
    • Should be added “password”, and “username” of relevant Customer to Headers

Active Gateways:

  • Get Provider’s active gateways
/api/statistics/provider/{providerId}/gateways/active?day=2022-12-31

  • {providerId} = provider ID. This parameter is available only for users with provider access token

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

  • Get Customer’s active gateways
/api/statistics/customer/{customerId}/gateways/active?month=2022-12

  • {customerId} = customer ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

  • Get Gateway Group’s active gateways
/api/statistics/gatewayGroup/{gatewayGroupId}/gateways/active?day=2022-12-31

  • {gatewayGroupID} = Gateway Group ID

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

  • Get All Customers active gateways

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

and/or

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

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note:

    • Can be specified only 1 parameter (month or day)
    • Should be added “password”, and “username” of relevant Provider to Headers
  • Get All Providers active Gateways
/api/statistics/all/providers/gateways/active?month=YYYY-MM

and/or

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

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note:

    • Can be specified only 1 parameter (month or day)
    • Should be added “password”, and “username” of relevant Sysadmin to Headers



Total:

Shows the current total number of devices and gateways (both active and inactive) that are present in DB

Total Devices:

  • Get Application’s total device count
/api/statistics/application/{applicationId}/devices/total
  • {applicationID} = application ID
  • Get Provider’s total device count
/api/statistics/provider/{providerId}/devices/total
  • {providerId} = provider ID. This parameter is available only for users with provider access token
  • Get Customer’s total device count
/api/statistics/customer/{customerId}/devices/total
  • {customerId} = customer ID.
  • Get Sub-Customer’s total device count
/api/statistics/subCustomer/{subCustomerId}/devices/total
  • {subCustomerId} = Sub-customer ID.
  • Get All Customer’s total device count
/api/statistics/all/customers/devices/total

Please note: Should be added “password”, and “username” of relevant Provider to Headers

  • Get All Provider’s total device count
/api/statistics/all/providers/devices/total

Please note: Should be added “password”, and “username” of relevant Provider to Headers

  • Get All Sub-Customer’s total device count
/api/statistics/all/subCustomers/devices/total

Please note: Should be added “password”, and “username” of relevant Provider to Headers

Total Gateways:

  • Get Provider’s total gateways count
/api/statistics/provider/{providerId}/gateways/total
  • {providerId} = provider ID. This parameter is available only for users with provider access token
  • Get Customer’s total gateways count
/api/statistics/customer/{customerId}/gateways/total
  • {customerId} = customer ID.
  • Get Gateway Group’s total gateways count
/api/statistics/gatewayGroup/{gatewayGroupId}/gateways/total
  • {gatewayGroupId} = Gateway Group ID
  • Get All Customer’s total gateways count
/api/statistics/all/customers/gateway/total

Please note: Should be added “password”, and “username” of relevant Provider to Headers

  • Get All Provider’s total gateways count
/api/statistics/all/providers/gateways/total

Please note: Should be added “password”, and “username” of relevant Provider to Headers



Max:

Shows max number of devices/gateways present in the database during the specified month. Only month parameter supported (format 2023-02)

Max Devices:

  • Get Application’s Max devices count
/api/statistics/application/{applicationId}/devices/max?month=YYYY-MM
  • {applicationId} = application ID.
  • month could be used in YYYY-MM format.
  • Get Provider’s Max devices count
/api/statistics/provider/{providerId}/devices/max?month=YYYY-MM
  • {providerId} = provider ID.
  • month could be used in YYYY-MM format.
  • Get Customer’s Max devices count
/api/statistics/customer/{customerId}/devices/max?month=YYYY-MM
  • {customerId} = customer ID.
  • month could be used in YYYY-MM format.
  • Get Sub-Customer’s Max devices count
/api/statistics/subCustomer/{subCustomerId}/devices/max?month=YYYY-MM
  • {subCustomerId} = Sub-customer ID.
  • month could be used in YYYY-MM format.
  • Get All Customer’s Max devices count
/api/statistics/all/customers/devices/max?month=YYYY-MM
  • month could be used in YYYY-MM format. Please note: Should be added “password”, and “username” of relevant Provider to Headers
  • Get All Provider’s Max devices count
/api/statistics/all/providers/devices/max?month=YYYY-MM
  • month could be used in YYYY-MM format. Please note: Should be added “password”, and “username” of relevant Sysadmin to Headers
  • Get All Sub-Customer’s Max devices count
/api/statistics/all/SubCustomers/devices/max?month=YYYY-MM
  • month could be used in YYYY-MM format. Please note: Should be added “password”, and “username” of relevant Customer to Headers

Max Gateways:

Get Provider’s Max gateways count

/api/statistics/provider/{providerId}/gateways/max?month=2023-02
  • {providerId} = provider ID.
  • month could be used in YYYY-MM format.

Get Customer’s Max gateways count

/api/statistics/customer/{customerId}/gateways/max?month=YYYY-MM
  • {customerId} = customer ID.
  • month could be used in YYYY-MM format.

Get Gateway Group’s Max gateways count

/api/statistics/gatewayGroup/{gatewayGroupId}/gateways/max?month=YYYY-MM
  • {gatewayGroupId} = Gateway Group ID.
  • month could be used in YYYY-MM format.
  • Get All Customer’s Max gateways count
/api/statistics/all/customers/gateways/max?month=YYYY-MM
  • month could be used in YYYY-MM format. Please note: Should be added “password”, and “username” of relevant Provider to Headers
  • Get All Provider’s Max gateways count
/api/statistics/all/providers/gateways/max?month=YYYY-MM
  • month could be used in YYYY-MM format. Please note: Should be added “password”, and “username” of relevant Sysadmin to Headers



Integration:

processed UL - UL was converted and processed by integration so that it was ready to be sent to HTTP or MQTT server. But it could be not delivered because of HTTP server errors or MQTT not being connected.

processed DL - DL was received by integration from HTTP request or from MQTT server.

volume - total size in bytes

period: month/day (?month=2023-02 / ?day=2022-12-31)

  • Customer Active Devices Set

Processed Uplink count

Get Integration’s Processed Uplink count

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

  • {integrationId} = Integration ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Get Application’s Processed Uplink count

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

  • {applicationId} = Application ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Get Customer’s Processed Uplink count

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

  • {customerId} = Customer ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Get Sub-Customer’s Processed Uplink count

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

  • {subcustomerId} = Sub-customer ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Processed Uplink volume

Get Integration’s Processed Uplink volume

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

  • {integrationId} = Integration ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Get Application’s Processed Uplink volume

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

  • {applicationId} = Application ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Get Customer’s Processed Uplink volume

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

  • {customerId} = Customer ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Get Sub-customer’s Processed Uplink volume

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

  • {subcustomerId} = Sub-Customer ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Processed Downlink count

Get Integration’s Processed Downlink count

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

  • {integrationId} = Integration ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Get Application’s Processed Downlink count

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

  • {applicationId} = Application ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Get Customer’s Processed Downlink count

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

  • {customerId} = Customer ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Get Sub-Customer’s Processed Downlink count

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

  • {subcustomerId} = Sub-Customer ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Processed Downlink volume

Get Integration’s Processed Downlink volume

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

  • {integrationId} = Integration ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Get Application’s Processed Downlink volume

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

  • {applicationId} = Application ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Get Customer’s Processed Downlink volume

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

  • {customerId} = Customer ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Get Sub-Customer’s Processed Downlink volume

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

  • {subcustomerId} = Sub-Customer ID.

  • day or month could be used YYYY-MM-DD and YYYY-MM

    Please note: Can be specified only 1 parameter (month or day)

Calculate number of Active Devices per GW Group

Calculate the number of ActiveDevices for all Customer’s Gateways Groups

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

Parameters:
"password: password"
 username: username"

  • {password} - customer’s password

  • {username} - customer’s username

    Please note: Can be specified only 1 parameter (month or day)

Calculate number of Active Devices per Gateway Group

/api/statistics/gatewayGroup/{gatewayGroup_ID}/devices/active?day=YYYY-MM_DD

  • {gatewayGroup_ID} - Gateway Group ID

    Please note: Can be specified only 1 parameter (month or day)

Combined:

Calculate number of active devices | active GW, and max devices | max GW of Provider’s customer

For Network Server:

/api/statistics/all/customers/combined/ns?month=YYYY-MM

For OAM:

/api/statistics/all/customers/combined/oam?month=YYYY-MM

  • {password} - customer’s password

  • {username} - customer’s username

    Please note: Can be specified only 1 parameter (month or day)

Combined:

Calculate number of active devices | active GW, and max devices | max GW of Provider’s customer

For Network Server:

/api/statistics/all/customers/combined/ns?day=YYYY-MM

For OAM:

/api/statistics/all/customers/combined/oam?day=YYYY-MM
  • {password} - customer’s password
  • {username} - customer’s username
/api/statistics/customer/{customerId}/devices/active/set?month=YYYY-MM
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format

Active Gateways and Devices Set

  • Gateway Group Active Devices Set
/api/statistics/gatewayGroup/{gatewayGroupId}/devices/active/set?month=YYYY-MM
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format
  • Provider Active Devices Set
/api/statistics/provider/{providerId}/devices/active/set?month=YYYY-MM
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format
  • SubCustomer Active Devices Set
/api/statistics/subCustomer/{subCustomerId}/devices/active/set?month=YYYY-MM
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format

Active Gateways Set

  • Customer Active Gateways Set
/api/statistics/customer/{customerId}/gateways/active/set?month=YYYY-MM
  • {customerId} = Customer ID.
  • {month} can be used in YYYY-MM format
  • Gateway Group Active Gateways Set
/api/statistics/gatewayGroup/{gatewayGroupId}/gateways/active/set?month=YYYY-MM
  • {gatewayGroupId} = Gateway Group ID.
  • {month} can be used in YYYY-MM format
  • Provider Active Gateways Set
/api/statistics/provider/{providerId}/gateways/active/set?month=YYYY-MM
  • {providerId} = Provider ID.
  • {month} can be used in YYYY-MM format

Active Set

These endpoints are designed to return a list of active Gateways, and Devices per month. If there is no set(active Gateways/Devices) for the month, an empty set is returned.

Active Devices Set

  • Application Active Devices Set
/api/statistics/application/{applicationId}/devices/active/set?month=YYYY-MM
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format
  • Customer Active Devices Set
/api/statistics/customer/{customerId}/devices/active/set?month=YYYY-MM
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format
  • Gateway Group Active Devices Set
/api/statistics/gatewayGroup/{gatewayGroupId}/devices/active/set?month=YYYY-MM
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format
  • Provider Active Devices Set
/api/statistics/provider/{providerId}/devices/active/set?month=YYYY-MM
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format
  • SubCustomer Active Devices Set
/api/statistics/subCustomer/{subCustomerId}/devices/active/set?month=YYYY-MM
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format

Active Gateways Set

  • Customer Active Gateways Set
/api/statistics/customer/{customerId}/gateways/active/set?month=YYYY-MM
  • {customerId} = Customer ID.
  • {month} can be used in YYYY-MM format
  • Gateway Group Active Gateways Set
/api/statistics/gatewayGroup/{gatewayGroupId}/gateways/active/set?month=YYYY-MM
  • {gatewayGroupId} = Gateway Group ID.
  • {month} can be used in YYYY-MM format
  • Provider Active Gateways Set
/api/statistics/provider/{providerId}/gateways/active/set?month=YYYY-MM
  • {providerId} = Provider ID.
  • {month} can be used in YYYY-MM format

Active Set with credentials

These endpoints are designed to return a list of active Gateways, and Devices per month using user credentials. If there is no set(active Gateways/Devices) for the month, an empty set is returned.

Active Devices Set with credentials

  • Application Active Devices Set with credentials
/api/statistics/application/{applicationId}/devices/active/set/withCredentials/tabular?month=2024-04
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format
  • Customer Active Devices Set with credentials
/api/statistics/customer/{customerId}/devices/active/set/withCredentials/tabular?month=YYYY-MM
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format
  • Gateway Group Active Devices Set with credentials
/api/statistics/gatewayGroup/{gatewayGroupId}/devices/active/set/withCredentials/tabular?month=YYYY-MM
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format
  • Provider Active Devices Set with credentials
/api/statistics/provider/{providerId}/devices/active/set/withCredentials/tabular?month=YYYY-MM
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format
  • SubCustomer Active Devices Set with credentials
/api/statistics/subCustomer/{subCustomerId}/devices/active/set/withCredentials/tabular?month=YYYY-MM
  • {applicationId} = Application ID.
  • {month} can be used in YYYY-MM format

Active Gateways Set with credentials

  • Customer Active Gateways Set with credentials
/api/statistics/customer/{customerId}/gateways/active/set/withCredentials/tabular?month=YYYY-MM
  • {customerId} = Customer ID.
  • {month} can be used in YYYY-MM format
  • Gateway Group Active Gateways Set with credentials
/api/statistics/gatewayGroup/{gatewayGroupId}/gateways/active/set/withCredentials/tabular?month=YYYY-MM
  • {gatewayGroupId} = Gateway Group ID.
  • {month} can be used in YYYY-MM format
  • Provider Active Gateways Set with credentials
/api/statistics/provider/{providerId}/gateways/active/set/withCredentials/tabular?month=YYYY-MM
  • {providerId} = Provider ID.
  • {month} can be used in YYYY-MM format