Glossary

Account

The area of the platform that contains your account information, your personal settings, company data (such as site IDs), and developer data (such as usage tokens, API keys, and app IDs).

ARRIVE

A service that enables developers to detect when one of their users is about to reach a physical destination and to take action in response. The ability to accurately detect not only where a user is, but to predict when the user is about to arrive, sets ARRIVE apart from traditional approaches to location detection. Consequently, the ARRIVE service opens up a broad range of uses that would not otherwise work due to the low accuracy and poor reliability of other solutions.

ARRIVE Console

An enterprise app developed by Curbside to monitor trips and notify upon arrival. Available for iOS and Android.

ARRIVE Dashboard

A web application that provides insight into the user's journey (via the user’s mobile app). Supplies real-time data and statistics on both the macro and site levels. The ARRIVE server collects the data automatically without the need for additional coding.

ARRIVE REST API

The REST API can be used to manage the lifecycle of trips, and can also be used to integrate monitor app capabilities into existing on-site applications such as point of sale (POS).

ARRIVE Server

Communicates with the mobile and monitor apps. Receives data, including location data from the mobile app, that it process and analyzes. Makes a constant determination about whether and when trips are approaching. The ARRIVE server also calculates ETA, trip status, and other information, and triggers notifications to the monitor app and ARRIVE dashboard.

ARRIVE SDK

Used to build the mobile and monitor apps. There are iOS and Android versions of the SDK.

API Key

A secret credential used for non-interactive communication with the Curbside Platform. Unlike usage tokens, API keys must be kept secret and should never be embedded in applications released to public app stores or embedded in publicly accessible source code.

App ID

A unique application identifier. Android apps call this a bundle ID or a Play Store package name. iOS apps call this the application's bundle identifier. For REST API calls, use an identifier that is unique to your server.

Cancel Trip

A method to cancel a trip that is called in the ARRIVE SDK or REST API. The call is initiated from the monitor or mobile app. Once a trip has been cancelled, it cannot be restarted.

This table lists the names for the term described above:

iOS SDK cancelTripToSiteWithIdentifier or cancelTripForTrackingIdentifier
Android SDK cancelTripToSiteWithIdentifier
REST API cancel_track

Cancelled Trip

A trip that was cancelled, usually in response to a mobile app user action or unforeseen conditions at the destination site. The dashboard shows statistics for cancelled trips.

Complete Trip

A method to complete a trip that is called in the ARRIVE SDK or REST API. The call is initiated from the monitor app. Once a trip has been completed, it cannot be restarted. To calculate wait time, see Measure Wait Time.

This table lists the names for the term described above:

iOS SDK completeTripForTrackingIdentifier
REST API stop_track

Completed Trip

A trip that was marked completed by the monitor app. A completed trip is considered to be a successful trip. The dashboard shows statistics for completed trips.

Curbside Platform

A suite of technology to create unique and time-saving user experiences that marry the digital and the physical worlds. ARRIVE location technology can optionally be paired with Curbside's other products CONNECT, FULFILL and ENGAGE to create a complete solution for connecting bricks and mortar locations for mobile commerce. Contact sales to find out more.

Destination

Synonym for site.

Distance

The distance of a trip, which is the distance of the route that a user took from the first location report to the site. The dashboard shows the statistics for the trip distance.

Duration

The amount of time a trip took from the moment it was started to when it was cancelled or completed. The dashboard shows statistics for trip duration.

Dwell Time

Time user spends at a site.

Environment

A container that segregates production data from non-production data. Each account has two containers:

  • Production environment -- Intended for production applications and actual use (deployment)
  • Non-production or sandbox environment -- Intended for evaluation, development, and testing

Mobile App

An app that generates trip data, which includes location data that is sent to the ARRIVE server. A developer can build a mobile app using the ARRIVE SDK.

Mobile App User

The user of the mobile app, which generally refers to a customer of a store, a restaurant, or a place of business.

Monitor App

An app that receives trip data for its sites from the ARRIVE server. A developer can build a monitor app using the ARRIVE SDK or REST API.

Monitor App User

The user of the monitor app. In many cases, the user refers to the store personnel.

Open Trip

A trip that has been started but has not been cancelled or completed.

Production

A term that refers to the production environment.

Sandbox

A term that refers to the non-production environment.

Site

A physical location near a road network such as a store, a restaurant, or a place of business. Each trip has one site as its destination, which is why sites are sometimes called destinations.

This table lists the names for the term described above:

iOS SDK siteIdentifier
Android SDK siteIdentifier
REST API site_csin

Start Trip

A method to start a trip that is called in the ARRIVE SDK. The call is initiated from the mobile app.

This table lists the names for the term described above.
iOS SDK: startTripToSiteWithIdentifier
Android SDK: [startTripToSiteWithIdentifier]/docs/reference/android/com/curbside/sdk/CSUserSession.html

Started Trip

The initial trip state and the beginning of the trip lifecycle. The dashboard shows statistics for started trips.

Track Token

A piece of data that uniquely identifies a trip. Track tokens must be unique among trips. Failure to do so returns an error when starting a trip. A track token has a maximum of 60 characters. Suitable tokens include reservation numbers, order IDs, or any similar piece of data that is generated to identify a business transaction.

This table lists the names for the term described above:

iOS SDK trackToken
Android SDK trackToken
REST API track_token

Tracking Identifier

An ID that uniquely identifies a mobile app user. Different trips with the same tracking identifier are, by definition, trips that are taken by the same user. Suitable identifiers include UUIDs, collision-resistant hashes, or user IDs.

This table lists the names for the term described above:

iOS SDK trackingIdentifier
Android SDK trackingIdentifier
REST API tid

Trip

A mobile app user's movement (tracked by the mobile app) through the physical world from an arbitrary starting location to an agreed-upon site. Trips are the primary artifact of the Curbside Platform and a central component of the user experience and the analytics. A trip has a lifecycle with a beginning and an end.

Trip Status

An estimate of the mobile app user's current intent as it relates to arriving at the site of a trip. There are three arrival statuses:

  • In Transit: The mobile app user is on the move and the ARRIVE server has recently received a report of the user's location.
  • Approaching: The mobile app user is approaching the site.
  • Arrived: The mobile app user has arrived at the site.

Usage Token

Public, non-secret credential used for non-interactive communication with the Curbside Platform. Usage tokens are not a security mechanism but are used for metering and account identification. They can be embedded into apps released to public app stores or in publicly available source code. See API key.

User

Refers to a mobile app user.

Wait Time

The time a mobile app user spends waiting after arriving at a site and before being acknowledged by a monitor app user. Acknowledgment is use-case specific but commonly includes scanning a barcode or verifying a piece of information on the mobile app user's device. It is the responsibility of the developer to indicate the time of acknowledgment using the ARRIVE SDK so that the wait time can be calculated.

Wait time in the ARRIVE dashboard is the median over the past 30 days.

Webhooks

Used to receive events from the ARRIVE server. For more information, see our Webhooks guide.