Backfill signals from the trailing window

POST

/api/v1/signals/backfill/run

const url = 'http://localhost:11044/api/v1/signals/backfill/run';
const options = {method: 'POST', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:11044/api/v1/signals/backfill/run \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Replay signals from every time-window ingestion source over the past N hours. Redeliveries are deduped, so this is safe to re-run.

Authorizations

apiKeyAuth
basicAuth

Parameters

Query Parameters

hours

number format: double

Lookback window in hours (e.g. 5 for the last 5 hours)

Responses

200

Backfill report with per-source results

*/*

The outcome of replaying the trailing window from every time-window ingestion source

object

durationMs

required

Wall-clock duration of the backfill in milliseconds

integer format: int64

results

required

One row per ingestion source, whether it ran or was skipped

Array<object>

What one ingestion source did during a backfill

object

detail

Why a source was skipped or failed; null when there is nothing to add

string

fetched

required

How many signals the source returned, before dedup

integer format: int32

published

required

How many of those were new and reached the bus. Re-running a backfill publishes only what was not seen before

integer format: int32

sourceName

required

The ingestion source’s name

string

status

required

Whether the source ran: a BackfillStatus name, such as Ok, Failed, or one of the Skipped reasons

string

since

required

The start of the replayed window, ISO-8601

string

username

required

The user the backfill ran for

string

400

Invalid lookback duration

*/*

A backfill that was refused or failed. Carries only the reason

object

error

required

Why: an out-of-range lookback, or the failure the backfill reported

string

500

Backfill failed

*/*

A backfill that was refused or failed. Carries only the reason

object

error

required

Why: an out-of-range lookback, or the failure the backfill reported

string