InReality API Technical Overview

API User Guide - Overview

The InReality API User Guide is available in an online application. It is available to all customers who
have purchased the Analytics package.

The API User Guide Overview provides a technical overview of the interface.

API Overview

InReality offers an extensive data extraction API (Application Programming Interface) for our customers
and partners to access their venue metrics from InReality’s platform to integrate into your own Business
Intelligence (BI) platform or Visualization tools.

Our API calls are RESTful API and JSON objects as the data input and output formats. JSON is a
lightweight data-interchange format. Our platform uses the RESTful rules by using GET, POST, PUT,
DELETE for data exchange. The API requests require HTTPS connections and API Key authentication.

Types of Data

Aggregated Data is grouped on a daily basis. This means that if a Unique ID is seen multiple times, the
sum of their dwell times (for Presence or Demographics) is presented in a single event record.

Non-Aggregated Data is not grouped/aggregated at all. This means that if a Unique ID is seen multiple
times, each unique event will be shown as a new record but will retain the same Unique ID.

Authentication

In this API version, we use an API Key as the authentication method which makes our APIs very easy
to access. You can obtain your API key in the account settings page of our V3 platform.

API Key

You must add the api_key query parameter in order to use the APIs listed in this document.
Example: https://api.inreality.com/v3.1/stores?api_key=your-api-key

Aggregated Data

Return correlated data in csv format. You should specify the type of data that you want to retrieve.
Example: https://api.inreality.com/v3.1/data/correlated/type/csv?api_key=your-api-key

Awareness - Demographics Aggregated Data

Example: https://api.inreality.com/v3.1/data/correlated/demographics/csv?api_key=your-api-key

Audience - Traffic Aggregated Data

Example: https://api.inreality.com/v3.1/data/correlated/traffic/csv?api_key=your-api-key

Audience - Presence Aggregated Data

Example: https://api.inreality.com/v3.1/data/correlated/presence/csv?api_key=your-api-key

Engagement - Door Open Aggregated Data

Example: https://api.inreality.com/v3.1/data/correlated/door_open/csv?api_key=your-api-key

Engagement - NFC Product Interaction Aggregated Data

Example: https://api.inreality.com/v3.1/data/correlated/product_interaction_nfc/csv?api_key=your-api-key

Awareness - Repeat Visitor Aggregated Data

Example: https://api.inreality.com/v3.1/data/correlated/repeat_visitor/csv?api_key=your-api-key

Areas of Interest

Base URL: https://api.inreality.com/v3.1/aois

Query List of AOIs - Return list of areas of interest.

Example: https://api.inreality.com/v3.1/aois?api_key=your-api-key

Query Details of an AOI - Return a single area of interest by specifying the id in URL.

Example: https://api.inreality.com/v3.1/aois/5cf78dfcca633f17f398c1f3?api_key=your-api-key

Venues

Base URL: https://api.inreality.com/v3.1/stores

Query List of Venues - Return list of venues.

Example: https://api.inreality.com/v3.1/stores?api_key=your-api-key

Query Details of a Venue - Return a single venue by specifying the id in the URL.

Example: https://api.inreality.com/v3.1/stores/5cf78dfcca633f17f398c1f3?api_key=your-api-key

Controllers

Base URL: https://api.inreality.com/v3.1/controllers

Query Details of a Controller - Return a single master/sensor controller by specifying the id in URL. The cloud id to be retrieved from the Store API.

Example: https://api.inreality.com/v3.1/controllers/5cf78dfcca633f17f398c1f3?api_key=your-api-key