Skip to main content
Version: 1.8.x.x LTS

Reporting REST API

The following table gives an overview of the reporting through REST API.

URL: /getObservationsForUser

  • HTTP Request Method: GET
  • Parameters:
    • loginId: string
    • realm: string
  • Returns: JSON list of UserObservations
  • Purpose: Fetches the list of all observations for a given user.
[
{
loginId: string,
realm: string,
uniqueId: string,
startDate: date,
endDate: date,
type: string,
cookieName: string,
cookieValue: string,
ipAddress: string,
countryCode: string,
latitude: decimal,
longitude: decimal,
fingerprint: string,
tlsSessionId: string,
cypherSuite: string
},
...
]

URL: /filterUserObservations

  • HTTP Request Method: GET
  • Parameters:
    • loginId: string
    • realm: string(optional)
    • type: string(optional)
    • startDate: date(optional)
    • endDate: date
  • Returns: JSON list of UserObservations
  • Purpose: Fetches a filtered list of observations for a given user.
[
{
loginId: string,
realm: string,
uniqueId: string,
startDate: date,
endDate: date,
type: string,
cookieName: string,
cookieValue: string,
ipAddress: string,
countryCode: string,
latitude: decimal,
longitude: decimal,
fingerprint: string,
tlsSessionId: string,
cypherSuite: string
},
...
]