Retrieve most active users

Use this API to retrieve usage statistics by user, showing which users have made the most API calls during a selected time period. The response includes total requests, compute unit usage, and request share for each user.

HTTP method and endpoint

Use the following HTTP method and endpoint path to submit the request for retrieving the most active users.

POST /statistics-reporting/{tenantId}/API/getMostActiveUsers

Replace {tenantId} with the ID of the target tenant.

Request headers

The following request headers must be included.


Header	Value	Required
`Content-Type`	`application/json`	Yes
`Authorization`	`Bearer {access_token}`	Yes

Request body

The following table describes the request body parameters, including accepted values and defaults.


Parameter	Type	Required	Description	Accepted values / Default
`from` ⁽¹⁾	Long	Yes	Start time in epoch milliseconds	—
`to` ⁽¹⁾	Long	Yes	End time in epoch milliseconds	—
`env`	String	Yes	Target environment	Example: `prod`, `qa`, `dev` Default: none
`queryTypes`	Array	No	Filters by query type	`Read`, `Write`, `Search`, `Merge`, `Graphs` Default: all
`httpMethods`	Array	No	Filters by HTTP methods	Example: `POST`, `GET` Default: all methods
`apiEndPoints`	Array	No	Filters by API paths	Example: `/api/{tenantId}/entities` Default: all
`users`	Array	No	Filters by user email addresses	Example: `user1@example.com` Default: all users
Note: The time range defined by the `from` and `to` values must not exceed one month. If the specified range exceeds the allowed limit, the API returns an HTTP `416 Range Not Satisfiable` error with the following response: `{ "errors": [ { "message": "Invalid time range." } ] }`

Example request

Use the following example to see how a complete request is structured with headers and a JSON body.

curl -X POST https://{baseUrl}/statistics-reporting/{tenantId}/API/getMostActiveUsers \
  -H "Authorization: Bearer YOUR_BEARER_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "from": 1720867200000,
    "to": 1721016000000,
    "env": "prod",
    "httpMethods": ["POST"],
    "apiEndPoints": ["/api/tenant123/entities"],
    "users": ["user1@example.com"]
  }'

Response fields

The following table describes the fields returned in the response body.


Field	Type	Description
`user`	String	Email address of the user who made the API requests
`endPoint`	String	API endpoint path that was called by this user
`requestCount`	Integer	Total number of requests made by this user to this endpoint
`rcuTotal`	Float	Total Reltio Compute Unit (RCU) value consumed by this user
`rcuAvg`	Float	Average RCU consumption per request (`rcuTotal ÷ requestCount`)
`requestCountPercent`	Float	Percentage of total requests that this user's requests represent

Example response

The following example shows usage statistics for three users, including request volume and compute consumption.

[
  {
    "user": "user1@example.com",
    "endPoint": "/api/tenant123/entities",
    "requestCount": 5842,
    "rcuTotal": 15.7,
    "rcuAvg": 0.0027,
    "requestCountPercent": 20.0
  },
  {
    "user": "user2@example.com",
    "endPoint": "/api/tenant123/entities/_search",
    "requestCount": 4321,
    "rcuTotal": 12.8,
    "rcuAvg": 0.0030,
    "requestCountPercent": 15.0
  },
  {
    "user": "api.service@example.com",
    "endPoint": "/api/tenant123/entities/{id}",
    "requestCount": 3896,
    "rcuTotal": 9.2,
    "rcuAvg": 0.0024,
    "requestCountPercent": 10.0
  }
]

Unify and manage your data