Users

Retrieves a summary of users.

get

Provides a high-level overview of the user base for the current brand, including total users and newly registered users (daily, weekly, monthly).

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

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

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/analytics/users/summary HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "totalUsers": 9999,
    "newUsersToday": 399,
    "newUsersThisWeek": 799,
    "newUsersThisMonth": 899
  },
  "errors": []
}

Retrieves daily user analytics.

get

Returns user registration and activity statistics within the specified date range. If no range is provided, defaults to the current period.

Query parameters

startDatestringOptional

The start date (yyyy-MM-dd). Optional.

endDatestringOptional

The end date (yyyy-MM-dd). Optional.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

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

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/analytics/users/daily 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": "2025-09-09",
      "newUsers": 299,
      "totalUsers": 999
    }
  ],
  "errors": []
}

Retrieves user geography analytics.

get

Provides distribution of users by geography (e.g., countries, regions) for the current brand, within the specified date range if provided.

Query parameters

startDatestringOptional

The start date (yyyy-MM-dd). Optional.

endDatestringOptional

The end date (yyyy-MM-dd). Optional.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

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

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/analytics/users/geography HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": [
    {
      "countryCode": "US",
      "totalUsers": 999
    }
  ],
  "errors": []
}