View as Markdown

Console API

The Satori Console API is the programmatic equivalent of the Satori console: the management API for your instance. It exposes the same capabilities the console offers, including managing flags, audiences, experiments, live events, message schedules and templates, metrics, schemas, webhooks, integrations, and users, as well as importing and exporting data and sending messages directly. It’s a privileged, server-side API intended for your backend and tooling.

Changes made through the Console API, such as updating identity properties, aren’t tied to a player session. They don’t generate analytics events (for example, _propertiesUpdate) and don’t count toward your event usage.

When you update an identity’s properties through the Console API:

  • Computed properties don’t change.
  • The change doesn’t appear in the player’s event history or your data lake exports. It’s recorded in the audit log.
  • Feature flags, live events, and experiments use the new property values the next time the player’s client makes a request.
  • Stored audience memberships and audience counts update on the next scheduled audience recompute, which runs every 10 minutes by default.

Authentication #

To communicate with the Satori Console API you must use a Server key.

Server keys are passed as the username in a HTTP Basic Authentication header, with an empty password:

1

Authorization: Basic <base64(server_key:)>

For example, if your server key is my_server_key_123, you would base64 encode my_server_key_123: (note the trailing colon for the empty password) and use it in the header:

1
2

curl -X GET "https://api.satori.io/v1/console/..." \
  -H "Authorization: Basic bXlfc2VydmVyX2tleV8xMjM6"
Server keys and API keys are not interchangeable. See API keys to learn more about the differences.

API Reference #