API
The Odyssey Signal API: authentication and API keys, plans, credits and limits, errors and the full reference.
- AuthenticationHow to authenticate to the Signal API with an API key: creating, sending, replacing and revoking keys, and what to do when a request is refused.
- Rate limitingHow the Signal API limits requests per API key, the rate-limit headers on every response, the 429 answer, and how to handle limits in your code.
- ErrorsHow the Signal API reports errors: the problem format, every error type, refusals and rate-limit headers, and how to handle them.
- API versions and changesHow the Signal API is versioned, which changes can happen within a version, and how we tell you before an older version stops working.
- API changelogEvery change to the Signal API, newest first, with the date it was released.
- API referenceEvery endpoint of the Signal API, generated from its OpenAPI document.
Reference: Organizations
Reference: Signals
- List signalsList the Signals this credential may read
- Get signalDescribe one Signal, with its DataSources
- List datasourcesList the DataSources on a Signal
- Get datasourceDescribe one DataSource: its type and the DataSets available on it
- Get datasetDescribe one DataSet: its dimensions, period and where its metrics are
- List entitiesList the brands this DataSource carries, by brand list
- List driversList the drivers this DataSource is configured with, by brand list
- List periodsList when this DataSource has data, in total and per DataSet
- List metricsList the metrics on a DataSet, with their groups
- Get dimension valuesList what a dimension can be filtered to