Skip to main content
GET
/
api
/
public
/
checkins
/
metrics

​
Check-in Metrics

Returns aggregate check-in metrics (current occupancy, daily totals, etc.) for one or more business locations. Used to display occupancy information on the dashboard.

​
Authentication

Requires a valid customer bearer token.

​
Query Parameters

​
businessesIds
number[]
required
Array of business IDs to retrieve metrics for. Passed as repeated query parameters: businessesIds=1&businessesIds=2.

​
Response

Returns check-in metrics for the requested locations.

​
Examples

​
Fetch metrics for two locations

GET /api/public/checkins/metrics?businessesIds=1&businessesIds=2
Authorization: Bearer {token}

​
TypeScript Integration

import endpoints from '@/api/endpoints'

const response = await httpClient.get(endpoints.checkins.metrics([1, 2]))