List company KPI model results

get

https://analytics.api.exabel.com/v1/entityTypes/company/entities/{companyId}/kpiModelResults

Returns all models for a given company KPI. This includes: all single-predictor models derived from each individual KPI mapping; the Exabel model that is an automatic ensemble of the best single-predictor models; any custom models you train; and the hierarchical model (if available) that harmonizes model predictions across a company's KPIs as the final modeling layer.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

companyId

string

required

[\w+\.]?\w[\w-]{0,63}

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

kpi.type

string

enum

required

The type of the KPI.

Allowed:

kpi.value

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.

kpi.displayName

string

The display name of the KPI.

kpi.freq

string

enum

required

A textual representation of the KPI frequency.

Allowed:

kpi.isRatio

boolean

Whether this KPI is a ratio or not.

Responses

200A successful response.

defaultAn unexpected error response.