- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
Manage configuration of rum-based metrics for your organization.
GET https://api.ap1.datadoghq.com/api/v2/rum/config/metricshttps://api.datadoghq.eu/api/v2/rum/config/metricshttps://api.ddog-gov.com/api/v2/rum/config/metricshttps://api.datadoghq.com/api/v2/rum/config/metricshttps://api.us3.datadoghq.com/api/v2/rum/config/metricshttps://api.us5.datadoghq.com/api/v2/rum/config/metrics
Get the list of configured rum-based metrics with their definitions.
OK
All the available rum-based metric objects.
항목
유형
설명
data
[object]
A list of rum-based metric objects.
attributes
object
The object describing a Datadog rum-based metric.
compute
object
The compute rule to compute the rum-based metric.
aggregation_type
enum
The type of aggregation to use.
Allowed enum values: count,distribution
include_percentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the aggregation_type
is distribution
.
path
string
The path to the value the rum-based metric will aggregate on (only used if the aggregation type is a "distribution").
event_type
enum
The type of RUM events to filter on.
Allowed enum values: session,view,action,error,resource,long_task,vital
filter
object
The rum-based metric filter. RUM events matching this filter will be aggregated in this metric.
query
string
The search query - following the RUM search syntax.
group_by
[object]
The rules for the group by.
path
string
The path to the value the rum-based metric will be aggregated over.
tag_name
string
Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
uniqueness
object
The rule to count updatable events. Is only set if "event_type" is "sessions" or "views".
when
enum
When to count updatable events. "match" when the event is first seen, or "end" when the event is complete.
Allowed enum values: match,end
id
string
The name of the rum-based metric.
type
enum
The type of the resource. The value should always be rum_metrics.
Allowed enum values: rum_metrics
default: rum_metrics
{
"data": [
{
"attributes": {
"compute": {
"aggregation_type": "distribution",
"include_percentiles": true,
"path": "@duration"
},
"event_type": "session",
"filter": {
"query": "service:web* AND @http.status_code:[200 TO 299]"
},
"group_by": [
{
"path": "@http.status_code",
"tag_name": "status_code"
}
],
"uniqueness": {
"when": "match"
}
},
"id": "rum.sessions.webui.count",
"type": "rum_metrics"
}
]
}
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# 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/config/metrics" \
-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/config/metricshttps://api.datadoghq.eu/api/v2/rum/config/metricshttps://api.ddog-gov.com/api/v2/rum/config/metricshttps://api.datadoghq.com/api/v2/rum/config/metricshttps://api.us3.datadoghq.com/api/v2/rum/config/metricshttps://api.us5.datadoghq.com/api/v2/rum/config/metrics
Create a metric based on your organization’s RUM data. Returns the rum-based metric object from the request body when the request is successful.
The definition of the new rum-based metric.
항목
유형
설명
data [required]
object
The new rum-based metric properties.
attributes [required]
object
The object describing the Datadog rum-based metric to create.
compute [required]
object
The compute rule to compute the rum-based metric.
aggregation_type [required]
enum
The type of aggregation to use.
Allowed enum values: count,distribution
include_percentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the aggregation_type
is distribution
.
path
string
The path to the value the rum-based metric will aggregate on (only used if the aggregation type is a "distribution").
event_type [required]
enum
The type of RUM events to filter on.
Allowed enum values: session,view,action,error,resource,long_task,vital
filter
object
The rum-based metric filter. Events matching this filter will be aggregated in this metric.
query [required]
string
The search query - following the RUM search syntax. Must include an @type facet query.
default: *
group_by
[object]
The rules for the group by.
path [required]
string
The path to the value the rum-based metric will be aggregated over.
tag_name
string
Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
uniqueness
object
The rule to count updatable events. Is only set if "event_type" is "sessions" or "views".
when [required]
enum
When to count updatable events. "match" when the event is first seen, or "end" when the event is complete.
Allowed enum values: match,end
id [required]
string
The name of the rum-based metric.
type [required]
enum
The type of the resource. The value should always be rum_metrics.
Allowed enum values: rum_metrics
default: rum_metrics
{
"data": {
"attributes": {
"compute": {
"aggregation_type": "distribution",
"include_percentiles": true,
"path": "@duration"
},
"event_type": "session",
"filter": {
"query": "@service:web-ui"
},
"group_by": [
{
"path": "@browser.name",
"tag_name": "browser_name"
}
],
"uniqueness": {
"when": "match"
}
},
"id": "rum.sessions.webui.count",
"type": "rum_metrics"
}
}
Created
The rum-based metric object.
항목
유형
설명
data
object
The rum-based metric properties.
attributes
object
The object describing a Datadog rum-based metric.
compute
object
The compute rule to compute the rum-based metric.
aggregation_type
enum
The type of aggregation to use.
Allowed enum values: count,distribution
include_percentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the aggregation_type
is distribution
.
path
string
The path to the value the rum-based metric will aggregate on (only used if the aggregation type is a "distribution").
event_type
enum
The type of RUM events to filter on.
Allowed enum values: session,view,action,error,resource,long_task,vital
filter
object
The rum-based metric filter. RUM events matching this filter will be aggregated in this metric.
query
string
The search query - following the RUM search syntax.
group_by
[object]
The rules for the group by.
path
string
The path to the value the rum-based metric will be aggregated over.
tag_name
string
Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
uniqueness
object
The rule to count updatable events. Is only set if "event_type" is "sessions" or "views".
when
enum
When to count updatable events. "match" when the event is first seen, or "end" when the event is complete.
Allowed enum values: match,end
id
string
The name of the rum-based metric.
type
enum
The type of the resource. The value should always be rum_metrics.
Allowed enum values: rum_metrics
default: rum_metrics
{
"data": {
"attributes": {
"compute": {
"aggregation_type": "distribution",
"include_percentiles": true,
"path": "@duration"
},
"event_type": "session",
"filter": {
"query": "service:web* AND @http.status_code:[200 TO 299]"
},
"group_by": [
{
"path": "@http.status_code",
"tag_name": "status_code"
}
],
"uniqueness": {
"when": "match"
}
},
"id": "rum.sessions.webui.count",
"type": "rum_metrics"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Conflict
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# 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/config/metrics" \
-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": {
"attributes": {
"compute": {
"aggregation_type": "distribution",
"include_percentiles": true,
"path": "@duration"
},
"event_type": "session",
"filter": {
"query": "@service:web-ui"
},
"group_by": [
{
"path": "@browser.name",
"tag_name": "browser_name"
}
],
"uniqueness": {
"when": "match"
}
},
"id": "rum.sessions.webui.count",
"type": "rum_metrics"
}
}
EOF
GET https://api.ap1.datadoghq.com/api/v2/rum/config/metrics/{metric_id}https://api.datadoghq.eu/api/v2/rum/config/metrics/{metric_id}https://api.ddog-gov.com/api/v2/rum/config/metrics/{metric_id}https://api.datadoghq.com/api/v2/rum/config/metrics/{metric_id}https://api.us3.datadoghq.com/api/v2/rum/config/metrics/{metric_id}https://api.us5.datadoghq.com/api/v2/rum/config/metrics/{metric_id}
Get a specific rum-based metric from your organization.
이름
유형
설명
metric_id [required]
string
The name of the rum-based metric.
OK
The rum-based metric object.
항목
유형
설명
data
object
The rum-based metric properties.
attributes
object
The object describing a Datadog rum-based metric.
compute
object
The compute rule to compute the rum-based metric.
aggregation_type
enum
The type of aggregation to use.
Allowed enum values: count,distribution
include_percentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the aggregation_type
is distribution
.
path
string
The path to the value the rum-based metric will aggregate on (only used if the aggregation type is a "distribution").
event_type
enum
The type of RUM events to filter on.
Allowed enum values: session,view,action,error,resource,long_task,vital
filter
object
The rum-based metric filter. RUM events matching this filter will be aggregated in this metric.
query
string
The search query - following the RUM search syntax.
group_by
[object]
The rules for the group by.
path
string
The path to the value the rum-based metric will be aggregated over.
tag_name
string
Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
uniqueness
object
The rule to count updatable events. Is only set if "event_type" is "sessions" or "views".
when
enum
When to count updatable events. "match" when the event is first seen, or "end" when the event is complete.
Allowed enum values: match,end
id
string
The name of the rum-based metric.
type
enum
The type of the resource. The value should always be rum_metrics.
Allowed enum values: rum_metrics
default: rum_metrics
{
"data": {
"attributes": {
"compute": {
"aggregation_type": "distribution",
"include_percentiles": true,
"path": "@duration"
},
"event_type": "session",
"filter": {
"query": "service:web* AND @http.status_code:[200 TO 299]"
},
"group_by": [
{
"path": "@http.status_code",
"tag_name": "status_code"
}
],
"uniqueness": {
"when": "match"
}
},
"id": "rum.sessions.webui.count",
"type": "rum_metrics"
}
}
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 metric_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/config/metrics/${metric_id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
PATCH https://api.ap1.datadoghq.com/api/v2/rum/config/metrics/{metric_id}https://api.datadoghq.eu/api/v2/rum/config/metrics/{metric_id}https://api.ddog-gov.com/api/v2/rum/config/metrics/{metric_id}https://api.datadoghq.com/api/v2/rum/config/metrics/{metric_id}https://api.us3.datadoghq.com/api/v2/rum/config/metrics/{metric_id}https://api.us5.datadoghq.com/api/v2/rum/config/metrics/{metric_id}
Update a specific rum-based metric from your organization. Returns the rum-based metric object from the request body when the request is successful.
이름
유형
설명
metric_id [required]
string
The name of the rum-based metric.
New definition of the rum-based metric.
항목
유형
설명
data [required]
object
The new rum-based metric properties.
attributes [required]
object
The rum-based metric properties that will be updated.
compute
object
The compute rule to compute the rum-based metric.
include_percentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the aggregation_type
is distribution
.
filter
object
The rum-based metric filter. Events matching this filter will be aggregated in this metric.
query [required]
string
The search query - following the RUM search syntax. Must include an @type facet query.
default: *
group_by
[object]
The rules for the group by.
path [required]
string
The path to the value the rum-based metric will be aggregated over.
tag_name
string
Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
id
string
The name of the rum-based metric.
type [required]
enum
The type of the resource. The value should always be rum_metrics.
Allowed enum values: rum_metrics
default: rum_metrics
{
"data": {
"id": "rum.sessions.webui.count",
"type": "rum_metrics",
"attributes": {
"compute": {
"include_percentiles": false
},
"filter": {
"query": "@service:rum-config"
},
"group_by": [
{
"path": "@browser.version",
"tag_name": "browser_version"
}
]
}
}
}
OK
The rum-based metric object.
항목
유형
설명
data
object
The rum-based metric properties.
attributes
object
The object describing a Datadog rum-based metric.
compute
object
The compute rule to compute the rum-based metric.
aggregation_type
enum
The type of aggregation to use.
Allowed enum values: count,distribution
include_percentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the aggregation_type
is distribution
.
path
string
The path to the value the rum-based metric will aggregate on (only used if the aggregation type is a "distribution").
event_type
enum
The type of RUM events to filter on.
Allowed enum values: session,view,action,error,resource,long_task,vital
filter
object
The rum-based metric filter. RUM events matching this filter will be aggregated in this metric.
query
string
The search query - following the RUM search syntax.
group_by
[object]
The rules for the group by.
path
string
The path to the value the rum-based metric will be aggregated over.
tag_name
string
Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
uniqueness
object
The rule to count updatable events. Is only set if "event_type" is "sessions" or "views".
when
enum
When to count updatable events. "match" when the event is first seen, or "end" when the event is complete.
Allowed enum values: match,end
id
string
The name of the rum-based metric.
type
enum
The type of the resource. The value should always be rum_metrics.
Allowed enum values: rum_metrics
default: rum_metrics
{
"data": {
"attributes": {
"compute": {
"aggregation_type": "distribution",
"include_percentiles": true,
"path": "@duration"
},
"event_type": "session",
"filter": {
"query": "service:web* AND @http.status_code:[200 TO 299]"
},
"group_by": [
{
"path": "@http.status_code",
"tag_name": "status_code"
}
],
"uniqueness": {
"when": "match"
}
},
"id": "rum.sessions.webui.count",
"type": "rum_metrics"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Conflict
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export metric_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/config/metrics/${metric_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": "rum.sessions.webui.count",
"type": "rum_metrics",
"attributes": {
"compute": {
"include_percentiles": false
},
"filter": {
"query": "@service:rum-config"
},
"group_by": [
{
"path": "@browser.version",
"tag_name": "browser_version"
}
]
}
}
}
EOF
DELETE https://api.ap1.datadoghq.com/api/v2/rum/config/metrics/{metric_id}https://api.datadoghq.eu/api/v2/rum/config/metrics/{metric_id}https://api.ddog-gov.com/api/v2/rum/config/metrics/{metric_id}https://api.datadoghq.com/api/v2/rum/config/metrics/{metric_id}https://api.us3.datadoghq.com/api/v2/rum/config/metrics/{metric_id}https://api.us5.datadoghq.com/api/v2/rum/config/metrics/{metric_id}
Delete a specific rum-based metric from your organization.
이름
유형
설명
metric_id [required]
string
The name of the rum-based metric.
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 metric_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/config/metrics/${metric_id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"