Request an explicit provider-backed metric refresh when freshness warrants the cost.

Request an explicit provider-backed metric refresh when freshness warrants the cost.

post/v1/metrics/refresh

Request

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

Headers

Idempotency-Keystring required

Stable opaque identity for one logical POST. Reuse only with the same method, path, actor, and body for transport retries. A completed receipt replays its original result, including a refusal; changed input with the same key is rejected. After a refused action and access recovery, use a new key for the new attempt. Follow retryable and recovery guidance if the operation is still running or its outcome is unknown.

Request body

metricstring
range'week' | 'month' | '3m' | 'ytd' | 'year'
policy'if_stale' | 'if_missing' | 'force' | 'never'
max_provider_callsinteger
source_connection_idstring

The source connection this concerns.

connection_idstring
reasonstring

Response

Envelope with provider call budget, skip reason, sync summary, and follow-up history command.

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.