Statistics API

Overview

This document describes the Onegini IdP statistics API

Version information

Version : 1.0.0

Paths

Get statistics

GET /api/statistics

Description

The endpoint allows to get current statistics. The response is provided in JSON format. Currently supported overview statistics are:

  • invitations_pending_total
  • persons_activated_total
  • persons_created_total
  • persons_logged_in_year_continuous
  • persons_migrated_total
  • persons_not_logged_in_year_continuous
  • persons_signed_up_week_continuous

    Currently supported history statistics are:

  • invitations_created_week_history
  • invitations_validated_week_history
  • logins_week_history
  • password_reset_code_validated_week_history
  • persons_migrated_week_history
  • persons_signed_up_week_history
  • persons_unblocked_week_history

Responses

HTTP Code Description Schema
200 Statistics fetched successfully Statistics

Security

Type Name
basic basic_auth

Example HTTP request

Request path
/api/statistics

Example HTTP response

Response 200
{
  "overview" : {
    "invitations_pending_total" : 31,
    "persons_activated_total" : 145,
    "persons_created_total" : 225,
    "persons_logged_in_year_continuous" : 1029,
    "persons_not_logged_in_year_continuous" : 104,
    "persons_migrated_total" : 43,
    "persons_signed_up_week_continuous" : 132
  },
  "history" : [ {
    "start_date" : 1469397600000,
    "values" : [ {
      "invitations_created_week_history" : 29,
      "invitations_validated_week_history" : 21,
      "logins_week_history" : 53,
      "password_reset_code_validated_week_history" : 1,
      "persons_migrated_week_history" : 6,
      "persons_signed_up_week_history" : 4,
      "persons_unblocked_week_history" : 0
    } ]
  } ]
}

Get statistics history

GET /api/statistics/history

Description

The endpoint allows to get weekly historical statistics. The response is provided in CSV format, comma separated. The available weekly statistics are listed in STATISTICS-API-2 description

Responses

HTTP Code Description Schema
200 Statistics fetched successfully string

Produces

  • text/csv

Security

Type Name
basic basic_auth

Example HTTP request

Request path
/api/statistics/history

Example HTTP response

Response 200
"start_date,logins_week_history,persons_migrated_week_history,persons_signed_up_week_history,invitations_created_week_history,invitations_validated_week_history,password_reset_code_validated_week_history,persons_unblocked_week_history 2016-07-25,1,0,0,0,0,0,0 2016-07-18,2,0,1,0,0,0,0 2016-07-11,0,0,0,0,0,0,0"

Definitions

History

Name Description Schema
invitations_created_week_history
optional
Number of invitations created within past week
Example : 29
integer
invitations_validated_week_history
optional
Number of invitations validated within past week
Example : 21
integer
logins_week_history
optional
Number of logins within past week
Example : 53
integer
password_reset_code_validated_week_history
optional
Number of password reset codes validations within past week
Example : 1
integer
persons_migrated_week_history
optional
Number of persons migrations within past week
Example : 6
integer
persons_signed_up_week_history
optional
Number of newely signed up persons within past week
Example : 4
integer
persons_unblocked_week_history
optional
Number of unblocked persons within past week
Example : 0
integer

HistoryCollection

Name Description Schema
start_date
optional
Example : 1469397600000 integer (timestamp)
values
optional
Example : [ "[history](#history)" ] < History > array

Overview

Name Description Schema
invitations_pending_total
optional
Total number of pending invitations
Example : 31
integer
persons_activated_total
optional
Total number of activated person's accounts
Example : 145
integer
persons_created_total
optional
Total number of created accounts
Example : 225
integer
persons_logged_in_year_continuous
optional
Number of persons who logged in within past year
Example : 1029
integer
persons_migrated_total
optional
Total number of migrated persons
Example : 43
integer
persons_not_logged_in_year_continuous
optional
Number of persons who NOT logged in within past year
Example : 104
integer
persons_signed_up_week_continuous
optional
Number of persons who signed up within past week
Example : 132
integer

Statistics

Name Description Schema
history
optional
Example : [ "[historycollection](#historycollection)" ] < HistoryCollection > array
overview
optional
Example : "[overview](#overview)" Overview

Security

basic_auth

Type : basic