API reference

Browse the endpoints for the Real-time API and the Amperity API, read their request and response schemas, and send requests from this page. Choose an API from the list at the top of the page. To send a request, click Authorize and enter an access token. Then click Try it out on any endpoint, and enter your tenant ID in amperity-tenant, or Amperity-Tenant for the Amperity API. For the Amperity API, also enter the API version in Api-Version: 2024-04-01, or unstable for unstable endpoints. Click Download OpenAPI spec to load an API into your own API client, such as Postman or Insomnia, or to generate client code. To get an access token and find your tenant ID, see How to authenticate with Amperity APIs.

Note

Before using the Real-time API to create a profile collection, an event stream, or a real-time segment, you must contact your Amperity representative to enable real-time product features.