Skip to main content

Active and Total Users API

You can use the Active Users and Total Users APIs to find out the number of current and total users who are logged in to Prophecy. This can help you understand usage and times of high traffic, enabling you to manage capacity more effectively.

Active Users API​

Example:

curl --location 'https://<prophecy-env-url>/api/auth/userDetails' \
--header 'Cookie: prophecy-token=<prophecy-access-token>' | jq -r .activeUsers

Response:

{
  53
}

Total Users API​

Example:

curl --location 'https://<prophecy-env-url>/api/auth/userDetails' \
--header 'Cookie: prophecy-token=<prophecy-access-token>' | jq -r .userDetails.totalUsers

Response:

{
  1023
}