Indivd API Overview – Indivd

The Indivd API lets you pull visitor data directly into any system that can make an HTTP request. It exposes three data endpoints and five filter endpoints.

The API is built around two data models. The line-based model counts directional crossing events at individual camera boundaries, giving you raw traffic volumes at specific physical points. The zone-based model uses ReID technology to track anonymous visitor behaviour inside defined areas, enabling dwell time, bounce rate, unique visits, cross-visitation, and drop-in rate. If you are building an integration that goes beyond basic footfall counting, the zone-based endpoints are where the value is.

Included in: ✓ Indivd Basic ✓ Indivd Pro ✓ Indivd Complete

Related articles

This article contains the following topics:

Fundamentals
Base URLs
Data endpoints
Filter endpoints
Plan requirements
Service status
Getting started

Fundamentals

The API is REST-based and uses token authentication. All requests are GET requests. Responses are JSON. There is no SDK: you call the endpoints directly using any HTTP client.

All tokens are issued by Indivd. They are not generated self-serve from the platform. A token is scoped to the locations and organisations your account has access to. Requests for data outside that scope return an empty result set, not an error.

All timestamps in responses are in UTC unless you override the timezone using the tz parameter on zone visitors and drop-in-rate requests.

The three data endpoints split into two categories. line_crosses is the line-based endpoint: it returns raw crossing counts with no memory of individual visitors. zone_visitors and drop_in_rate are zone-based endpoints: they use ReID to return behavioural metrics. Understanding this distinction is essential before choosing which endpoint to query. For a full explanation, see How to query visitor data.

Base URLs

The API uses two base URLs depending on whether you are calling a data endpoint or a filter endpoint.

Data endpoints:

https://api.indivd.com/api/v1/rnd/insights/external/

Filter endpoints:

https://api.indivd.com/filters/

Data endpoints

There are three data endpoints. Each returns a different type of visitor data for a specified date range.

Endpoint	What it returns	Use when you need
`line_crosses`	Visitor counts at the level of individual counting lines	Raw traffic volumes by location, floor, zone, category, or line
`zone_visitors`	ReID-powered zone-level data: visits, unique visits, bounce count, dwell time, and cross-visitation	Behavioural metrics for a defined area. Unique visits, bounce rate, and dwell time require Indivd Pro.
`drop_in_rate`	The share of people passing a zone entrance who entered, based on passing-by lines and zone entry lines	Conversion rate of foot traffic to zone entry. Requires passing-by lines to be configured by Indivd.

For full parameter references, sample requests, and response field definitions for all three endpoints, see How to query visitor data.

Filter endpoints

Five filter endpoints return the integer IDs used to scope data requests. Retrieve these IDs before making data requests that filter by location, zone, category, line, or organisation.

Endpoint	What it returns
`locations`	All locations your token has access to, including opening hours and timezone
`zones`	All zones, including their bounce threshold settings
`categories`	All categories linked to your locations
`organisations`	All organisations your token has access to
`lines`	All counting lines, filterable by zone, category, floor, and location

For full request examples and response field definitions for all five filter endpoints, see How to use the Indivd filter endpoints.

Plan requirements

All three data endpoints and all five filter endpoints are available on Indivd Basic, Pro, and Complete. The following fields within the zone_visitors endpoint require Indivd Pro:

unique_visits
bounce
dwell_time
dwell_time_stats

These fields return empty or 0 on Basic plans. The drop_in_rate endpoint requires passing-by lines to be configured at your location before it will return data. Contact support@indivd.com to request configuration.

For plan information, contact your Indivd account contact or email support@indivd.com.

Service status

Indivd publishes live status and uptime history for all platform components at indivd.statuspage.io. The following components are monitored:

Component	What it covers
Backend	The data processing and API layer your requests hit
Frontend	The Indivd platform interface
Insights	The analytics engine that produces visitor data
Network	Connectivity between Indivd infrastructure components

If your integration stops returning data or returns unexpected errors, check the status page before investigating your own configuration. You can subscribe to incident notifications directly from the status page.

Getting started

Follow these articles in order to go from zero to a working integration:

Authentication : obtain your token and authenticate requests correctly
Make your first API call : retrieve real zone visitor data in a guided walkthrough
How to query visitor data : full parameter reference for all three data endpoints
How to use the Indivd filter endpoints : retrieve the IDs you need to scope your requests

For questions, contact support@indivd.com.