API Documentation

Use your data outside the platform

The Exposure Analytics API lets approved customers retrieve their event and sensor data for their own use.

Authenticate and make a request

The examples below use curl, a command-line tool for making HTTP requests. You can make the same requests using the interactive API reference, an API client such as Postman, or your own software.

1. 1. Request an access token

   Send your account email address and password to the sessions endpoint. Use the same host that you use to access the Exposure Analytics platform.

   curl --request POST https://app.exposureanalytics.com/api/v1/sessions --header "Content-Type: application/json" --data '{"email":"you@example.com","password":"YOUR_PASSWORD"}'

   For clarity, this example uses a password placeholder. Do not replace it with a real password in a command that may be saved in your shell history. Use the interactive API reference or a securely configured API client for real credentials.

   A successful request returns a response similar to:

   {"authToken": "YOUR_API_TOKEN", "expiresAt": "YYYY-MM-DDTHH:MM:SSZ", "user": {"id": 123, "name": "Example API User", "email": "you@example.com"}}

   Access tokens expire after 30 days. Keep your token private and do not include it in emails, screenshots or source control.

2. 2. Include the token in API requests

   Send the token in the Authorization header. For example, this request returns the events available to your account:

   curl https://app.exposureanalytics.com/api/v1/events --header "Authorization: Token YOUR_API_TOKEN" --header "Accept: application/json"

   The returned data is limited to your assigned company and, where applicable, companies belonging to your assigned reseller.

3. 3. Replace path parameters

   Values inside braces are placeholders. Replace them with the relevant ID. For example:

   /api/v1/events/{event_id}/statistics/totals

   For event 42, that becomes:

   /api/v1/events/42/statistics/totals

4. 4. Revoke the token

   Revoke a token when it is no longer required:

   curl --request DELETE https://app.exposureanalytics.com/api/v1/sessions --header "Authorization: Token YOUR_API_TOKEN"

Available API endpoints

This catalogue contains the customer-facing API endpoints. What your account can use depends on its EX, Apex and BLE permissions, company or reseller data scope, and any endpoint-specific access rules.