Skip to main content

Presence Admin

RallyHere Presence Admin API

This API is only available to administrators. It provides access to CCU data and to set specific values for presence that aren't available to unprivileged clients.

Each time a user interacts with this API their uuid is added to a time-keyed HyperLogLog. This enables us to track the number of users stochastically rather than having to create a complete entry for every interaction. Their uuid is also added to a HyperLogLog keyed by both time and the platform the user authenticated on.

The three actions CCU tracks are total, updating, and requesting. Comparing the numbers between the three will help identify if there are users who are scanning the API rather than using it for normal presence operations.

When requesting the CCU you generally have two major options: Combined and Individual.

The Combined methods count up the number of users internally and therefor handle duplicates correctly.

The Individual methods return the individual counts for each timestamp. This data can be useful, but can't be summed up directly unless you're okay with counting players multiple times.

For example, if you want to know the 24-hour CCU you should not get the Individual CCUs and add them up yourself. You should request the Combined CCU over that time period.