Specs

get_daily_active_users_report(
  client(),
  start_date(),
  end_date(),
  [{:key, application_id()}] | []
) :: result()

Generate the daily active users report

This report retrieves the number of daily active users for a given application or across all applications. You must specify a date range for the report.

Parameters

• applicationid :: String.t() :: Optional

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

Examples

iex> client = FusionAuth.client()
iex> end_date = 1591830136785
iex> start_date = 1588316400000
iex> params = [applicationId: "473f2618-c526-45ba-9c35-8739ba6cfc2e"]
iex> FusionAuth.Reports.get_daily_active_users_report(client, start_date, end_date, params)
{
  :ok,
  %{
    "dailyActiveUsers" => [
      %{"count" => 1, "interval" => 18418},
      %{"count" => 1, "interval" => 18421},
      %{"count" => 1, "interval" => 18422},
      %{"count" => 1, "interval" => 18423}
    ],
    "total" => 4
  },
  %Tesla.Env{...}
}

For more information, visit the FusionAuth API Documentation for Generate Daily Active Users Report.

Specs

get_login_report(client(), start_date(), end_date(), [{:key, String.t()}] | []) ::
  result()

Generate Login Report

This report retrieves the number of logins for a given application or across all applications. You must specify a date range for the report. The report is always generated in hours. If you want to calculate daily logins, you’ll need to roll up the results in the response.

Parameters

• applicationid :: String.t() :: Optional

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

• loginId :: String.t() :: Optional

When this parameter is provided it will reduce the scope of the report to a single user with the requested email or username specified by this parameter.

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

• userId :: String.t() :: Optional

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.

Examples

iex> client = FusionAuth.client()
iex> end_date = 1591913469434
iex> start_date = 1577865600000
iex> FusionAuth.Reports.get_login_report(client, start_date, end_date)
{
  :ok,
  %{
    "hourlyCounts" => [
      %{"count" => 1, "interval" => 442050},
      %{"count" => 1, "interval" => 442051},
      %{"count" => 1, "interval" => 442054},
      %{"count" => 3, "interval" => 442055},
      %{"count" => 1, "interval" => 442120},
      %{"count" => 2, "interval" => 442122},
      %{"count" => 1, "interval" => 442146},
      %{"count" => 1, "interval" => 442149},
      %{"count" => 1, "interval" => 442151},
      %{"count" => 1, "interval" => 442168},
      %{"count" => 3, "interval" => 442170},
      %{"count" => 3, "interval" => 442171},
      %{"count" => 1, "interval" => 442174},
      %{"count" => 1, "interval" => 442194},
      %{"count" => 1, "interval" => 442197}
    ],
    "total" => 22
  },
  %Tesla.Env{...}
}

For more information, visit the FusionAuth API Documentation for Generate Login Report.

Specs

get_monthly_active_users_report(
  client(),
  start_date(),
  end_date(),
  [{:key, application_id()}] | []
) :: result()

Generate Monthly Active Users Report

This report retrieves the number of monthly active users for a given application or across all applications. You must specify a date range for the report. The report is always generated using months as the interval.

Parameters

• applicationid :: String.t() :: Optional

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

Examples

iex> client = FusionAuth.client()
iex> end_date = 1591830136785
iex> start_date = 1588316400000
iex> params = [applicationId: "473f2618-c526-45ba-9c35-8739ba6cfc2e"]
iex> FusionAuth.Reports.get_monthly_active_users_report(client, start_date, end_date, params)
{
  :ok,
  %{
    "monthlyActiveUsers" => [
      %{"count" => 10, "interval" => 543},
      %{"count" => 10, "interval" => 544},
      %{"count" => 10, "interval" => 545},
      %{"count" => 9, "interval" => 546}
    ],
    "total": 39,
  },
  %Tesla.Env{...}
}

For more information, visit the FusionAuth API Documentation for Generate Monthly Active Users Report.

Specs

get_registration_report(
  client(),
  start_date(),
  end_date(),
  [{:key, application_id()}] | []
) :: result()

Generate Registration Report

This report retrieves 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 generated in hours. If you want to calculate daily registrations, you’ll need to roll up the results in the response.

Parameters

• applicationid :: String.t() :: Optional

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

Examples

iex> client = FusionAuth.client()
iex> end_date = 1591830136785
iex> start_date = 1588316400000
iex> params = [applicationId: "473f2618-c526-45ba-9c35-8739ba6cfc2e"]
iex> FusionAuth.Reports.get_registration_report(client, start_date, end_date, params)
{
  :ok,
  %{
    "hourlyCounts" => [
      %{"count" => 1, "interval" => 442030},
      %{"count" => 1, "interval" => 442055},
      %{"count" => 1, "interval" => 442056},
      %{"count" => 0, "interval" => 442168}
    ],
    "total" => 3
  },
  %Tesla.Env{...}
}

For more information, visit the FusionAuth API Documentation for Generate Registration Report.

Specs

get_totals_report(client()) :: result()

Generate Totals Report

This report retrieves 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 generated in hours. If you want to calculate daily registrations, you’ll need to roll up the results in the response.

Examples

iex> FusionAuth.Reports.get_totals_report(client)
{
  :ok,
  %{
    "applicationTotals" => %{
      "3c219e58-ed0e-4b18-ad48-f4f92793ae32" => %{
        "logins" => 15,
        "registrations" => 1,
        "totalRegistrations" => 1
      },
      "c4e82607-dd9f-412a-a033-c53b79820446" => %{
        "logins" => 0,
        "registrations" => 0,
        "totalRegistrations" => 0
      },
      "f7a72ad1-de6a-412f-a372-e689a3b7adcb" => %{
        "logins" => 5,
        "registrations" => 1,
        "totalRegistrations" => 1
      }
    },
    "globalRegistrations" => 1,
    "totalGlobalRegistrations" => 3
  },
  %Tesla.Env{...}
}

For more information, visit the FusionAuth API Documentation for Generate Totals Report.