User GuideAPI ReferenceWhat's NewChangelog
API Reference

List company KPI mapping results

get
https://analytics.api.exabel.com/v1/entityTypes/company/entities//kpiMappingResults

Returns the statistical test results of all KPI mappings for a given company KPI. This is provided as a list of KPI mappings, each with the model backtest MAPE/MAE, correlation scores, MAEs, and p-values.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of a company, e.g. F_002LGW-E. The company ID is the last element of the entity resource name for a company. The company ID must match the regex \w[\w-]{0,63}.

Query Params
string
enum
required

The type of the KPI.

Allowed:
string
required

A value which is dependent on the type:

  • FACTSET_ESTIMATES: Reporting number, e.g. SALES.
  • FACTSET_FUNDAMENTALS: Reporting number, e.g. SALES.
  • FACTSET_SEGMENTS: Factset segment resource name, e.g. entityTypes/geo_segment/entities/factset.segment_123.
  • VISIBLE_ALPHA_STANDARD_KPI: Line item parameter id. For example, the "Total revenue" parameter has a parameter id of 190.
  • CUSTOM_KPI: Custom KPI id. For example, 1234.
string

The display name of the KPI.

string
enum
required

A textual representation of the KPI frequency.

Allowed:
boolean

Whether this KPI is a ratio or not.

Responses

Updated 24 days ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 24 days ago