Analytics API User Guide

Analytics API offers a wide range of functions to programmatically create reports on different data points generated by Bluedot products.

You can use the Analytics API to query:

• Point SDK entry and exit events
• ETA updates generated by Tempo
• Wave API events
• Order updates on Hello Screens

You can request the data in JSON or CSV formats.

info

Historical events are available for up to 12 months.

Regions

Analytics API is hosted in multiple regions worldwide to ensure better performance of our services. Make sure to use the endpoint for the region where your account is hosted. To learn more, refer to the Bluedot Regions documentation.

Region	Analytics API URL
APAC	https://analytics.bluedot.io/prod1/
EUROPE	https://eu1-analytics.bluedot.io/prod1/
NORTH AMERICA	https://us1-analytics.bluedot.io/prod1/

If you’re unsure which region your account is in, don’t hesitate to contact us at help@bluedot.io.

Authentication

Analytics API uses the same authentication method as Config API. You’ll need to pass an Access Token in the header of the request that you can get from the Config API /sessions endpoint. Check the “How to authenticate with Config API” guide for more details.

Geo-triggering Events

You can query Entry and Exit events generated by the Point SDK using the /entry and /exit endpoints. You can create reports for:

• Date and periods (days, months or year)
• Devices operating system (Android or iOS)
• Application state at the moment of the event (background or foreground)
• The location permissions granted at the moment of the event.

info

The /checkins endpoint is deprecated. We highly recommend using the /entry endpoint to query Geo-triggering entry events.

Tempo Events

To create reports on the customer’s ETA to the destination, you can use the /tempo endpoint to query Point SDK Tempo events based on:

• A given date or time frame (days, months or year)
• Device operating system (Android or iOS)
• Application state at the moment of the event (background or foreground)
• The location permissions granted at the moment of the event.

Wave API events

To create reports for a curbside/pickup web-based solution using Wave API, you can use the /wave endpoint. You can query data based on:

• A given date or time frame (days, months or year)
• Order’s state (based on the event type)
• By store (Also known as destination)

Hello Screens events

The /hello endpoint allows you to create reports about the progress and different states of the orders on Hello Screens. You can query this data based on:

• A given date or time frame (days, months or year)
• Order status (I.E. on the way, arrived, staff acknowledge the order)
• Order IDs
• By store (Also known as destination)
• Source of the event (For example, from web or mobile app)

API reference

The API specification for the Analytics API can be found here.