Audience API (Preview)

Public API allowing access to audience members' data

Audience API is for preview and cannot yet be used in production.

Audience API is the interface to individual audience members' data in the Monterosa / Interaction Cloud. It acts as a layer above internal services that provide profiles, gamification and rewards amongst other functions.

This API is being developed rapidly to encompass more services over time, enabling a single touchpoint — for example, the full internal Audience Profile and other audience data.

Audience API and Spaces

A dedicated instance of Audience API is deployed for each Space and is made available via the Space Domain. That means you will need to when making calls to the API as documented below.

Features of Audience API may differ from one Space to another depending on the Space configuration, so not every example in this documentation will work within your Space.

Audience API and SDK

Monterosa / Interaction SDK wraps access to most of the Audience API features and implements hygiene functions such as authentication, error handling and failure recovery. Although accessing Audience API directly from your application code is possible, it is discouraged for high-volume public clients.

Accessing the Audience API endpoints

The Audience API is deployed publicly, no special network configuration is required to access it.

Absolute paths of the API endpoints stay the same across different Space Domains. E.g. a user profile endpoint will always be available at the path /api/profile , which means the full URL will look like this:

https://your.space.domain/api/profile

Last updated