Overview

Contents

Introduction

Welcome to Radar! Radar is the location context platform. You can use Radar to add location context to your apps with just a few lines of code.

In this overview, we introduce the core concepts of Radar, including context types (Geofences, Places, Insights, and Regions) and developer tools (the SDK, the API, Integrations, and Toolkit apps).

The rest of the documentation explains these concepts in more detail.

Quickstart

Want to get started quickly? Follow these three steps:

  1. Start tracking. Integrate the SDK to start tracking users in the foreground or in the background. Or, before integrating the SDK, test with our Toolkit apps for iOS and Android.

  2. Add context. Add context by creating Geofences, enabling Places, enabling Insights, or enabling Regions.

  3. Handle context. In the foreground, change the in-app experience based on user context. In the background, listen for events using the SDK or Integrations.

In addition, see our industry playbooks for examples and inspiration:

Context types

The Radar platform has four context types: Geofences, Places, Insights, and Regions.

Geofences

Radar geofencing is more powerful than native iOS or Android geofencing, with cross-platform support for unlimited geofences, polygon geofences, and stop detection.

Geofences provides the following user context:

{
  geofences: [
    {
      _id: "56db1f4613012711002229fb",
      tag: "venue",
      externalId: "2",
      description: "Coffee Shop",
      metadata: {
        category: "coffee-shop"
      }
    },
    {
      _id: "56db1f4613012711002229fc",
      tag: "neighborhood",
      externalId: "3",
      description: "SoHo"
    }
  ]
}

Geofences also provides the following events:

  • user.entered_geofence
  • user.exited_geofence

Learn more about Geofences.

Places

Places detects when a user visits a place, chain, or category, even if you haven't set up geofences for those places.

Places provides the following user context:

{
  place: {
    _id: "5a631784f61757fe9bb9847a",
    name: "Starbucks",
    chain: {
      name: "Starbucks",
      slug: "starbucks",
      domain: "starbucks.com"
    },
    categories: [
      "food-beverage",
      "cafe",
      "coffee-shop"
    ],
    location: {
      type: "Point",
      coordinates: [
        -73.977797,
        40.783826
      ]
    }
  }
}

Places also provides the following events:

  • user.entered_place
  • user.exited_place

Learn more about Places.

Insights

Insights predicts a user's home and work locations and detects when a user is at home, at work, or traveling.

Insights provides the following user context:

{
  insights: {
    state: {
      home: false,
      office: false,
      traveling: true
    },
    locations: [
      {
        type: "home",
        coordinates: [
          -73.977797,
          40.783826
        ],
        confidence: 3
      },
      {
        type: "office",
        coordinates: [
          -73.977797,
          40.783826
        ],
        confidence: 3
    ]
  }
}

Insights also provides the following events:

  • user.entered_home
  • user.exited_home
  • user.entered_office
  • user.exited_office
  • user.started_traveling
  • user.stopped_traveling

Learn more about Insights.

Regions

Regions detects a user's country, state, DMA (media market), or postal code.

Regions provides the following user context:

{
  country: {
    code: "US",
    name: "United States"
  },
  state: {
    code: "MD",
    name: "Maryland"
  },
  dma: {
    code: "26",
    name: "Baltimore"
  },
  postalCode: {
    code: "21014"
  }
}

Regions also provides the following events:

  • user.entered_region_country
  • user.exited_region_country
  • user.entered_region_state
  • user.exited_region_state
  • user.entered_region_dma
  • user.exited_region_dma

Learn more about Regions.

Developer tools

You can integrate Radar with your apps using our developer tools: the SDK, the API, Integrations, and Toolkit apps.

SDK

Integrate the SDK into your iOS and Android apps to start tracking users and generating events. The SDK abstracts away cross-platform differences between location services on iOS and Android, allowing you to add location context and tracking to your apps with just a few lines of code.

Learn more about the SDK.

API

You can access all of your Radar data, including users, events, geofences, and places, via the API. You might use the API to list users in a specific geofence, or to create geofences programmatically.

Learn more about the API.

Integrations

Radar supports a number of server-side integrations. Event integrations like webhooks, mParticle, Segment, Braze, and Airship allow you to send events from Radar to other systems. Geofence integrations like Yext allow you to sync geofences from other systems to Radar.

Learn more about Integrations.

Toolkit

You can use our Toolkit apps for iOS and Android to test Radar before integrating the SDK, or to test your implementation of Radar side-by-side with a complete implementation.

Learn more about the Toolkit apps.

Support

Have questions after reading the documentation? Visit our Help Center. Still have questions? Click the button on the bottom right of any page to chat with us.