POST
/
events
/
backfills
/
{backfill_id}
/
close

Authorizations

​
Authorization
string
header
required

API Keys can be issued in the Orb's web application.

Path Parameters

​
backfill_id
string
required

Response

200
application/json
OK

A backfill represents an update to historical usage data, adding or replacing events in a timeframe.

​
id
string
required
​
status
enum<string>
required

The status of the backfill.

Available options:
pending,
reflected,
pending_revert,
reverted
​
created_at
string
required
​
timeframe_start
string
required
​
timeframe_end
string
required
​
events_ingested
integer
required

The number of events ingested in this backfill.

​
close_time
string | null
required

If in the future, the time at which the backfill will automatically close. If in the past, the time at which the backfill was closed.

​
reverted_at
string | null
required

The time at which this backfill was reverted.

​
customer_id
string | null
required

The Orb-generated ID of the customer to which this backfill is scoped. If null, this backfill is scoped to all customers.

​
replace_existing_events
boolean
required

If true, existing events in the backfill's timeframe will be replaced with the newly ingested events associated with the backfill. If false, newly ingested events will be added to the existing events.

​
deprecation_filter
string | null

A boolean computed property used to filter the set of events to deprecate

Was this page helpful?

Fetch backfillRevert backfill