v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB
Rum Retention Filters

Update a RUM retention filter

Update a RUM retention filter for a RUM application. Returns RUM retention filter objects from the request body when the request is successful.

patch/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}

Path parameters

app_idstring required

RUM application ID.

rf_idstring required

Retention filter ID.

Request body

Example request

{
  "data": {
    "attributes": {
      "cross_product_sampling": {
        "trace_enabled": true,
        "trace_sample_rate": 25
      },
      "enabled": true,
      "event_type": "session",
      "name": "Retention filter for session",
      "query": "@session.has_replay:true",
      "sample_rate": 50.5
    },
    "id": "051601eb-54a0-abc0-03f9-cc02efa18892",
    "type": "retention_filters"
  }
}

Response

Updated

Example response

{
  "data": {
    "attributes": {
      "cross_product_sampling": {
        "trace_enabled": true,
        "trace_sample_rate": 25
      },
      "enabled": true,
      "event_type": "session",
      "name": "Retention filter for session",
      "query": "@session.has_replay:true",
      "sample_rate": 50.5
    },
    "id": "051601eb-54a0-abc0-03f9-cc02efa18892",
    "type": "retention_filters"
  }
}