Run analysis and access results
The Analytics API allows you to run analysis and access results.
Authentication
Authentication is available via both customer-level API key as well as user-level API access tokens.
API keys should be passed with the x-api-key header, while access tokens should be passed with bearer auth. On the page for each API endpoint, you can switch between the 2 in the top-right of the page.
Which should you use?
Customer-level API keys operate as the service account user, which has access only to data sets (owned & subscribed) that are available to the entire customer, as well as derived signals / KPI models / etc that are shared with the entire customer.
User-level API access tokens allow the API to operate as the user who created the token. This is particularly useful for accessing custom KPI models, signals and watchlists that may be private to that user (or not shared with all users).
Examples:
curl --request GET \
--url 'https://analytics.api.exabel.com/v1/entityTypes/company/entities/F_002LGW-E/baseModelResults' \
--header 'accept: application/json' \
--header 'x-api-key: xxx'
curl --request GET \
--url 'https://analytics.api.exabel.com/v1/entityTypes/company/entities/F_002LGW-E/baseModelResults' \
--header 'accept: application/json' \
--header 'authorization: Bearer xxx'
Services
KpiService : Retrieve KPI model predictions for companies, as well as KPI mapping results (backtests and correlations) on data sets that Exabel has mapped.
DerivedSignalService: Create and manage derived signals, which are signal expressions for querying, transforming and aggregating time series data. Note: to actually evaluate the signal expressions and retrieve the resulting time series, use the Export API.
TagService: Tags are better known as watchlists in the Exabel app user interface. This allows you to create and manage tags, as well as add/remove companies and entities from them.
PredictionModelService (LEGACY): Programatically trigger runs of prediction models.
Legacy feature: prediction models
Prediction models have been replaced by KPI models in the Exabel app