> ## Documentation index
> Fetch the complete documentation index at: https://docs.odysseysignal.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API

> The Odyssey Signal API: authentication and API keys, plans, credits and limits, errors and the full reference.

- [Authentication](https://docs.odysseysignal.com/api/authentication.md): How 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 limiting](https://docs.odysseysignal.com/api/rate-limiting.md): How 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.
- [Errors](https://docs.odysseysignal.com/api/errors.md): How the Signal API reports errors: the problem format, every error type, refusals and rate-limit headers, and how to handle them.
- [API versions and changes](https://docs.odysseysignal.com/api/api-versioning.md): How the Signal API is versioned, which changes can happen within a version, and how we tell you before an older version stops working.
- [API changelog](https://docs.odysseysignal.com/api/api-changelog.md): Every change to the Signal API, newest first, with the date it was released.
- [API reference](https://docs.odysseysignal.com/api/reference.md): Every endpoint of the Signal API, generated from its OpenAPI document.

## Reference: Organizations

- [List organizations](https://docs.odysseysignal.com/api/reference/list-organizations.md): List the organizations behind the Signals this credential reads

## Reference: Signals

- [List signals](https://docs.odysseysignal.com/api/reference/list-signals.md): List the Signals this credential may read
- [Get signal](https://docs.odysseysignal.com/api/reference/get-signal.md): Describe one Signal, with its DataSources
- [List datasources](https://docs.odysseysignal.com/api/reference/list-datasources.md): List the DataSources on a Signal
- [Get datasource](https://docs.odysseysignal.com/api/reference/get-datasource.md): Describe one DataSource: its type and the DataSets available on it
- [Get dataset](https://docs.odysseysignal.com/api/reference/get-dataset.md): Describe one DataSet: its dimensions, period and where its metrics are
- [List entities](https://docs.odysseysignal.com/api/reference/list-entities.md): List the brands this DataSource carries, by brand list
- [List drivers](https://docs.odysseysignal.com/api/reference/list-drivers.md): List the drivers this DataSource is configured with, by brand list
- [List periods](https://docs.odysseysignal.com/api/reference/list-periods.md): List when this DataSource has data, in total and per DataSet
- [List metrics](https://docs.odysseysignal.com/api/reference/list-metrics.md): List the metrics on a DataSet, with their groups
- [Get dimension values](https://docs.odysseysignal.com/api/reference/get-dimension-values.md): List what a dimension can be filtered to

## Reference: Query

- [Run query](https://docs.odysseysignal.com/api/reference/run-query.md): Ask one DataSet a question
- [Run map](https://docs.odysseysignal.com/api/reference/run-map.md): Everything needed to draw one of the DataSet's maps

## Reference: Maps

- [Get map guide](https://docs.odysseysignal.com/api/reference/get-map-guide.md): How to draw one type of map
- [Get map guide image](https://docs.odysseysignal.com/api/reference/get-map-guide-image.md): A picture of one type of map, drawn by the reference drawing