Skip to main content

RefreshAllSeriesResponse

Response from POST /api/v1/series/refresh-all. Mirrors the triggered/skipped pattern used by the source and provider trigger endpoints. batchSize echoes the config value the spawned tick will use, so the operator can see at a glance how much work was queued.

batchSizeinteger<int32>required

Maximum number of series rows this tick will touch, copied from metadata.series_refresh.batch_size. Reported even on skipped: true so the UI can render consistent metadata.

Possible values: >= 0

minAgeDaysinteger<int32>required

Minimum age in days a row must have before it's eligible. Echoes metadata.series_refresh.min_age_days, or 0 for a scope = "all" drain (which ignores the floor).

Possible values: >= 0

providerstringrequired

Active provider id the refresh ran against.

scopestringrequired

"settings" for a single, settings-bounded tick (honors batch_size + min_age_days); "all" for a drain that re-fetches every eligible row in repeated batches, ignoring min_age_days.

skippedbooleanrequired

true when a previous refresh tick is still in flight; the request is a no-op.

triggeredbooleanrequired
RefreshAllSeriesResponse
{
  "batchSize": 0,
  "minAgeDays": 0,
  "provider": "string",
  "scope": "string",
  "skipped": true,
  "triggered": true
}