Language

日本語 English Français 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 US1-FED
このページは日本語には対応しておりません。随時翻訳に取り組んでいます。
翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Rum Retention Filters

Manage retention filters through Manage Applications of RUM for your organization.

Get all RUM retention filters

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 a RUM application.

引数

パスパラメーター

名前

種類

説明

app_id [required]

string

RUM application ID.

応答

OK

All RUM retention filters for a RUM application.

Expand All

フィールド

種類

説明

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.

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",
      "type": "retention_filters"
    }
  ]
}

Not Authorized

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "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 a RUM retention filter

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 a RUM application.

引数

パスパラメーター

名前

種類

説明

app_id [required]

string

RUM application ID.

rf_id [required]

string

Retention filter ID.

応答

OK

The RUM retention filter object.

Expand All

フィールド

種類

説明

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.

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",
    "type": "retention_filters"
  }
}

Not Authorized

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "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}"

Create a RUM retention filter

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 a RUM application. Returns RUM retention filter objects from the request body when the request is successful.

引数

パスパラメーター

名前

種類

説明

app_id [required]

string

RUM application ID.

リクエスト

Body Data (required)

The definition of the new RUM retention filter.

Expand All

フィールド

種類

説明

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.

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
    }
  }
}

応答

Created

The RUM retention filter object.

Expand All

フィールド

種類

説明

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.

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",
    "type": "retention_filters"
  }
}

Bad Request

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Authorized

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "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
    }
  }
}
EOF

Update a RUM retention filter

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 a RUM application. Returns RUM retention filter objects from the request body when the request is successful.

引数

パスパラメーター

名前

種類

説明

app_id [required]

string

RUM application ID.

rf_id [required]

string

Retention filter ID.

リクエスト

Body Data (required)

New definition of the RUM retention filter.

Expand All

フィールド

種類

説明

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.

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.

Expand All

フィールド

種類

説明

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.

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",
    "type": "retention_filters"
  }
}

Bad Request

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Authorized

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "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 a RUM retention filter

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 a RUM application.

引数

パスパラメーター

名前

種類

説明

app_id [required]

string

RUM application ID.

rf_id [required]

string

Retention filter ID.

応答

No Content

Not Authorized

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Found

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "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}"

Order RUM retention filters

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 a RUM application. Returns RUM retention filter objects without attributes from the request body when the request is successful.

引数

パスパラメーター

名前

種類

説明

app_id [required]

string

RUM application ID.

リクエスト

Body Data (required)

New definition of the RUM retention filter.

Expand All

フィールド

種類

説明

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.

Expand All

フィールド

種類

説明

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.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Not Authorized

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "errors": [
    "Bad Request"
  ]
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

{
  "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