Skip to content
getgeolens.com
GeoLens Docs

Set Dataset Retention

PUT
/datasets/{dataset_id}/retention/
 
curl --request PUT \
  --url 'https://example.com/datasets/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/retention/?dry_run=false' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "retention": { "column": "example", "days": 1 } }'

Set or clear how many days of rows a feature dataset keeps.

Hourly worker runs delete rows whose retention column is older than the cutoff, in batches, so a large backlog can take several runs; rows where it is null are kept. A dry run counts the rows past the cutoff now in rows_past_cutoff; a save skips that scan and returns null. The instance’s dataset editing switch does not apply: this is the owner’s setting, not an edit.

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
dataset_id
required
Dataset Id
string format: uuid

Query Parameters

Section titled “ Query Parameters ”
dry_run
Dry Run

Check the setting and count its rows without saving it.

boolean

Check the setting and count its rows without saving it.

Request Bodyrequired

Section titled “ Request Bodyrequired ”
Media type application/json
DatasetRetentionUpdate

The retention setting to store; null turns retention off.

object
retention
required
Any of:
DatasetRetention

Keep only the rows from the last days days, judged by column.

object
column
required
Column

A date or timestamp column of the dataset’s table. Rows where it is null are kept.

string
<= 63 characters
days
required
Days
integer
>= 1 <= 3650

Example generated

{
  "retention": {
    "column": "example",
    "days": 1
  }
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
DatasetRetentionResponse
object
retention
required
Any of:
DatasetRetention

Keep only the rows from the last days days, judged by column.

object
column
required
Column

A date or timestamp column of the dataset’s table. Rows where it is null are kept.

string
<= 63 characters
days
required
Days
integer
>= 1 <= 3650
rows_past_cutoff
required
Any of:
integer
cutoff
Any of:
string format: date-time

Example generated

{
  "retention": {
    "column": "example",
    "days": 1
  },
  "rows_past_cutoff": 1,
  "cutoff": "2026-04-15T12:00:00Z"
}

400

Section titled “ 400 ”

Bad request — invalid payload

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

401

Section titled “ 401 ”

Unauthorized — missing or invalid credentials

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

403

Section titled “ 403 ”

Forbidden — caller lacks write access

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

404

Section titled “ 404 ”

Not found

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

409

Section titled “ 409 ”

Conflict — resource state prevents the operation

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

422

Section titled “ 422 ”

Validation error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

429

Section titled “ 429 ”

Too many requests — retry after the advertised interval

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

Headers

Section titled “ Headers ”
Retry-After
integer

Seconds until the request may be retried

500

Section titled “ 500 ”

Internal server error

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}

503

Section titled “ 503 ”

Service unavailable — the database could not serve the request

Media type application/problem+json
ProblemDetail
object
type
Type
string
default: about:blank
title
required
Title
string
status
required
Status
integer
detail
required
Any of:
string

Example 

{
  "detail": "Dataset not found",
  "status": 404,
  "title": "Not Found",
  "type": "about:blank"
}
Privacy Apache 2.0 getgeolens.com