- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
Manage retention filters through Manage Applications for your organization.
GET https://api.ap1.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filtershttps://api.datadoghq.eu/api/v2/rum/applications/{app_id}/retention_filtershttps://api.ddog-gov.com/api/v2/rum/applications/{app_id}/retention_filtershttps://api.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filtershttps://api.us3.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filtershttps://api.us5.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters
Get the list of RUM retention filters for an application.
이름
유형
설명
app_id [required]
string
Application ID.
OK
All RUM retention filters for an application.
항목
유형
설명
data
[object]
A list of RUM retention filters.
attributes
object
The object describing attributes of a RUM retention filter.
enabled
boolean
Whether the retention filter is enabled.
event_type
enum
The type of RUM events to filter on.
Allowed enum values: session,view,action,error,resource,long_task,vital
name
string
The name of a RUM retention filter.
query
string
The query string for a RUM retention filter.
sample_rate
int64
The sample rate for a RUM retention filter, between 0 and 100.
id
string
ID of retention filter in UUID.
meta
object
The object describing metadata of a RUM retention filter.
source
enum
The type of RUM events to filter on.
Allowed enum values: ui,terraform,default,unknown
type
enum
The type of the resource. The value should always be retention_filters.
Allowed enum values: retention_filters
default: retention_filters
{
"data": [
{
"attributes": {
"enabled": true,
"event_type": "session",
"name": "Retention filter for session",
"query": "@session.has_replay:true",
"sample_rate": 25
},
"id": "051601eb-54a0-abc0-03f9-cc02efa18892",
"meta": {
"source": "terraform"
},
"type": "retention_filters"
}
]
}
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export app_id="CHANGE_ME"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/rum/applications/${app_id}/retention_filters" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
GET https://api.ap1.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.datadoghq.eu/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.ddog-gov.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.us3.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.us5.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}
Get a RUM retention filter for an application.
이름
유형
설명
app_id [required]
string
Application ID.
rf_id [required]
string
Retention filter ID.
OK
The RUM retention filter object.
항목
유형
설명
data
object
The RUM retention filter.
attributes
object
The object describing attributes of a RUM retention filter.
enabled
boolean
Whether the retention filter is enabled.
event_type
enum
The type of RUM events to filter on.
Allowed enum values: session,view,action,error,resource,long_task,vital
name
string
The name of a RUM retention filter.
query
string
The query string for a RUM retention filter.
sample_rate
int64
The sample rate for a RUM retention filter, between 0 and 100.
id
string
ID of retention filter in UUID.
meta
object
The object describing metadata of a RUM retention filter.
source
enum
The type of RUM events to filter on.
Allowed enum values: ui,terraform,default,unknown
type
enum
The type of the resource. The value should always be retention_filters.
Allowed enum values: retention_filters
default: retention_filters
{
"data": {
"attributes": {
"enabled": true,
"event_type": "session",
"name": "Retention filter for session",
"query": "@session.has_replay:true",
"sample_rate": 25
},
"id": "051601eb-54a0-abc0-03f9-cc02efa18892",
"meta": {
"source": "terraform"
},
"type": "retention_filters"
}
}
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export app_id="CHANGE_ME"
export rf_id="CHANGE_ME"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/rum/applications/${app_id}/retention_filters/${rf_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
POST https://api.ap1.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filtershttps://api.datadoghq.eu/api/v2/rum/applications/{app_id}/retention_filtershttps://api.ddog-gov.com/api/v2/rum/applications/{app_id}/retention_filtershttps://api.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filtershttps://api.us3.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filtershttps://api.us5.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters
Create a RUM retention filter for an application. Returns RUM retention filter objects from the request body when the request is successful.
이름
유형
설명
app_id [required]
string
Application ID.
The definition of the new RUM retention filter.
항목
유형
설명
data [required]
object
The new RUM retention filter properties to create.
attributes [required]
object
The object describing attributes of a RUM retention filter to create.
enabled
boolean
Whether the retention filter is enabled.
event_type [required]
enum
The type of RUM events to filter on.
Allowed enum values: session,view,action,error,resource,long_task,vital
name [required]
string
The name of a RUM retention filter.
query
string
The query string for a RUM retention filter.
sample_rate [required]
int64
The sample rate for a RUM retention filter, between 0 and 100.
meta
object
The object describing metadata of a RUM retention filter.
source
enum
The type of RUM events to filter on.
Allowed enum values: ui,terraform,default,unknown
type [required]
enum
The type of the resource. The value should always be retention_filters.
Allowed enum values: retention_filters
default: retention_filters
{
"data": {
"type": "retention_filters",
"attributes": {
"name": "Test creating retention filter",
"event_type": "session",
"query": "custom_query",
"sample_rate": 50,
"enabled": true
},
"meta": {
"source": "terraform"
}
}
}
Created
The RUM retention filter object.
항목
유형
설명
data
object
The RUM retention filter.
attributes
object
The object describing attributes of a RUM retention filter.
enabled
boolean
Whether the retention filter is enabled.
event_type
enum
The type of RUM events to filter on.
Allowed enum values: session,view,action,error,resource,long_task,vital
name
string
The name of a RUM retention filter.
query
string
The query string for a RUM retention filter.
sample_rate
int64
The sample rate for a RUM retention filter, between 0 and 100.
id
string
ID of retention filter in UUID.
meta
object
The object describing metadata of a RUM retention filter.
source
enum
The type of RUM events to filter on.
Allowed enum values: ui,terraform,default,unknown
type
enum
The type of the resource. The value should always be retention_filters.
Allowed enum values: retention_filters
default: retention_filters
{
"data": {
"attributes": {
"enabled": true,
"event_type": "session",
"name": "Retention filter for session",
"query": "@session.has_replay:true",
"sample_rate": 25
},
"id": "051601eb-54a0-abc0-03f9-cc02efa18892",
"meta": {
"source": "terraform"
},
"type": "retention_filters"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export app_id="CHANGE_ME"
# Curl command
curl -X POST "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/rum/applications/${app_id}/retention_filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"type": "retention_filters",
"attributes": {
"name": "Test creating retention filter",
"event_type": "session",
"query": "custom_query",
"sample_rate": 50,
"enabled": true
},
"meta": {
"source": "terraform"
}
}
}
EOF
PATCH https://api.ap1.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.datadoghq.eu/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.ddog-gov.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.us3.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.us5.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}
Update a RUM retention filter for an application. Returns RUM retention filter objects from the request body when the request is successful.
이름
유형
설명
app_id [required]
string
Application ID.
rf_id [required]
string
Retention filter ID.
New definition of the RUM retention filter.
항목
유형
설명
data [required]
object
The new RUM retention filter properties to update.
attributes [required]
object
The object describing attributes of a RUM retention filter to update.
enabled
boolean
Whether the retention filter is enabled.
event_type
enum
The type of RUM events to filter on.
Allowed enum values: session,view,action,error,resource,long_task,vital
name
string
The name of a RUM retention filter.
query
string
The query string for a RUM retention filter.
sample_rate
int64
The sample rate for a RUM retention filter, between 0 and 100.
id [required]
string
ID of retention filter in UUID.
meta
object
The object describing metadata of a RUM retention filter.
source
enum
The type of RUM events to filter on.
Allowed enum values: ui,terraform,default,unknown
type [required]
enum
The type of the resource. The value should always be retention_filters.
Allowed enum values: retention_filters
default: retention_filters
{
"data": {
"id": "4b95d361-f65d-4515-9824-c9aaeba5ac2a",
"type": "retention_filters",
"attributes": {
"name": "Test updating retention filter",
"event_type": "view",
"query": "view_query",
"sample_rate": 100,
"enabled": true
}
}
}
Updated
The RUM retention filter object.
항목
유형
설명
data
object
The RUM retention filter.
attributes
object
The object describing attributes of a RUM retention filter.
enabled
boolean
Whether the retention filter is enabled.
event_type
enum
The type of RUM events to filter on.
Allowed enum values: session,view,action,error,resource,long_task,vital
name
string
The name of a RUM retention filter.
query
string
The query string for a RUM retention filter.
sample_rate
int64
The sample rate for a RUM retention filter, between 0 and 100.
id
string
ID of retention filter in UUID.
meta
object
The object describing metadata of a RUM retention filter.
source
enum
The type of RUM events to filter on.
Allowed enum values: ui,terraform,default,unknown
type
enum
The type of the resource. The value should always be retention_filters.
Allowed enum values: retention_filters
default: retention_filters
{
"data": {
"attributes": {
"enabled": true,
"event_type": "session",
"name": "Retention filter for session",
"query": "@session.has_replay:true",
"sample_rate": 25
},
"id": "051601eb-54a0-abc0-03f9-cc02efa18892",
"meta": {
"source": "terraform"
},
"type": "retention_filters"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export app_id="CHANGE_ME"
export rf_id="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/rum/applications/${app_id}/retention_filters/${rf_id}" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": {
"id": "4b95d361-f65d-4515-9824-c9aaeba5ac2a",
"type": "retention_filters",
"attributes": {
"name": "Test updating retention filter",
"event_type": "view",
"query": "view_query",
"sample_rate": 100,
"enabled": true
}
}
}
EOF
DELETE https://api.ap1.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.datadoghq.eu/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.ddog-gov.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.us3.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}https://api.us5.datadoghq.com/api/v2/rum/applications/{app_id}/retention_filters/{rf_id}
Delete a RUM retention filter for an application.
이름
유형
설명
app_id [required]
string
Application ID.
rf_id [required]
string
Retention filter ID.
No Content
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export app_id="CHANGE_ME"
export rf_id="CHANGE_ME"
# Curl command
curl -X DELETE "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/rum/applications/${app_id}/retention_filters/${rf_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
PATCH https://api.ap1.datadoghq.com/api/v2/rum/applications/{app_id}/relationships/retention_filtershttps://api.datadoghq.eu/api/v2/rum/applications/{app_id}/relationships/retention_filtershttps://api.ddog-gov.com/api/v2/rum/applications/{app_id}/relationships/retention_filtershttps://api.datadoghq.com/api/v2/rum/applications/{app_id}/relationships/retention_filtershttps://api.us3.datadoghq.com/api/v2/rum/applications/{app_id}/relationships/retention_filtershttps://api.us5.datadoghq.com/api/v2/rum/applications/{app_id}/relationships/retention_filters
Order RUM retention filters for an application. Returns RUM retention filter objects without attributes and meta from the request body when the request is successful.
이름
유형
설명
app_id [required]
string
Application ID.
New definition of the RUM retention filter.
항목
유형
설명
data
[object]
A list of RUM retention filter IDs along with type.
id [required]
string
ID of retention filter in UUID.
type [required]
enum
The type of the resource. The value should always be retention_filters.
Allowed enum values: retention_filters
default: retention_filters
{
"data": [
{
"type": "retention_filters",
"id": "325631eb-94c9-49c0-93f9-ab7e4fd24529"
},
{
"type": "retention_filters",
"id": "42d89430-5b80-426e-a44b-ba3b417ece25"
},
{
"type": "retention_filters",
"id": "bff0bc34-99e9-4c16-adce-f47e71948c23"
}
]
}
Ordered
The list of RUM retention filter IDs along with type.
항목
유형
설명
data
[object]
A list of RUM retention filter IDs along with type.
id [required]
string
ID of retention filter in UUID.
type [required]
enum
The type of the resource. The value should always be retention_filters.
Allowed enum values: retention_filters
default: retention_filters
{
"data": [
{
"id": "051601eb-54a0-abc0-03f9-cc02efa18892",
"type": "retention_filters"
}
]
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export app_id="CHANGE_ME"
# Curl command
curl -X PATCH "https://api.ap1.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/rum/applications/${app_id}/relationships/retention_filters" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \
-d @- << EOF
{
"data": [
{
"type": "retention_filters",
"id": "325631eb-94c9-49c0-93f9-ab7e4fd24529"
},
{
"type": "retention_filters",
"id": "42d89430-5b80-426e-a44b-ba3b417ece25"
},
{
"type": "retention_filters",
"id": "bff0bc34-99e9-4c16-adce-f47e71948c23"
}
]
}
EOF