User GuideAPI ReferenceDSLWhat's NewChangelog
API Reference

List company hierarchical model results

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

Returns results for all modeled KPIs for the given company. This is provided as a list of KPIs, with the latest model predictions and metadata for each KPI.

Hierarchical models build on top of the base models by harmonizing their predictions with knowledge of each company's financial model, e.g. Total revenue = Segment A + Segment B + ... This produces more accurate predictions that are coherent across all segments. Note that consensus may be used for KPIs for which you have no alternative data; this is denoted in the metadata. Hierarchical models are only available for some companies - contact [email protected] with requests.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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
string
enum
Defaults to RELATIVE_FISCAL_PERIOD_SELECTOR_UNSPECIFIED

Relative fiscal period.

  • RELATIVE_FISCAL_PERIOD_SELECTOR_UNSPECIFIED: Unspecified.
  • PREVIOUS: Last reported fiscal period.
  • CURRENT: Current unreported fiscal period.
  • NEXT: Next unreported fiscal period.
Allowed:
integer

The date's year.

integer

The month of the year; must be between 1 and 12 inclusive.

integer

The day of the month, starting at 1; the day, month and year combined must define a valid calendar date.

string
enum

Fiscal period frequency. Must be set if period_end is specified. If empty, frequency is determined based on KPI counts. The frequency with the most number of KPIs with mappings for the user is used.

Allowed:
string
enum
Defaults to KPI_SOURCE_UNSPECIFIED

This field is no longer in use.

  • KPI_SOURCE_UNSPECIFIED: Unspecified.
  • KPI_SOURCE_VISIBLE_ALPHA: Visible Alpha.
  • KPI_SOURCE_FACTSET: FactSet.
  • KPI_SOURCE_CUSTOM_KPI: Custom KPI.
Allowed:
Responses

Updated 2 months ago

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

Updated 2 months ago

Did this page help you?