This endpoint retrieves deleted rows from a result table using pagination. This is the recommended approach for tables with large numbers of deletion records. You can choose between the output format (CSV or JSON).
|
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}/paged
Path Parameters
Parameter |
Required |
Description |
|---|---|---|
tableName |
Yes |
The name of the result table from which to retrieve deleted rows. |
Query Parameters
Parameter |
Required |
Description |
|---|---|---|
page |
No |
The number of the page to query. If omitted, the default value of 1 is taken (the first page). |
page_size |
No |
The number of rows returned per page. When omitted, the default value of 1000 items per page is used. The maximum allowed value can be configured by administrators via the MaxBatchSize setting (see API Configuration). |
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 for the current page.
•pagination: Object containing navigation links (first, previous, next, last).
Usage Examples
Example 1: Retrieve First Page with Metadata
Request:
GET /v1/ResultDatabase/table/deleted-rows/MyTable/paged?includeMetadata=true&page=1&page_size=20
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"
}
],
"pagination": {
"first": "v1/ResultDatabase/table/deleted-rows/MyTable/paged?page=1&page_size=20&includeMetadata=true",
"next": "v1/ResultDatabase/table/deleted-rows/MyTable/paged?page=2&page_size=20&includeMetadata=true",
"last": "v1/ResultDatabase/table/deleted-rows/MyTable/paged?page=50&page_size=20&includeMetadata=true"
}
}
Example 2: Retrieve Deleted Rows Within Time Span
Request:
GET /v1/ResultDatabase/table/deleted-rows/MyTable/paged?deletedSince=2025-11-12T18:50:00&deletedUntil=2025-11-14T15:50:00&page_size=10
Response (CSV):
row_identifier [string]
100
1000
Navigation
The pagination object in JSON responses provides URLs for navigating through result pages:
•first: URL to the first page of results.
•previous: URL to the previous page (null if on first page).
•next: URL to the next page (null if on last page).
•last: URL to the last page of results.
Best Practises
•Choose appropriate page size: Balance between number of requests and response size based on your needs.
•Use time filters: Apply deletedSince and deletedUntil to limit result sets and improve performance.
•Follow pagination links: Use the provided pagination URLs rather than constructing your own to ensure correct navigation.
•Request metadata selectively: Only set includeMetadata=true when you need the additional columns.
See Also
•Getting Deleted Rows (Full Table)
•Getting Table Data (Paged Query)