Entities
Dimensional breakdown (axis/member) of a metric for one period
Returns the segment cuts an issuer reported for one metric at one period : revenue/profit by geography, business segment, product line, etc. Each axis carries its members with the reported value, sorted by magnitude.
Reads the dimensional values the issuer reported. axes=[] when the entity exists but the issuer did not tag the metric dimensionally for that period ; 404 when the entity does not exist.
DIFFERENT from /entities/{id}/decomposition (XBRL calc linkbase children).
get/api/v1/entities/{entity_id}/segments/{hub_concept_code}
Request
- Base URL: https://api.hub-equity.com
- URL: https://api.hub-equity.com/api/v1/entities/{entity_id}/segments/{hub_concept_code}
- Auth: HTTP bearer
Path parameters
entity_idstring required
hub_concept_codestring required
Query parameters
fiscal_yearinteger required
Fiscal year (e.g. 2024).
fiscal_period_typestring
FY (default, annual), Q1-Q4, or H1/H2.
Response
The dimensional breakdown for the metric.
Changes
No recorded changes to this operation across all 1 revision of this API.