Retrieve Registration Report

Edit on GitHubEdit MD

This report includes the number of registrations for a given application or across all applications. You must specify a date range for the report. The report is always calculated in hours. if you want to calculate daily registrations, you'll need to roll up the results in the response.

Request#

Retrieve the registrations report

GET/api/report/registration?start={start}&end={end}&applicationId={applicationId}

OpenAPI Spec

Request Parameters#

applicationId UUID optional

A specific application to query for. If not provided a "Global" (across all applications) registrations report will be returned.

end Long required

The end of the query range. This is an instant but it is truncated to hours in the report timezone (which is set in the system settings).

start Long required

The start of the query range. This is an instant but it is truncated to hours in the report timezone (which is set in the system settings).

loginIdTypes Array<String> optional Defaults to [email, username] Available since 1.59.0

The identity types that FusionAuth will compare the loginId to. Can be one or more of the following:

email
phoneNumber
username

note

The order is significant. If ["email", "username"] is supplied with a loginId value of terry@example.com, then a user with terry@example.com as their email address will match first before any user with terry@example.com as their username.

Response#

The response for this API contains the registrations 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#

hourlyCounts

The list of registrations counts.

hourlyCounts[x].interval Integer

The interval for this count. The interval values for the registrations report are the number of hours since Epoch UTC shifted to the report timezone.

hourlyCounts[x].count Integer

The number of registrations for this count.

total Integer

The total (sum) of each count across the query range.

Example Response JSON

{
  "total": 100,
  "hourlyCounts": [
    {
      "interval": 401824,
      "count": 60
    },
    {
      "interval": 401825,
      "count": 40
    }
  ]
}