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
  • Track devices with the API: Start and stop tracking devices from the cloud (requires SDK installation with silent push notifications setup)
  • Embed hierarchical views: Embed maps, timelines and leaderboards in your ops dashboard with restricted access to data that respective dashboard users are authorized to view
  • Stream data to native apps: Get data as callbacks on native Android and iOS apps to construct tracking views for your customers (this app may be different from the one being tracked)

Guides

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

  • Track work day with visit notes: Record app events as markers to the location timeline of the user. Use day's trip summary to identify significant stops and ask app users to add notes for each. This is the most popular way to provide visibility to ops managers about work performed on the field.

  • Track distance between app events: Get actual distance between app events as webhooks to your server as they happen. Best for businesses that rely on distance for billing customers or paying out drivers. Actual distance with HyperTrack is more accurate than point-to-point estimates using maps.

  • 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 for 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.

  • Dispatch to nearest available (BETA): Get a sorted list of available devices nearest to a specified location. Best for building real-time systems with on-demand dispatch, dynamic routing and order assignment. Improve operations efficiency, turn around times and overall productivity.

  • Export tracking data by day: Get leaderboard that scores users based on tracking %, and average distances for custom markers, trips and geofences. Export the leaderboard 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.

Tutorials

Tutorials provide a list of use cases to consider for specific industry verticals like brick-and-mortar store networks, fleet automation for logistics networks, and on-demand businesses like ridesharing, on-demand delivery and gig work.

Each tutorial uses relevant SDKs, APIs and product features to create a vertical solution. Relevant parts of references and guides are included inline to re-use and modify.

Some tutorials come with open-sourced sample apps to clone/fork and build your own app. These are production-ready sample apps available on Play Store and App Store. You may invite your fleet to get these apps using deep links available in your account dashboard.

  • Track deliveries through stores: This is a tutorial for retail chains doing home deliveries through their store network. As store-assigned assets shift to regional resource pools, and ecommerce orders are assigned to riders on-demand, the role of live location becomes critical in managing dispatch, pickup and delivery. Read more about the supply chain transformation from distribution to fulfillment.

  • Automate logistics with live location: Mobile apps are driving the digital transformation of logistics. A modern workforce automation or fleet automation solution must have a mobile app for drivers as they are out and about performing their deliveries or service visits. Get started with the open-sourced production-ready HyperTrack Logistics app while you still consider building your own.

  • Live Location Sharing: Live location sharing has become a default expectation by users when waiting for people and orders on the way, be it ecommerce, deliveries, services, marketplaces, sharing economy, or logistics. HyperTrack is the easiest way to add live location sharing with ETA to your business. Get started with the open-sourced production-ready HyperTrack Live app while you still consider building your own.

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.