Estimate data retention cleanup.

GET

/api/admin/data-retention/estimate

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/data-retention/estimate \
  --header 'Authorization: Bearer <token>'

Estimates expired records and approximate storage savings for all supported retention categories, or a single category when the category query parameter is supplied.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Query Parameters

category

string

Optional category key to estimate only one retention category.

Responses

200

Data retention estimate response.

Media type application/json

object

estimates

required

Array<object>

object

category

required

string

records_to_delete

required

integer

oldest_record_date

required

string | null format: date-time

retention_days

required

integer

estimated_storage_mb

required

number

key

additional properties

total_records_to_delete

required

integer

total_estimated_storage_mb

required

number

key

additional properties

Example ^generated

{
  "estimates": [
    {
      "category": "example",
      "records_to_delete": 1,
      "oldest_record_date": "2026-04-15T12:00:00Z",
      "retention_days": 1,
      "estimated_storage_mb": 1
    }
  ],
  "total_records_to_delete": 1,
  "total_estimated_storage_mb": 1
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}