Retrieve Login Report API

Edit on GitHubView Markdown
On this page

This report includes the number of login 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 logins, you'll need to roll up the results in the response.

Request#

Global API Key Authentication
Retrieve the login report
GET/api/report/login?start={start}&end={end}&applicationId={applicationId}
OpenAPI Spec
Global API Key Authentication
Retrieve the login report for an individual user by username or email address
GET/api/report/login?start={start}&end={end}&applicationId={applicationId}&loginId={loginId}
OpenAPI Spec
Global API Key Authentication
Retrieve the login report for an individual user by unique Id
GET/api/report/login?start={start}&end={end}&applicationId={applicationId}&userId={userId}
OpenAPI Spec

Query Parameters#

applicationId
  • Type: UUID
  • Optional

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

end
  • Type: 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
  • Type: 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).

loginId
  • Type: String
  • Optional
  • Available since 1.4.0

When this parameter is provided it will reduce the scope of the report to a single user. This parameter can be one of the following (see loginIdTypes for information on which of these identifiers will be used):

  • Email address
  • Phone number (if phoneNumber is included in loginIdTypes)
  • Username

This parameter is mutually exclusive with userId, if both are provided, the loginId will take precedence.

loginIdTypes
  • Type: 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.

userId
  • Type: UUID
  • Optional
  • Available since 1.4.0

When this parameter is provided it will reduce the scope of the report to a single user with the requested unique Id.

This parameter is mutually exclusive with loginId, if both are provided, the loginId will take precedence.

Response#

The response for this API contains the login report.

Response Codes
CodeDescription
200The request was successful. The response will contain a JSON body.
400The 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.
401You 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.
404The object you requested doesn't exist. The response will be empty.
500There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.
503The 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 login counts.

hourlyCounts[x].interval
  • Type: Integer

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

hourlyCounts[x].count
  • Type: Integer

The number of login for this count.

total
  • Type: 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
    }
  ]
}

Related

APIs

Report API

Learn about the APIs for retrieving reports from FusionAuth.

fusionauth apirest apihttp api
APIs

Retrieve Daily Active Users Report API

API documentation for the FusionAuth Retrieve Daily Active Users Report API.

fusionauth apirest apihttp api
APIs

Retrieve Monthly Active Users Report API

API documentation for the FusionAuth Retrieve Monthly Active Users Report API.

fusionauth apirest apihttp api
APIs

Retrieve Registration Report API

API documentation for the FusionAuth Retrieve Registration Report API.

fusionauth apirest apihttp api