Sign in

v49

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-081445491.8 MB
Event

Close backfill

Closing a backfill makes the updated usage visible in Orb. Upon closing a backfill, Orb will asynchronously reflect the updated usage in invoice amounts and usage graphs. Once all of the updates are complete, the backfill's status will transition to reflected.

post/events/backfills/{backfill_id}/close

Path parameters

backfill_idstring required

Response

OK

idstring required
status'pending' | 'reflected' | 'pending_revert' | 'reverted' required

The status of the backfill.

created_atstring date-time required
timeframe_startstring date-time required
timeframe_endstring date-time required
events_ingestedinteger required

The number of events ingested in this backfill.

close_timestring date-time nullable 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_atstring date-time nullable required

The time at which this backfill was reverted.

customer_idstring nullable required

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

deprecation_filterstring nullable

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

replace_existing_eventsboolean 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.

Example response

{
  "deprecation_filter": "my_numeric_property > 100 AND my_other_property = 'bar'"
}