Statistics users

Statistics users for the given filter.

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".

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

The API result model with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Required

This is the message to be displayed to the user.

dataany · nullableOptional

403

The user's access was denied.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/users/statistics

HTTPcURLJavaScriptPython

GET /api/v1/users/statistics HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: 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": []
}