Retrieve Totals Report

The Report Totals API is used to retrieve the number users currently registered and how many login requests have been serviced by FusionAuth globally as well as broken down by each Application.

Request#

Retrieve the Totals Report

GET/api/report/totals

OpenAPI Spec

Response#

The response for this API contains the totals report.

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you requested doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503	The search index is not available or encountered an exception so the request cannot be completed. The response will contain a JSON body.

Response Body#

applicationTotals

A map where the key is the Id of the Application and the value is an object that contains the totals for that Application.

applicationTotals[id].loginsInteger

The total number of logins (all time) for the Application.

applicationTotals[id].registrationsInteger

The current number of registrations for the Application. This doesn't include registrations for user's that have been deleted from FusionAuth.

applicationTotals[id].totalRegistrationsInteger

The total number of registrations (all time) for the Application.

globalRegistrationsInteger

The current number of registered users. This value is incremented each time a new user is added to FusionAuth, and this value is decremented when a user is deleted from FusionAuth.

totalGlobalRegistrationsInteger

The total number of registrations (all time). When a user is removed from FusionAuth this number is not decremented.

Example Response JSON

{
  "applicationTotals": {
    "00000000-0000-0000-0000-000000000000": {
      "logins": 20,
      "registrations": 10,
      "totalRegistrations": 10
    },
    "00000000-0000-0000-0000-000000000001": {
      "logins": 20,
      "registrations": 10,
      "totalRegistrations": 10
    },
    "00000000-0000-0000-0000-000000000002": {
      "logins": 20,
      "registrations": 10,
      "totalRegistrations": 10
    },
    "00000000-0000-0000-0000-000000000003": {
      "logins": 20,
      "registrations": 10,
      "totalRegistrations": 10
    },
    "00000000-0000-0000-0000-000000000004": {
      "logins": 20,
      "registrations": 10,
      "totalRegistrations": 10
    }
  },
  "globalRegistrations": 10,
  "totalGlobalRegistrations": 10
}