Statistics

Statistics devices data.

get

Query parameters

StartDatestring · date-timeOptional

The end date to filter the statistics. The format is "yyyy-MM-dd HH:mm:ss".

Example: 2024-02-23 00:00:00

EndDatestring · date-timeOptional

The end date to filter the statistics. The format is "yyyy-MM-dd HH:mm:ss".

Example: 2024-02-23 23:59:59

TypeResponsestringOptional

The type of response. This value can be "MONTH" or "DATE".

api-versionstringOptional

Header parameters

BrandUrlstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

AuthkeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

403

The user's access was denied.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/devices/statistics HTTP/1.1
Host: protocol.jframework.dev
BrandUrl: text
Authkey: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "date": "2024-02-17T00:00:00",
      "quantity": 10
    },
    {
      "date": "2024-02-18T00:00:00",
      "quantity": 30
    },
    {
      "date": "2024-02-19T00:00:00",
      "quantity": 15
    },
    {
      "date": "2024-02-20T00:00:00",
      "quantity": 20
    },
    {
      "date": "2024-02-21T00:00:00",
      "quantity": 25
    },
    {
      "date": "2024-02-22T00:00:00",
      "quantity": 35
    },
    {
      "date": "2024-02-23T00:00:00",
      "quantity": 40
    }
  ],
  "errors": []
}