Skip to main content
POST
/
events
/
backfills
Create backfill
curl --request POST \
  --url https://api.withorb.com/v1/events/backfills \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "replace_existing_events": true,
  "timeframe_start": "2023-11-07T05:31:56Z",
  "timeframe_end": "2023-11-07T05:31:56Z",
  "close_time": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "external_customer_id": "<string>",
  "deprecation_filter": "my_numeric_property > 100 AND my_other_property = '\''bar'\''"
}'
{
  "id": "<string>",
  "status": "pending",
  "created_at": "2023-11-07T05:31:56Z",
  "timeframe_start": "2023-11-07T05:31:56Z",
  "timeframe_end": "2023-11-07T05:31:56Z",
  "events_ingested": 123,
  "close_time": "2023-11-07T05:31:56Z",
  "reverted_at": "2023-11-07T05:31:56Z",
  "customer_id": "<string>",
  "deprecation_filter": "my_numeric_property > 100 AND my_other_property = 'bar'",
  "replace_existing_events": true
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
timeframe_start
string<date-time>
required

The (inclusive) start of the usage timeframe affected by this backfill. By default, Orb allows backfills up to 31 days in duration at a time. Reach out to discuss extending this limit and your use case.

​
timeframe_end
string<date-time>
required

The (exclusive) end of the usage timeframe affected by this backfill. By default, Orb allows backfills up to 31 days in duration at a time. Reach out to discuss extending this limit and your use case.

​
replace_existing_events
boolean
default:true

If true, replaces all existing events in the timeframe with the newly ingested events. If false, adds the newly ingested events to the existing events.

​
close_time
string<date-time> | null

The time at which no more events will be accepted for this backfill. The backfill will automatically begin reflecting throughout Orb at the close time. If not specified, it will default to 1 day after the creation of the backfill.

​
customer_id
string | null

The Orb-generated ID of the customer to which this backfill is scoped. Omitting this field will scope the backfill to all customers.

​
external_customer_id
string | null

The external customer ID of the customer to which this backfill is scoped. Omitting this field will scope the backfill to all customers.

​
deprecation_filter
string | null

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

Examples:

"my_numeric_property > 100 AND my_other_property = 'bar'"

"my_property = 'foo'"

Response

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<date-time>
required
​
timeframe_start
string<date-time>
required
​
timeframe_end
string<date-time>
required
​
events_ingested
integer
required

The number of events ingested in this backfill.

​
close_time
string<date-time> | 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<date-time> | 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

Examples:

"my_numeric_property > 100 AND my_other_property = 'bar'"

"my_property = 'foo'"

⌘I