Return auditable metric time series from stored observations and transaction reconstruction.

Return auditable metric time series from stored observations and transaction reconstruction. Flow metrics expose summary.total_by_currency for the requested period and null start/end/change balance fields. Investment values before available valuation history remain unavailable.

get/v1/metrics/history

Request

  • Base URL: https://api.candor.money
  • URL: https://api.candor.money/v1/metrics/history
  • Auth: HTTP bearer

Query parameters

metricstring

Which metric to return.

range'week' | 'month' | '3m' | 'ytd' | 'year'

How far back to read.

granularity'day' | 'week' | 'month'

Bucket size for the series.

currencystring

Restrict to this ISO currency code.

Response

Envelope with metric buckets, provenance, freshness, coverage, caveats, and basis handles.

schema_versionstring required
generated_atstring date-time required
request_idstring required
status'success' | 'partial_success' | 'action_required' | 'error' required
user_messagestring

Optional concise user-safe message the calling agent may adapt.

warningsobject[] required
dataobject nullable required

Operation-specific result data, or null when the request ends in an error.

Changes

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