Skip to main content

Summarise check-in and user counts for a partner.

GET 
/api/checkins/summary

Requires admin token. Retrieve the number of check-ins of each type given by all users owned by a partner, plus the number of those users split by whether they are tagged as MobileMax (CustomField1 = 'MobileMax'). Both are optionally restricted to a date window - applied to the check-in date for check-ins and to the registration date for users. Intended as a lightweight health check - it returns counts only, with no check-in or user detail. Archived check-ins are excluded, so each check-in count matches the total reported by the corresponding check-in list endpoint, and the user total matches the total reported by the user list endpoint, for the same date window.

Request​

Query Parameters

    startDate string

    Count check-ins whose check-in date, and users whose registration date, is greater than or equal to the date passed in. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ)

    Example: 2024-01-01T00:00:00.000Z
    endDate string

    Count check-ins whose check-in date, and users whose registration date, is less than or equal to the date passed in. (The date should be in the ISO8601 UTC format YYY-MM-DDThh:mm:ss.SSSZ)

    Example: 2024-01-01T00:00:00.000Z

Responses​

Check-in counts per type and user counts per MobileMax tag for the given date window.

Schema

    checkins

    object

    Count of check-ins given by a partner's users, broken down by check-in type. Archived check-ins are excluded.

    mileage int64

    Number of mileage check-ins

    condition int64

    Number of condition check-ins

    proofOfAddress int64

    Number of proof of address check-ins

    total int64

    Total number of check-ins across all types

    users

    object

    Count of a partner's users, split by whether they are tagged as MobileMax users.

    mobileMax int64

    Number of users tagged as MobileMax, i.e. whose CustomField1 is 'MobileMax'

    nonMobileMax int64

    Number of users not tagged as MobileMax. Includes users with no CustomField1 value set

    total int64

    Total number of users, the sum of the MobileMax and non-MobileMax counts

Loading...