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.
Query Parameters
Possible values: >= 1
and <= 1000
Default value: 20
- 200
- 400
- 401
- 404
- 409
- 413
- 429
- 500
OK
Response Headers
Schema
- Array [
- ]
data object[] required
Possible values: [pending
, reflected
, pending_revert
, reverted
]
The status of the backfill.
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.
A boolean computed property used to filter the set of events to deprecate
pagination_metadata object required
{
"data": [
{
"id": "string",
"status": "pending",
"created_at": "2024-12-20T17:17:31.934Z",
"timeframe_start": "2024-12-20T17:17:31.934Z",
"timeframe_end": "2024-12-20T17:17:31.934Z",
"events_ingested": 0,
"close_time": "2024-12-20T17:17:31.934Z",
"reverted_at": "2024-12-20T17:17:31.934Z",
"customer_id": "string",
"deprecation_filter": "my_numeric_property > 100 AND my_other_property = 'bar'"
}
],
"pagination_metadata": {
"has_more": true,
"next_cursor": "string"
}
}
Bad Request
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#400-constraint-violation
]
Possible values: [400
]
Possible values: [https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation
]
Possible values: [400
]
Possible values: [https://docs.withorb.com/reference/error-responses#400-request-validation-errors
]
Possible values: [400
]
{}
Unauthorized
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#401-authentication-error
]
Possible values: [401
]
{
"type": "https://docs.withorb.com/reference/error-responses#401-authentication-error",
"status": 401,
"detail": "string",
"title": "string"
}
Not Found
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#404-feature-not-available
]
Possible values: [400
]
Possible values: [https://docs.withorb.com/reference/error-responses#404-resource-not-found
]
Possible values: [404
]
Possible values: [https://docs.withorb.com/reference/error-responses#404-url-not-found
]
Possible values: [404
]
{}
Conflict
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#409-resource-conflict
]
Possible values: [409
]
{
"type": "https://docs.withorb.com/reference/error-responses#409-resource-conflict",
"status": 409,
"detail": "string",
"title": "string"
}
Request Entity Too Large
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#413-request-too-large
]
Possible values: [413
]
Possible values: [https://docs.withorb.com/reference/error-responses#413-resource-too-large
]
Possible values: [413
]
Possible values: [https://docs.withorb.com/reference/error-responses#413-too-many-results
]
Possible values: [413
]
{}
Too Many Requests
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#429-too-many-requests
]
Possible values: [429
]
{
"type": "https://docs.withorb.com/reference/error-responses#429-too-many-requests",
"status": 429,
"detail": "string",
"title": "string"
}
Internal Server Error
Response Headers
Schema
Possible values: [https://docs.withorb.com/reference/error-responses#500-internal-server-error
]
{
"type": "https://docs.withorb.com/reference/error-responses#500-internal-server-error",
"status": 0,
"detail": "string",
"title": "string"
}