Sign in
metrics

Get Metric Definition

Return the semantic definition of one metric — contract facts + prose (PR 32).

get/api/v1/metrics/{source}/{ref}

Path parameters

sourcestring required
refstring required

Response

Successful Response

source_kind'standard' | 'platform_calculation' | 'evaluated' | 'calculated' required
refstring required
labelstring required
calculation_kindstring nullable
entitystring nullable
formatstring nullable
time_dimensionstring nullable
aggregation_behaviorstring nullable
polarity'higher_is_better' | 'lower_is_better' | 'neutral' nullable
grouping_behaviorstring nullable
drill_kindstring nullable
contribution_identifierstring nullable
source_entitystring nullable
scope_rulesstring[]
display_expressionstring nullable
expressionobject nullable
disclosuresstring[]
zero_divisionstring nullable
statusstring
versioninteger nullable
superseded_bystring nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.