This endpoint retrieves all deleted rows from a result table in a single response without pagination. This is useful for processing all deletion records at once or for smaller datasets. For larger datasets, consider using the paged variant instead.
|
Note: This endpoint requires the Delta Comparison Feature to be enabled for your tenant. See Delta Comparison Feature for prerequisites and configuration details. |
Type of Request
GET
Endpoint URL
http://[host]:[port]/v1/ResultDatabase/table/deleted-rows/{tableName}
Path Parameters
Parameter |
Required |
Description |
|---|---|---|
tableName |
Yes |
The name of the result table from which to retrieve deleted rows. |
Query Parameters
Parameter |
Required |
Description |
|---|---|---|
deletedSince |
No |
Retrieve only rows deleted on or after the specified timestamp in ISO 8601 format (e.g., "2025-11-13T15:50:00"). Can be combined with deletedUntil to define a time span. |
deletedUntil |
No |
Retrieve only rows deleted before or on the specified timestamp in ISO 8601 format (e.g., "2025-11-14T15:50:00"). Can be combined with deletedSince to define a time span. |
includeMetadata |
No (default: false) |
When set to true, includes the metadata columns (__dh_md5_checksum, __dh_deletion_time) in the result set. |
Headers
Parameter |
Required |
Description |
|---|---|---|
ApiKey |
Yes |
Your API key (see Authentication and Authorization for more information). |
Accept |
Yes |
This determines the format of the data. Available supported values are:
application/json |
Response Format
The response contains:
•columns: Array describing each column's name and data type.
•records: Array of deleted row data, including the row identifier and optional metadata columns.
Usage Examples
Example 1: Retrieve All Deleted Rows with Metadata
Request:
GET /v1/ResultDatabase/table/deleted-rows/MyTable?includeMetadata=true
Response (JSON):
{
"columns": [
{ "name": "row_identifier", "type": "String" },
{ "name": "__dh_deletion_time", "type": "DateTime" },
{ "name": "__dh_md5_checksum", "type": "String" }
],
"records": [
{
"row_identifier": "100",
"__dh_deletion_time": "2025-11-12T15:52:51.69",
"__dh_md5_checksum": "4AE467A38B88AE1BD1212DECEB474159"
}
]
}
Example 2: Retrieve Deleted Rows After Specific Date
Request:
GET /v1/ResultDatabase/table/deleted-rows/MyTable?deletedSince=2025-11-13T15:50:00
Response (JSON):
{
"columns": [
{ "name": "row_identifier", "type": "String" }
],
"records": [
{ "row_identifier": "100054" }
]
}
Example 3: Retrieve Deleted Rows Within Time Span
Request:
GET /v1/ResultDatabase/table/deleted-rows/MyTable?deletedSince=2025-11-12T18:50:00&deletedUntil=2025-11-14T15:50:00
Response (CSV):
row_identifier [string]
100028
100054
Best Practises
•Use time filters: Apply deletedSince and deletedUntil to limit result sets and improve performance.
•Consider pagination: For tables with many deletions, use the paged variant to manage large datasets.
•Request metadata selectively: Only set includeMetadata=true when you need the additional columns to reduce response size.
•Handle empty results: The endpoint returns an empty records array if no deleted rows match the criteria.
See Also
•Getting Deleted Rows (Paged Query)