API documentation
Alert
Credit
- GETFetch credit block
- DELDelete credit block
- GETFetch customer credit balance by external customer id
- GETFetch customer credits ledger by external ID
- POSTCreate ledger entry by external ID
- GETList top-ups by external ID
- POSTCreate top-up by external ID
- DELDeactivate top-up by external ID
- GETFetch customer credit balance
- GETFetch customer credits ledger
- POSTCreate ledger entry
- GETList top-ups
- POSTCreate top-up
- DELDeactivate top-up
Customer
- GETList customers
- POSTCreate customer
- GETFetch customer by external ID
- PUTUpdate customer by external ID
- GETFetch customer costs by external ID
- POSTUpdate payment methods from payment provider
- GETFetch customer
- PUTUpdate customer
- DELDelete customer
- GETList balance transactions
- POSTCreate customer balance transaction
- GETFetch customer costs
- POSTUpdate payment methods from payment provider
Dimensional Price Group
Event
Invoice
Availability
Plan
- GETList plans
- POSTCreate plan
- GETFetch plan by external ID
- PUTUpdate plan by external ID
- POSTSet plan version as default by external ID
- POSTCreate plan version by external ID
- GETFetch plan version by external ID
- GETFetch plan
- PUTUpdate plan by id
- GETList migrations
- GETFetch migration
- POSTCancel migration
- POSTSet plan version as default
- POSTCreate plan version
- GETFetch plan version
Price
Subscription Change
Subscription
- GETList subscriptions
- POSTCreate subscription
- GETFetch subscription
- PUTUpdate subscription
- POSTCancel subscription
- GETFetch subscription costs
- POSTRedeem Coupon
- GETFetch subscription schedule
- POSTSchedule plan change
- POSTTrigger phase
- POSTUnschedule subscription cancellation
- POSTUnschedule fixed fee quantity updates
- POSTUnschedule plan change
- POSTUpdate price quantity
- POSTUpdate trial for subscription
- GETFetch subscription usage
Price interval
curl --request GET \
--url https://api.withorb.com/v1/events/backfills \
--header 'Authorization: Bearer <token>'{
"data": [
{
"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>",
"replace_existing_events": true,
"deprecation_filter": "my_numeric_property > 100 AND my_other_property = 'bar'"
}
],
"pagination_metadata": {
"has_more": true,
"next_cursor": "<string>"
}
}List backfills
This endpoint returns a list of all backfills in a list format.
The list of backfills is ordered starting from the most recently created backfill. The response also includes
pagination_metadata, which lets the caller retrieve the next page of results if they
exist. More information about pagination can be found in the Pagination-metadata schema.
curl --request GET \
--url https://api.withorb.com/v1/events/backfills \
--header 'Authorization: Bearer <token>'{
"data": [
{
"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>",
"replace_existing_events": true,
"deprecation_filter": "my_numeric_property > 100 AND my_other_property = 'bar'"
}
],
"pagination_metadata": {
"has_more": true,
"next_cursor": "<string>"
}
}Authorizations
API Keys can be issued in the Orb's web application.
Query Parameters
The number of items to fetch. Defaults to 20.
1 <= x <= 100Cursor for pagination. This can be populated by the next_cursor value returned from the initial request.
Response
OK
Show child attributes
Show child attributes
The status of the backfill.
pending, reflected, pending_revert, reverted The number of events ingested in this backfill.
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.
The time at which this backfill was reverted.
The Orb-generated ID of the customer to which this backfill is scoped. If null, this backfill is scoped to all customers.
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.
A boolean computed property used to filter the set of events to deprecate
"my_numeric_property > 100 AND my_other_property = 'bar'"
Was this page helpful?