Introduction

HyperTrack is the API for anything that moves with commercial value. From startups to enterprises worldwide, product development teams build live location use cases with HyperTrack to power business efficiency and product experience.

In this section, we will do a quick walk-through of the major sections of HyperTrack docs.

Get started

The easiest way to get started is to sign up and get the HyperTrack Live app (Android or iOS). Invite team members through a deep link to get the app pointing to the same account. Optionally, you may provide them with the option to set up their own password to get full access to the account through their email.

Use Playground to control tracking on your devices without writing code. This is a great way to get familiar with the HyperTrack APIs and get ready-to-use code in your favorite language. With Playground, you can view all devices pointing to your account, start & stop tracking them from the cloud, manage their name & metadata, and start & complete trips with destinations.

Use Quickstarts to clone a working app on iOS, Android, React Native and Flutter. This is a great way for all engineers (no mobile development experience required) to build their own app pointing to their HyperTrack account, and then use the APIs to manage tracking on these apps.

Use sample apps for Live Location Sharing, Logistics and Ridesharing with source code for iOS and Android, open-sourced under the MIT license. These are production-ready apps built with HyperTrack. Sample apps are a great way to kickstart new projects for your business, or to understand how to integrate your existing apps with HyperTrack.

Setup

Use the setup guides when you ready to add the HyperTrack SDK to your app, integrate your backend with HyperTrack APIs & webhooks, and add HyperTrack views to your front end.

  • Install SDK: SDK installation instructions for Android, iOS, React Native and Flutter apps
  • Setup and manage devices: Instructions to link user IDs from your application with HyperTrack device IDs, and add metadata to organize users into hierarchical orgs to filter views
  • Stream locations and markers via webhooks: Implement app logic and workflows by listening to your devices status and markers updates in real-time by receiving webhooks on your server
  • Build custom tracking views: Embed maps, timelines and insights in your ops dashboard with restricted access to data that respective dashboard users are authorized to view. Create live views in native apps with ViewsSDK. Create live tracking experiences for your customers. Build live tracking experiences without provisioning infrastructure to stream live locations to your native apps on mobile. You can create compelling live location tracking views in both desktop applications and mobile devices for your app users without having to provision your infrastructure.

Guides

Guides provide step-by-step instructions for the most common use cases built with HyperTrack.

  • Track distance for financial payouts: See all the ways you can leverage HyperTrack to get drive distances for financial payouts.

  • Track live route and ETA to destination: Get live routes and ETA to destination. Available as mobile-friendly views to share with your customers, detailed views to embed in your ops dashboards, webhooks for delays & arrivals, and more. Best for tracking delays and no shows, reducing customer anxiety, and proactively managing escalations before they happen. Improve product experience and reduce customer support costs.

  • Track arrival, exit, route to geofences: Set radius or polygon geofences for all (or group of) devices in the account or specific devices or trips. Get webhooks for arrivals and exits, and generate data for time spent at geofences, route taken between geofences, and idle time (stops) between geofences. Best for tracking time spent and route efficiency relative to known places of business, and correlating this with outcomes from those places.

  • Track work day with visit notes: Record app events as markers to the location timeline of the user. This is the most popular way to provide visibility to ops managers about work performed on the field.

  • Scoreboard: Explore and integrate your scoreboard that provides an account wide view of how operations are progressing today when compared to the past week or month. Visualizations provide trends for tracking rates, average drive distance, average stop duration, average steps walked, devices tracked, trips completed, geotags generated, and geofences visited. Drill downs on trips, geotags, and geofences provide a holistic picture on feature specific metrics that can help your team observe current field operations.

  • Export tracking data by day: Get insights that scores users based on tracking %, and average distances for geotags, trips and geofences. Export the insights as CSV and get underlying location and marker data as gzipped JSON. Best for archiving data on your servers and ingesting data into your data lake to build custom data models.

  • Dispatch work to nearby devices: Dispatch work assignments to the nearest available devices based on their live location, and ranking them as nearest first from the first point of fulfillment (pickup, visit, delivery or gig location).

API References

Comprehensive references are available for APIs (Devices, Trips and Geofences), SDKs (iOS and Android), Views (Android), and other details you might need to look up when using the various features of HyperTrack.