- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
Manage your Real User Monitoring (RUM) applications, and search or aggregate your RUM events over HTTP. See the RUM & Session Replay page for more information
POST https://api.ap1.datadoghq.com/api/v2/rum/events/searchhttps://api.datadoghq.eu/api/v2/rum/events/searchhttps://api.ddog-gov.com/api/v2/rum/events/searchhttps://api.datadoghq.com/api/v2/rum/events/searchhttps://api.us3.datadoghq.com/api/v2/rum/events/searchhttps://api.us5.datadoghq.com/api/v2/rum/events/search
List endpoint returns RUM events that match a RUM search query. Results are paginated.
Use this endpoint to build complex RUM events filtering and search.
항목
유형
설명
filter
object
The search and filter query settings.
from
string
The minimum time for the requested events; supports date (in ISO 8601 format with full date, hours, minutes, and the Z
UTC indicator - seconds and fractional seconds are optional), math, and regular timestamps (in milliseconds).
default: now-15m
query
string
The search query following the RUM search syntax.
default: *
to
string
The maximum time for the requested events; supports date (in ISO 8601 format with full date, hours, minutes, and the Z
UTC indicator - seconds and fractional seconds are optional), math, and regular timestamps (in milliseconds).
default: now
options
object
Global query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails.
time_offset
int64
The time offset (in seconds) to apply to the query.
timezone
string
The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).
default: UTC
page
object
Paging attributes for listing events.
cursor
string
List following results with a cursor provided in the previous query.
limit
int32
Maximum number of events in the response.
default: 10
sort
enum
Sort parameters when querying events.
Allowed enum values: timestamp,-timestamp
{
"filter": {
"from": "now-15m",
"query": "@type:session AND @session.type:user",
"to": "now"
},
"options": {
"time_offset": 0,
"timezone": "GMT"
},
"page": {
"limit": 25
},
"sort": "timestamp"
}
{
"filter": {
"from": "now-15m",
"query": "@type:session AND @session.type:user",
"to": "now"
},
"options": {
"time_offset": 0,
"timezone": "GMT"
},
"page": {
"limit": 2
},
"sort": "timestamp"
}
OK
Response object with all events matching the request and pagination information.
항목
유형
설명
data
[object]
Array of events matching the request.
attributes
object
JSON object containing all event attributes and their associated values.
attributes
object
JSON object of attributes from RUM events.
service
string
The name of the application or service generating RUM events. It is used to switch from RUM to APM, so make sure you define the same value when you use both products.
tags
[string]
Array of tags associated with your event.
timestamp
date-time
Timestamp of your event.
id
string
Unique ID of the event.
type
enum
Type of the event.
Allowed enum values: rum
default: rum
links
object
Links attributes.
next
string
Link for the next set of results. Note that the request can also be made using the POST endpoint.
meta
object
The metadata associated with a request.
elapsed
int64
The time elapsed in milliseconds.
page
object
Paging attributes.
after
string
The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of page[cursor]
.
request_id
string
The identifier of the request.
status
enum
The status of the response.
Allowed enum values: done,timeout
warnings
[object]
A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.
code
string
A unique code for this type of warning.
detail
string
A detailed explanation of this specific warning.
title
string
A short human-readable summary of the warning.
{
"data": [
{
"attributes": {
"attributes": {
"customAttribute": 123,
"duration": 2345
},
"service": "web-app",
"tags": [
"team:A"
],
"timestamp": "2019-01-02T09:42:36.320Z"
},
"id": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA",
"type": "rum"
}
],
"links": {
"next": "https://app.datadoghq.com/api/v2/rum/event?filter[query]=foo\u0026page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="
},
"meta": {
"elapsed": 132,
"page": {
"after": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="
},
"request_id": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR",
"status": "done",
"warnings": [
{
"code": "unknown_index",
"detail": "indexes: foo, bar",
"title": "One or several indexes are missing or invalid, results hold data from the other indexes"
}
]
}
}
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"
]
}
# 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/events/search" \
-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
{
"filter": {
"from": "now-15m",
"query": "@type:session AND @session.type:user",
"to": "now"
},
"options": {
"time_offset": 0,
"timezone": "GMT"
},
"page": {
"limit": 25
},
"sort": "timestamp"
}
EOF
# 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/events/search" \
-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
{
"filter": {
"from": "now-15m",
"query": "@type:session AND @session.type:user",
"to": "now"
},
"options": {
"time_offset": 0,
"timezone": "GMT"
},
"page": {
"limit": 2
},
"sort": "timestamp"
}
EOF
// Search RUM events returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
body := datadogV2.RUMSearchEventsRequest{
Filter: &datadogV2.RUMQueryFilter{
From: datadog.PtrString("now-15m"),
Query: datadog.PtrString("@type:session AND @session.type:user"),
To: datadog.PtrString("now"),
},
Options: &datadogV2.RUMQueryOptions{
TimeOffset: datadog.PtrInt64(0),
Timezone: datadog.PtrString("GMT"),
},
Page: &datadogV2.RUMQueryPageOptions{
Limit: datadog.PtrInt32(25),
},
Sort: datadogV2.RUMSORT_TIMESTAMP_ASCENDING.Ptr(),
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewRUMApi(apiClient)
resp, r, err := api.SearchRUMEvents(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RUMApi.SearchRUMEvents`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `RUMApi.SearchRUMEvents`:\n%s\n", responseContent)
}
// Search RUM events returns "OK" response with pagination
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
body := datadogV2.RUMSearchEventsRequest{
Filter: &datadogV2.RUMQueryFilter{
From: datadog.PtrString("now-15m"),
Query: datadog.PtrString("@type:session AND @session.type:user"),
To: datadog.PtrString("now"),
},
Options: &datadogV2.RUMQueryOptions{
TimeOffset: datadog.PtrInt64(0),
Timezone: datadog.PtrString("GMT"),
},
Page: &datadogV2.RUMQueryPageOptions{
Limit: datadog.PtrInt32(2),
},
Sort: datadogV2.RUMSORT_TIMESTAMP_ASCENDING.Ptr(),
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewRUMApi(apiClient)
resp, _ := api.SearchRUMEventsWithPagination(ctx, body)
for paginationResult := range resp {
if paginationResult.Error != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RUMApi.SearchRUMEvents`: %v\n", paginationResult.Error)
}
responseContent, _ := json.MarshalIndent(paginationResult.Item, "", " ")
fmt.Fprintf(os.Stdout, "%s\n", responseContent)
}
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Search RUM events returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumApi;
import com.datadog.api.client.v2.model.RUMEventsResponse;
import com.datadog.api.client.v2.model.RUMQueryFilter;
import com.datadog.api.client.v2.model.RUMQueryOptions;
import com.datadog.api.client.v2.model.RUMQueryPageOptions;
import com.datadog.api.client.v2.model.RUMSearchEventsRequest;
import com.datadog.api.client.v2.model.RUMSort;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
RumApi apiInstance = new RumApi(defaultClient);
RUMSearchEventsRequest body =
new RUMSearchEventsRequest()
.filter(
new RUMQueryFilter()
.from("now-15m")
.query("@type:session AND @session.type:user")
.to("now"))
.options(new RUMQueryOptions().timeOffset(0L).timezone("GMT"))
.page(new RUMQueryPageOptions().limit(25))
.sort(RUMSort.TIMESTAMP_ASCENDING);
try {
RUMEventsResponse result = apiInstance.searchRUMEvents(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RumApi#searchRUMEvents");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
// Search RUM events returns "OK" response with pagination
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.PaginationIterable;
import com.datadog.api.client.v2.api.RumApi;
import com.datadog.api.client.v2.model.RUMEvent;
import com.datadog.api.client.v2.model.RUMQueryFilter;
import com.datadog.api.client.v2.model.RUMQueryOptions;
import com.datadog.api.client.v2.model.RUMQueryPageOptions;
import com.datadog.api.client.v2.model.RUMSearchEventsRequest;
import com.datadog.api.client.v2.model.RUMSort;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
RumApi apiInstance = new RumApi(defaultClient);
RUMSearchEventsRequest body =
new RUMSearchEventsRequest()
.filter(
new RUMQueryFilter()
.from("now-15m")
.query("@type:session AND @session.type:user")
.to("now"))
.options(new RUMQueryOptions().timeOffset(0L).timezone("GMT"))
.page(new RUMQueryPageOptions().limit(2))
.sort(RUMSort.TIMESTAMP_ASCENDING);
try {
PaginationIterable<RUMEvent> iterable = apiInstance.searchRUMEventsWithPagination(body);
for (RUMEvent item : iterable) {
System.out.println(item);
}
} catch (RuntimeException e) {
System.err.println("Exception when calling RumApi#searchRUMEventsWithPagination");
System.err.println("Reason: " + e.getMessage());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
"""
Search RUM events returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_api import RUMApi
from datadog_api_client.v2.model.rum_query_filter import RUMQueryFilter
from datadog_api_client.v2.model.rum_query_options import RUMQueryOptions
from datadog_api_client.v2.model.rum_query_page_options import RUMQueryPageOptions
from datadog_api_client.v2.model.rum_search_events_request import RUMSearchEventsRequest
from datadog_api_client.v2.model.rum_sort import RUMSort
body = RUMSearchEventsRequest(
filter=RUMQueryFilter(
_from="now-15m",
query="@type:session AND @session.type:user",
to="now",
),
options=RUMQueryOptions(
time_offset=0,
timezone="GMT",
),
page=RUMQueryPageOptions(
limit=25,
),
sort=RUMSort.TIMESTAMP_ASCENDING,
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = RUMApi(api_client)
response = api_instance.search_rum_events(body=body)
print(response)
"""
Search RUM events returns "OK" response with pagination
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_api import RUMApi
from datadog_api_client.v2.model.rum_query_filter import RUMQueryFilter
from datadog_api_client.v2.model.rum_query_options import RUMQueryOptions
from datadog_api_client.v2.model.rum_query_page_options import RUMQueryPageOptions
from datadog_api_client.v2.model.rum_search_events_request import RUMSearchEventsRequest
from datadog_api_client.v2.model.rum_sort import RUMSort
body = RUMSearchEventsRequest(
filter=RUMQueryFilter(
_from="now-15m",
query="@type:session AND @session.type:user",
to="now",
),
options=RUMQueryOptions(
time_offset=0,
timezone="GMT",
),
page=RUMQueryPageOptions(
limit=2,
),
sort=RUMSort.TIMESTAMP_ASCENDING,
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = RUMApi(api_client)
items = api_instance.search_rum_events_with_pagination(body=body)
for item in items:
print(item)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Search RUM events returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::RUMAPI.new
body = DatadogAPIClient::V2::RUMSearchEventsRequest.new({
filter: DatadogAPIClient::V2::RUMQueryFilter.new({
from: "now-15m",
query: "@type:session AND @session.type:user",
to: "now",
}),
options: DatadogAPIClient::V2::RUMQueryOptions.new({
time_offset: 0,
timezone: "GMT",
}),
page: DatadogAPIClient::V2::RUMQueryPageOptions.new({
limit: 25,
}),
sort: DatadogAPIClient::V2::RUMSort::TIMESTAMP_ASCENDING,
})
p api_instance.search_rum_events(body)
# Search RUM events returns "OK" response with pagination
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::RUMAPI.new
body = DatadogAPIClient::V2::RUMSearchEventsRequest.new({
filter: DatadogAPIClient::V2::RUMQueryFilter.new({
from: "now-15m",
query: "@type:session AND @session.type:user",
to: "now",
}),
options: DatadogAPIClient::V2::RUMQueryOptions.new({
time_offset: 0,
timezone: "GMT",
}),
page: DatadogAPIClient::V2::RUMQueryPageOptions.new({
limit: 2,
}),
sort: DatadogAPIClient::V2::RUMSort::TIMESTAMP_ASCENDING,
})
api_instance.search_rum_events_with_pagination(body) { |item| puts item }
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Search RUM events returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_rum::RUMAPI;
use datadog_api_client::datadogV2::model::RUMQueryFilter;
use datadog_api_client::datadogV2::model::RUMQueryOptions;
use datadog_api_client::datadogV2::model::RUMQueryPageOptions;
use datadog_api_client::datadogV2::model::RUMSearchEventsRequest;
use datadog_api_client::datadogV2::model::RUMSort;
#[tokio::main]
async fn main() {
let body = RUMSearchEventsRequest::new()
.filter(
RUMQueryFilter::new()
.from("now-15m".to_string())
.query("@type:session AND @session.type:user".to_string())
.to("now".to_string()),
)
.options(
RUMQueryOptions::new()
.time_offset(0)
.timezone("GMT".to_string()),
)
.page(RUMQueryPageOptions::new().limit(25))
.sort(RUMSort::TIMESTAMP_ASCENDING);
let configuration = datadog::Configuration::new();
let api = RUMAPI::with_config(configuration);
let resp = api.search_rum_events(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
// Search RUM events returns "OK" response with pagination
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_rum::RUMAPI;
use datadog_api_client::datadogV2::model::RUMQueryFilter;
use datadog_api_client::datadogV2::model::RUMQueryOptions;
use datadog_api_client::datadogV2::model::RUMQueryPageOptions;
use datadog_api_client::datadogV2::model::RUMSearchEventsRequest;
use datadog_api_client::datadogV2::model::RUMSort;
use futures_util::pin_mut;
use futures_util::stream::StreamExt;
#[tokio::main]
async fn main() {
let body = RUMSearchEventsRequest::new()
.filter(
RUMQueryFilter::new()
.from("now-15m".to_string())
.query("@type:session AND @session.type:user".to_string())
.to("now".to_string()),
)
.options(
RUMQueryOptions::new()
.time_offset(0)
.timezone("GMT".to_string()),
)
.page(RUMQueryPageOptions::new().limit(2))
.sort(RUMSort::TIMESTAMP_ASCENDING);
let configuration = datadog::Configuration::new();
let api = RUMAPI::with_config(configuration);
let response = api.search_rum_events_with_pagination(body);
pin_mut!(response);
while let Some(resp) = response.next().await {
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
* Search RUM events returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.RUMApi(configuration);
const params: v2.RUMApiSearchRUMEventsRequest = {
body: {
filter: {
from: "now-15m",
query: "@type:session AND @session.type:user",
to: "now",
},
options: {
timeOffset: 0,
timezone: "GMT",
},
page: {
limit: 25,
},
sort: "timestamp",
},
};
apiInstance
.searchRUMEvents(params)
.then((data: v2.RUMEventsResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
/**
* Search RUM events returns "OK" response with pagination
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.RUMApi(configuration);
const params: v2.RUMApiSearchRUMEventsRequest = {
body: {
filter: {
from: "now-15m",
query: "@type:session AND @session.type:user",
to: "now",
},
options: {
timeOffset: 0,
timezone: "GMT",
},
page: {
limit: 2,
},
sort: "timestamp",
},
};
(async () => {
try {
for await (const item of apiInstance.searchRUMEventsWithPagination(
params
)) {
console.log(item);
}
} catch (error) {
console.error(error);
}
})();
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
GET https://api.ap1.datadoghq.com/api/v2/rum/eventshttps://api.datadoghq.eu/api/v2/rum/eventshttps://api.ddog-gov.com/api/v2/rum/eventshttps://api.datadoghq.com/api/v2/rum/eventshttps://api.us3.datadoghq.com/api/v2/rum/eventshttps://api.us5.datadoghq.com/api/v2/rum/events
List endpoint returns events that match a RUM search query. Results are paginated.
Use this endpoint to see your latest RUM events.
이름
유형
설명
filter[query]
string
Search query following RUM syntax.
filter[from]
string
Minimum timestamp for requested events.
filter[to]
string
Maximum timestamp for requested events.
sort
enum
Order of events in results.
Allowed enum values: timestamp, -timestamp
page[cursor]
string
List following results with a cursor provided in the previous query.
page[limit]
integer
Maximum number of events in the response.
OK
Response object with all events matching the request and pagination information.
항목
유형
설명
data
[object]
Array of events matching the request.
attributes
object
JSON object containing all event attributes and their associated values.
attributes
object
JSON object of attributes from RUM events.
service
string
The name of the application or service generating RUM events. It is used to switch from RUM to APM, so make sure you define the same value when you use both products.
tags
[string]
Array of tags associated with your event.
timestamp
date-time
Timestamp of your event.
id
string
Unique ID of the event.
type
enum
Type of the event.
Allowed enum values: rum
default: rum
links
object
Links attributes.
next
string
Link for the next set of results. Note that the request can also be made using the POST endpoint.
meta
object
The metadata associated with a request.
elapsed
int64
The time elapsed in milliseconds.
page
object
Paging attributes.
after
string
The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of page[cursor]
.
request_id
string
The identifier of the request.
status
enum
The status of the response.
Allowed enum values: done,timeout
warnings
[object]
A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.
code
string
A unique code for this type of warning.
detail
string
A detailed explanation of this specific warning.
title
string
A short human-readable summary of the warning.
{
"data": [
{
"attributes": {
"attributes": {
"customAttribute": 123,
"duration": 2345
},
"service": "web-app",
"tags": [
"team:A"
],
"timestamp": "2019-01-02T09:42:36.320Z"
},
"id": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA",
"type": "rum"
}
],
"links": {
"next": "https://app.datadoghq.com/api/v2/rum/event?filter[query]=foo\u0026page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="
},
"meta": {
"elapsed": 132,
"page": {
"after": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="
},
"request_id": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR",
"status": "done",
"warnings": [
{
"code": "unknown_index",
"detail": "indexes: foo, bar",
"title": "One or several indexes are missing or invalid, results hold data from the other indexes"
}
]
}
}
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"
]
}
# 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/events" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get a list of RUM events returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_api import RUMApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = RUMApi(api_client)
response = api_instance.list_rum_events()
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Get a list of RUM events returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::RUMAPI.new
p api_instance.list_rum_events()
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Get a list of RUM events returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewRUMApi(apiClient)
resp, r, err := api.ListRUMEvents(ctx, *datadogV2.NewListRUMEventsOptionalParameters())
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RUMApi.ListRUMEvents`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `RUMApi.ListRUMEvents`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Get a list of RUM events returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumApi;
import com.datadog.api.client.v2.model.RUMEventsResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
RumApi apiInstance = new RumApi(defaultClient);
try {
RUMEventsResponse result = apiInstance.listRUMEvents();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RumApi#listRUMEvents");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
// Get a list of RUM events returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_rum::ListRUMEventsOptionalParams;
use datadog_api_client::datadogV2::api_rum::RUMAPI;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = RUMAPI::with_config(configuration);
let resp = api
.list_rum_events(ListRUMEventsOptionalParams::default())
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
* Get a list of RUM events returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.RUMApi(configuration);
apiInstance
.listRUMEvents()
.then((data: v2.RUMEventsResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
POST https://api.ap1.datadoghq.com/api/v2/rum/analytics/aggregatehttps://api.datadoghq.eu/api/v2/rum/analytics/aggregatehttps://api.ddog-gov.com/api/v2/rum/analytics/aggregatehttps://api.datadoghq.com/api/v2/rum/analytics/aggregatehttps://api.us3.datadoghq.com/api/v2/rum/analytics/aggregatehttps://api.us5.datadoghq.com/api/v2/rum/analytics/aggregate
The API endpoint to aggregate RUM events into buckets of computed metrics and timeseries.
항목
유형
설명
compute
[object]
The list of metrics or timeseries to compute for the retrieved buckets.
aggregation [required]
enum
An aggregation function.
Allowed enum values: count,cardinality,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,median
interval
string
The time buckets' size (only used for type=timeseries) Defaults to a resolution of 150 points.
metric
string
The metric to use.
type
enum
The type of compute.
Allowed enum values: timeseries,total
default: total
filter
object
The search and filter query settings.
from
string
The minimum time for the requested events; supports date (in ISO 8601 format with full date, hours, minutes, and the Z
UTC indicator - seconds and fractional seconds are optional), math, and regular timestamps (in milliseconds).
default: now-15m
query
string
The search query following the RUM search syntax.
default: *
to
string
The maximum time for the requested events; supports date (in ISO 8601 format with full date, hours, minutes, and the Z
UTC indicator - seconds and fractional seconds are optional), math, and regular timestamps (in milliseconds).
default: now
group_by
[object]
The rules for the group by.
facet [required]
string
The name of the facet to use (required).
histogram
object
Used to perform a histogram computation (only for measure facets). Note: At most 100 buckets are allowed, the number of buckets is (max - min)/interval.
interval [required]
double
The bin size of the histogram buckets.
max [required]
double
The maximum value for the measure used in the histogram (values greater than this one are filtered out).
min [required]
double
The minimum value for the measure used in the histogram (values smaller than this one are filtered out).
limit
int64
The maximum buckets to return for this group-by.
default: 10
missing
<oneOf>
The value to use for logs that don't have the facet used to group by.
Option 1
string
The missing value to use if there is string valued facet.
Option 2
double
The missing value to use if there is a number valued facet.
sort
object
A sort rule.
aggregation
enum
An aggregation function.
Allowed enum values: count,cardinality,pc75,pc90,pc95,pc98,pc99,sum,min,max,avg,median
metric
string
The metric to sort by (only used for type=measure
).
order
enum
The order to use, ascending or descending.
Allowed enum values: asc,desc
type
enum
The type of sorting algorithm.
Allowed enum values: alphabetical,measure
default: alphabetical
total
<oneOf>
A resulting object to put the given computes in over all the matching records.
Option 1
boolean
If set to true, creates an additional bucket labeled "$facet_total".
Option 2
string
A string to use as the key value for the total bucket.
Option 3
double
A number to use as the key value for the total bucket.
options
object
Global query options that are used during the query. Note: Only supply timezone or time offset, not both. Otherwise, the query fails.
time_offset
int64
The time offset (in seconds) to apply to the query.
timezone
string
The timezone can be specified as GMT, UTC, an offset from UTC (like UTC+1), or as a Timezone Database identifier (like America/New_York).
default: UTC
page
object
Paging attributes for listing events.
cursor
string
List following results with a cursor provided in the previous query.
limit
int32
Maximum number of events in the response.
default: 10
{
"compute": [
{
"aggregation": "pc90",
"metric": "@view.time_spent",
"type": "total"
}
],
"filter": {
"from": "now-15m",
"query": "@type:view AND @session.type:user",
"to": "now"
},
"group_by": [
{
"facet": "@view.time_spent",
"limit": 10,
"total": false
}
],
"options": {
"timezone": "GMT"
},
"page": {
"limit": 25
}
}
OK
The response object for the RUM events aggregate API endpoint.
항목
유형
설명
data
object
The query results.
buckets
[object]
The list of matching buckets, one item per bucket.
by
object
The key-value pairs for each group-by.
<any-key>
string
The values for each group-by.
computes
object
A map of the metric name to value for regular compute, or a list of values for a timeseries.
<any-key>
<oneOf>
A bucket value, can be either a timeseries or a single value.
Option 1
string
A single string value.
Option 2
double
A single number value.
Option 3
[object]
A timeseries array.
time
date-time
The time value for this point.
value
double
The value for this point.
links
object
Links attributes.
next
string
Link for the next set of results. Note that the request can also be made using the POST endpoint.
meta
object
The metadata associated with a request.
elapsed
int64
The time elapsed in milliseconds.
page
object
Paging attributes.
after
string
The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of page[cursor]
.
request_id
string
The identifier of the request.
status
enum
The status of the response.
Allowed enum values: done,timeout
warnings
[object]
A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response.
code
string
A unique code for this type of warning.
detail
string
A detailed explanation of this specific warning.
title
string
A short human-readable summary of the warning.
{
"data": {
"buckets": [
{
"by": {
"<any-key>": "string"
},
"computes": {
"<any-key>": {
"description": "undefined",
"type": "undefined"
}
}
}
]
},
"links": {
"next": "https://app.datadoghq.com/api/v2/rum/event?filter[query]=foo\u0026page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="
},
"meta": {
"elapsed": 132,
"page": {
"after": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ=="
},
"request_id": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR",
"status": "done",
"warnings": [
{
"code": "unknown_index",
"detail": "indexes: foo, bar",
"title": "One or several indexes are missing or invalid, results hold data from the other indexes"
}
]
}
}
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"
]
}
# 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/analytics/aggregate" \
-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
{
"compute": [
{
"aggregation": "pc90",
"metric": "@view.time_spent",
"type": "total"
}
],
"filter": {
"from": "now-15m",
"query": "@type:view AND @session.type:user",
"to": "now"
},
"group_by": [
{
"facet": "@view.time_spent",
"limit": 10,
"total": false
}
],
"options": {
"timezone": "GMT"
},
"page": {
"limit": 25
}
}
EOF
// Aggregate RUM events returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
body := datadogV2.RUMAggregateRequest{
Compute: []datadogV2.RUMCompute{
{
Aggregation: datadogV2.RUMAGGREGATIONFUNCTION_PERCENTILE_90,
Metric: datadog.PtrString("@view.time_spent"),
Type: datadogV2.RUMCOMPUTETYPE_TOTAL.Ptr(),
},
},
Filter: &datadogV2.RUMQueryFilter{
From: datadog.PtrString("now-15m"),
Query: datadog.PtrString("@type:view AND @session.type:user"),
To: datadog.PtrString("now"),
},
GroupBy: []datadogV2.RUMGroupBy{
{
Facet: "@view.time_spent",
Limit: datadog.PtrInt64(10),
Total: &datadogV2.RUMGroupByTotal{
RUMGroupByTotalBoolean: datadog.PtrBool(false)},
},
},
Options: &datadogV2.RUMQueryOptions{
Timezone: datadog.PtrString("GMT"),
},
Page: &datadogV2.RUMQueryPageOptions{
Limit: datadog.PtrInt32(25),
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewRUMApi(apiClient)
resp, r, err := api.AggregateRUMEvents(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RUMApi.AggregateRUMEvents`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `RUMApi.AggregateRUMEvents`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" go run "main.go"
// Aggregate RUM events returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumApi;
import com.datadog.api.client.v2.model.RUMAggregateRequest;
import com.datadog.api.client.v2.model.RUMAggregationFunction;
import com.datadog.api.client.v2.model.RUMAnalyticsAggregateResponse;
import com.datadog.api.client.v2.model.RUMCompute;
import com.datadog.api.client.v2.model.RUMComputeType;
import com.datadog.api.client.v2.model.RUMGroupBy;
import com.datadog.api.client.v2.model.RUMGroupByTotal;
import com.datadog.api.client.v2.model.RUMQueryFilter;
import com.datadog.api.client.v2.model.RUMQueryOptions;
import com.datadog.api.client.v2.model.RUMQueryPageOptions;
import java.util.Collections;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
RumApi apiInstance = new RumApi(defaultClient);
RUMAggregateRequest body =
new RUMAggregateRequest()
.compute(
Collections.singletonList(
new RUMCompute()
.aggregation(RUMAggregationFunction.PERCENTILE_90)
.metric("@view.time_spent")
.type(RUMComputeType.TOTAL)))
.filter(
new RUMQueryFilter()
.from("now-15m")
.query("@type:view AND @session.type:user")
.to("now"))
.groupBy(
Collections.singletonList(
new RUMGroupBy()
.facet("@view.time_spent")
.limit(10L)
.total(new RUMGroupByTotal(false))))
.options(new RUMQueryOptions().timezone("GMT"))
.page(new RUMQueryPageOptions().limit(25));
try {
RUMAnalyticsAggregateResponse result = apiInstance.aggregateRUMEvents(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RumApi#aggregateRUMEvents");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" java "Example.java"
"""
Aggregate RUM events returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_api import RUMApi
from datadog_api_client.v2.model.rum_aggregate_request import RUMAggregateRequest
from datadog_api_client.v2.model.rum_aggregation_function import RUMAggregationFunction
from datadog_api_client.v2.model.rum_compute import RUMCompute
from datadog_api_client.v2.model.rum_compute_type import RUMComputeType
from datadog_api_client.v2.model.rum_group_by import RUMGroupBy
from datadog_api_client.v2.model.rum_query_filter import RUMQueryFilter
from datadog_api_client.v2.model.rum_query_options import RUMQueryOptions
from datadog_api_client.v2.model.rum_query_page_options import RUMQueryPageOptions
body = RUMAggregateRequest(
compute=[
RUMCompute(
aggregation=RUMAggregationFunction.PERCENTILE_90,
metric="@view.time_spent",
type=RUMComputeType.TOTAL,
),
],
filter=RUMQueryFilter(
_from="now-15m",
query="@type:view AND @session.type:user",
to="now",
),
group_by=[
RUMGroupBy(
facet="@view.time_spent",
limit=10,
total=False,
),
],
options=RUMQueryOptions(
timezone="GMT",
),
page=RUMQueryPageOptions(
limit=25,
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = RUMApi(api_client)
response = api_instance.aggregate_rum_events(body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" python3 "example.py"
# Aggregate RUM events returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::RUMAPI.new
body = DatadogAPIClient::V2::RUMAggregateRequest.new({
compute: [
DatadogAPIClient::V2::RUMCompute.new({
aggregation: DatadogAPIClient::V2::RUMAggregationFunction::PERCENTILE_90,
metric: "@view.time_spent",
type: DatadogAPIClient::V2::RUMComputeType::TOTAL,
}),
],
filter: DatadogAPIClient::V2::RUMQueryFilter.new({
from: "now-15m",
query: "@type:view AND @session.type:user",
to: "now",
}),
group_by: [
DatadogAPIClient::V2::RUMGroupBy.new({
facet: "@view.time_spent",
limit: 10,
total: false,
}),
],
options: DatadogAPIClient::V2::RUMQueryOptions.new({
timezone: "GMT",
}),
page: DatadogAPIClient::V2::RUMQueryPageOptions.new({
limit: 25,
}),
})
p api_instance.aggregate_rum_events(body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" rb "example.rb"
// Aggregate RUM events returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_rum::RUMAPI;
use datadog_api_client::datadogV2::model::RUMAggregateRequest;
use datadog_api_client::datadogV2::model::RUMAggregationFunction;
use datadog_api_client::datadogV2::model::RUMCompute;
use datadog_api_client::datadogV2::model::RUMComputeType;
use datadog_api_client::datadogV2::model::RUMGroupBy;
use datadog_api_client::datadogV2::model::RUMGroupByTotal;
use datadog_api_client::datadogV2::model::RUMQueryFilter;
use datadog_api_client::datadogV2::model::RUMQueryOptions;
use datadog_api_client::datadogV2::model::RUMQueryPageOptions;
#[tokio::main]
async fn main() {
let body = RUMAggregateRequest::new()
.compute(vec![RUMCompute::new(RUMAggregationFunction::PERCENTILE_90)
.metric("@view.time_spent".to_string())
.type_(RUMComputeType::TOTAL)])
.filter(
RUMQueryFilter::new()
.from("now-15m".to_string())
.query("@type:view AND @session.type:user".to_string())
.to("now".to_string()),
)
.group_by(vec![RUMGroupBy::new("@view.time_spent".to_string())
.limit(10)
.total(RUMGroupByTotal::RUMGroupByTotalBoolean(false))])
.options(RUMQueryOptions::new().timezone("GMT".to_string()))
.page(RUMQueryPageOptions::new().limit(25));
let configuration = datadog::Configuration::new();
let api = RUMAPI::with_config(configuration);
let resp = api.aggregate_rum_events(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run
/**
* Aggregate RUM events returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.RUMApi(configuration);
const params: v2.RUMApiAggregateRUMEventsRequest = {
body: {
compute: [
{
aggregation: "pc90",
metric: "@view.time_spent",
type: "total",
},
],
filter: {
from: "now-15m",
query: "@type:view AND @session.type:user",
to: "now",
},
groupBy: [
{
facet: "@view.time_spent",
limit: 10,
total: false,
},
],
options: {
timezone: "GMT",
},
page: {
limit: 25,
},
},
};
apiInstance
.aggregateRUMEvents(params)
.then((data: v2.RUMAnalyticsAggregateResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" tsc "example.ts"
PATCH https://api.ap1.datadoghq.com/api/v2/rum/applications/{id}https://api.datadoghq.eu/api/v2/rum/applications/{id}https://api.ddog-gov.com/api/v2/rum/applications/{id}https://api.datadoghq.com/api/v2/rum/applications/{id}https://api.us3.datadoghq.com/api/v2/rum/applications/{id}https://api.us5.datadoghq.com/api/v2/rum/applications/{id}
Update the RUM application with given ID in your organization.
This endpoint requires the rum_apps_write
permission.
이름
유형
설명
id [required]
string
RUM application ID.
항목
유형
설명
data [required]
object
RUM application update.
attributes
object
RUM application update attributes.
name
string
Name of the RUM application.
type
string
Type of the RUM application. Supported values are browser
, ios
, android
, react-native
, flutter
, roku
, electron
, unity
, kotlin-multiplatform
.
id [required]
string
RUM application ID.
type [required]
enum
RUM application update type.
Allowed enum values: rum_application_update
default: rum_application_update
{
"data": {
"attributes": {
"name": "updated_name_for_my_existing_rum_application",
"type": "browser"
},
"id": "abcd1234-0000-0000-abcd-1234abcd5678",
"type": "rum_application_update"
}
}
OK
RUM application response.
항목
유형
설명
data
object
RUM application.
attributes [required]
object
RUM application attributes.
application_id [required]
string
ID of the RUM application.
client_token [required]
string
Client token of the RUM application.
created_at [required]
int64
Timestamp in ms of the creation date.
created_by_handle [required]
string
Handle of the creator user.
hash
string
Hash of the RUM application. Optional.
is_active
boolean
Indicates if the RUM application is active.
name [required]
string
Name of the RUM application.
org_id [required]
int32
Org ID of the RUM application.
type [required]
string
Type of the RUM application. Supported values are browser
, ios
, android
, react-native
, flutter
, roku
, electron
, unity
, kotlin-multiplatform
.
updated_at [required]
int64
Timestamp in ms of the last update date.
updated_by_handle [required]
string
Handle of the updater user.
id [required]
string
RUM application ID.
type [required]
enum
RUM application response type.
Allowed enum values: rum_application
default: rum_application
{
"data": {
"attributes": {
"application_id": "abcd1234-0000-0000-abcd-1234abcd5678",
"client_token": "abcd1234efgh5678ijkl90abcd1234efgh0",
"created_at": 1659479836169,
"created_by_handle": "john.doe",
"hash": "string",
"is_active": true,
"name": "my_rum_application",
"org_id": 999,
"type": "browser",
"updated_at": 1659479836169,
"updated_by_handle": "jane.doe"
},
"id": "abcd1234-0000-0000-abcd-1234abcd5678",
"type": "rum_application"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Unprocessable Entity.
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export 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/${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": {
"attributes": {
"name": "updated_name_for_my_existing_rum_application",
"type": "browser"
},
"id": "abcd1234-0000-0000-abcd-1234abcd5678",
"type": "rum_application_update"
}
}
EOF
// Update a RUM application returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "rum_application" in the system
RumApplicationDataID := os.Getenv("RUM_APPLICATION_DATA_ID")
body := datadogV2.RUMApplicationUpdateRequest{
Data: datadogV2.RUMApplicationUpdate{
Attributes: &datadogV2.RUMApplicationUpdateAttributes{
Name: datadog.PtrString("updated_name_for_my_existing_rum_application"),
Type: datadog.PtrString("browser"),
},
Id: RumApplicationDataID,
Type: datadogV2.RUMAPPLICATIONUPDATETYPE_RUM_APPLICATION_UPDATE,
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewRUMApi(apiClient)
resp, r, err := api.UpdateRUMApplication(ctx, RumApplicationDataID, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RUMApi.UpdateRUMApplication`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `RUMApi.UpdateRUMApplication`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Update a RUM application returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumApi;
import com.datadog.api.client.v2.model.RUMApplicationResponse;
import com.datadog.api.client.v2.model.RUMApplicationUpdate;
import com.datadog.api.client.v2.model.RUMApplicationUpdateAttributes;
import com.datadog.api.client.v2.model.RUMApplicationUpdateRequest;
import com.datadog.api.client.v2.model.RUMApplicationUpdateType;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
RumApi apiInstance = new RumApi(defaultClient);
// there is a valid "rum_application" in the system
String RUM_APPLICATION_DATA_ID = System.getenv("RUM_APPLICATION_DATA_ID");
RUMApplicationUpdateRequest body =
new RUMApplicationUpdateRequest()
.data(
new RUMApplicationUpdate()
.attributes(
new RUMApplicationUpdateAttributes()
.name("updated_name_for_my_existing_rum_application")
.type("browser"))
.id(RUM_APPLICATION_DATA_ID)
.type(RUMApplicationUpdateType.RUM_APPLICATION_UPDATE));
try {
RUMApplicationResponse result =
apiInstance.updateRUMApplication(RUM_APPLICATION_DATA_ID, body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RumApi#updateRUMApplication");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
"""
Update a RUM application returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_api import RUMApi
from datadog_api_client.v2.model.rum_application_update import RUMApplicationUpdate
from datadog_api_client.v2.model.rum_application_update_attributes import RUMApplicationUpdateAttributes
from datadog_api_client.v2.model.rum_application_update_request import RUMApplicationUpdateRequest
from datadog_api_client.v2.model.rum_application_update_type import RUMApplicationUpdateType
# there is a valid "rum_application" in the system
RUM_APPLICATION_DATA_ID = environ["RUM_APPLICATION_DATA_ID"]
body = RUMApplicationUpdateRequest(
data=RUMApplicationUpdate(
attributes=RUMApplicationUpdateAttributes(
name="updated_name_for_my_existing_rum_application",
type="browser",
),
id=RUM_APPLICATION_DATA_ID,
type=RUMApplicationUpdateType.RUM_APPLICATION_UPDATE,
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = RUMApi(api_client)
response = api_instance.update_rum_application(id=RUM_APPLICATION_DATA_ID, body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Update a RUM application returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::RUMAPI.new
# there is a valid "rum_application" in the system
RUM_APPLICATION_DATA_ID = ENV["RUM_APPLICATION_DATA_ID"]
body = DatadogAPIClient::V2::RUMApplicationUpdateRequest.new({
data: DatadogAPIClient::V2::RUMApplicationUpdate.new({
attributes: DatadogAPIClient::V2::RUMApplicationUpdateAttributes.new({
name: "updated_name_for_my_existing_rum_application",
type: "browser",
}),
id: RUM_APPLICATION_DATA_ID,
type: DatadogAPIClient::V2::RUMApplicationUpdateType::RUM_APPLICATION_UPDATE,
}),
})
p api_instance.update_rum_application(RUM_APPLICATION_DATA_ID, body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Update a RUM application returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_rum::RUMAPI;
use datadog_api_client::datadogV2::model::RUMApplicationUpdate;
use datadog_api_client::datadogV2::model::RUMApplicationUpdateAttributes;
use datadog_api_client::datadogV2::model::RUMApplicationUpdateRequest;
use datadog_api_client::datadogV2::model::RUMApplicationUpdateType;
#[tokio::main]
async fn main() {
// there is a valid "rum_application" in the system
let rum_application_data_id = std::env::var("RUM_APPLICATION_DATA_ID").unwrap();
let body = RUMApplicationUpdateRequest::new(
RUMApplicationUpdate::new(
rum_application_data_id.clone(),
RUMApplicationUpdateType::RUM_APPLICATION_UPDATE,
)
.attributes(
RUMApplicationUpdateAttributes::new()
.name("updated_name_for_my_existing_rum_application".to_string())
.type_("browser".to_string()),
),
);
let configuration = datadog::Configuration::new();
let api = RUMAPI::with_config(configuration);
let resp = api
.update_rum_application(rum_application_data_id.clone(), body)
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Update a RUM application returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.RUMApi(configuration);
// there is a valid "rum_application" in the system
const RUM_APPLICATION_DATA_ID = process.env.RUM_APPLICATION_DATA_ID as string;
const params: v2.RUMApiUpdateRUMApplicationRequest = {
body: {
data: {
attributes: {
name: "updated_name_for_my_existing_rum_application",
type: "browser",
},
id: RUM_APPLICATION_DATA_ID,
type: "rum_application_update",
},
},
id: RUM_APPLICATION_DATA_ID,
};
apiInstance
.updateRUMApplication(params)
.then((data: v2.RUMApplicationResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
GET https://api.ap1.datadoghq.com/api/v2/rum/applications/{id}https://api.datadoghq.eu/api/v2/rum/applications/{id}https://api.ddog-gov.com/api/v2/rum/applications/{id}https://api.datadoghq.com/api/v2/rum/applications/{id}https://api.us3.datadoghq.com/api/v2/rum/applications/{id}https://api.us5.datadoghq.com/api/v2/rum/applications/{id}
Get the RUM application with given ID in your organization.
This endpoint requires the rum_apps_read
permission.
이름
유형
설명
id [required]
string
RUM application ID.
OK
RUM application response.
항목
유형
설명
data
object
RUM application.
attributes [required]
object
RUM application attributes.
application_id [required]
string
ID of the RUM application.
client_token [required]
string
Client token of the RUM application.
created_at [required]
int64
Timestamp in ms of the creation date.
created_by_handle [required]
string
Handle of the creator user.
hash
string
Hash of the RUM application. Optional.
is_active
boolean
Indicates if the RUM application is active.
name [required]
string
Name of the RUM application.
org_id [required]
int32
Org ID of the RUM application.
type [required]
string
Type of the RUM application. Supported values are browser
, ios
, android
, react-native
, flutter
, roku
, electron
, unity
, kotlin-multiplatform
.
updated_at [required]
int64
Timestamp in ms of the last update date.
updated_by_handle [required]
string
Handle of the updater user.
id [required]
string
RUM application ID.
type [required]
enum
RUM application response type.
Allowed enum values: rum_application
default: rum_application
{
"data": {
"attributes": {
"application_id": "abcd1234-0000-0000-abcd-1234abcd5678",
"client_token": "abcd1234efgh5678ijkl90abcd1234efgh0",
"created_at": 1659479836169,
"created_by_handle": "john.doe",
"hash": "string",
"is_active": true,
"name": "my_rum_application",
"org_id": 999,
"type": "browser",
"updated_at": 1659479836169,
"updated_by_handle": "jane.doe"
},
"id": "abcd1234-0000-0000-abcd-1234abcd5678",
"type": "rum_application"
}
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export 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/${id}" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get a RUM application returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_api import RUMApi
# there is a valid "rum_application" in the system
RUM_APPLICATION_DATA_ID = environ["RUM_APPLICATION_DATA_ID"]
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = RUMApi(api_client)
response = api_instance.get_rum_application(
id=RUM_APPLICATION_DATA_ID,
)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Get a RUM application returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::RUMAPI.new
# there is a valid "rum_application" in the system
RUM_APPLICATION_DATA_ID = ENV["RUM_APPLICATION_DATA_ID"]
p api_instance.get_rum_application(RUM_APPLICATION_DATA_ID)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Get a RUM application returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "rum_application" in the system
RumApplicationDataID := os.Getenv("RUM_APPLICATION_DATA_ID")
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewRUMApi(apiClient)
resp, r, err := api.GetRUMApplication(ctx, RumApplicationDataID)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RUMApi.GetRUMApplication`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `RUMApi.GetRUMApplication`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Get a RUM application returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumApi;
import com.datadog.api.client.v2.model.RUMApplicationResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
RumApi apiInstance = new RumApi(defaultClient);
// there is a valid "rum_application" in the system
String RUM_APPLICATION_DATA_ID = System.getenv("RUM_APPLICATION_DATA_ID");
try {
RUMApplicationResponse result = apiInstance.getRUMApplication(RUM_APPLICATION_DATA_ID);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RumApi#getRUMApplication");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Get a RUM application returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_rum::RUMAPI;
#[tokio::main]
async fn main() {
// there is a valid "rum_application" in the system
let rum_application_data_id = std::env::var("RUM_APPLICATION_DATA_ID").unwrap();
let configuration = datadog::Configuration::new();
let api = RUMAPI::with_config(configuration);
let resp = api
.get_rum_application(rum_application_data_id.clone())
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Get a RUM application returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.RUMApi(configuration);
// there is a valid "rum_application" in the system
const RUM_APPLICATION_DATA_ID = process.env.RUM_APPLICATION_DATA_ID as string;
const params: v2.RUMApiGetRUMApplicationRequest = {
id: RUM_APPLICATION_DATA_ID,
};
apiInstance
.getRUMApplication(params)
.then((data: v2.RUMApplicationResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
DELETE https://api.ap1.datadoghq.com/api/v2/rum/applications/{id}https://api.datadoghq.eu/api/v2/rum/applications/{id}https://api.ddog-gov.com/api/v2/rum/applications/{id}https://api.datadoghq.com/api/v2/rum/applications/{id}https://api.us3.datadoghq.com/api/v2/rum/applications/{id}https://api.us5.datadoghq.com/api/v2/rum/applications/{id}
Delete an existing RUM application in your organization.
This endpoint requires the rum_apps_write
permission.
이름
유형
설명
id [required]
string
RUM application ID.
No Content
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
# Path parameters
export 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/${id}" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Delete a RUM application returns "No Content" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_api import RUMApi
# there is a valid "rum_application" in the system
RUM_APPLICATION_DATA_ID = environ["RUM_APPLICATION_DATA_ID"]
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = RUMApi(api_client)
api_instance.delete_rum_application(
id=RUM_APPLICATION_DATA_ID,
)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Delete a RUM application returns "No Content" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::RUMAPI.new
# there is a valid "rum_application" in the system
RUM_APPLICATION_DATA_ID = ENV["RUM_APPLICATION_DATA_ID"]
api_instance.delete_rum_application(RUM_APPLICATION_DATA_ID)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Delete a RUM application returns "No Content" response
package main
import (
"context"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
// there is a valid "rum_application" in the system
RumApplicationDataID := os.Getenv("RUM_APPLICATION_DATA_ID")
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewRUMApi(apiClient)
r, err := api.DeleteRUMApplication(ctx, RumApplicationDataID)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RUMApi.DeleteRUMApplication`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Delete a RUM application returns "No Content" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumApi;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
RumApi apiInstance = new RumApi(defaultClient);
// there is a valid "rum_application" in the system
String RUM_APPLICATION_DATA_ID = System.getenv("RUM_APPLICATION_DATA_ID");
try {
apiInstance.deleteRUMApplication(RUM_APPLICATION_DATA_ID);
} catch (ApiException e) {
System.err.println("Exception when calling RumApi#deleteRUMApplication");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Delete a RUM application returns "No Content" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_rum::RUMAPI;
#[tokio::main]
async fn main() {
// there is a valid "rum_application" in the system
let rum_application_data_id = std::env::var("RUM_APPLICATION_DATA_ID").unwrap();
let configuration = datadog::Configuration::new();
let api = RUMAPI::with_config(configuration);
let resp = api
.delete_rum_application(rum_application_data_id.clone())
.await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Delete a RUM application returns "No Content" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.RUMApi(configuration);
// there is a valid "rum_application" in the system
const RUM_APPLICATION_DATA_ID = process.env.RUM_APPLICATION_DATA_ID as string;
const params: v2.RUMApiDeleteRUMApplicationRequest = {
id: RUM_APPLICATION_DATA_ID,
};
apiInstance
.deleteRUMApplication(params)
.then((data: any) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
POST https://api.ap1.datadoghq.com/api/v2/rum/applicationshttps://api.datadoghq.eu/api/v2/rum/applicationshttps://api.ddog-gov.com/api/v2/rum/applicationshttps://api.datadoghq.com/api/v2/rum/applicationshttps://api.us3.datadoghq.com/api/v2/rum/applicationshttps://api.us5.datadoghq.com/api/v2/rum/applications
Create a new RUM application in your organization.
This endpoint requires the rum_apps_write
permission.
항목
유형
설명
data [required]
object
RUM application creation.
attributes [required]
object
RUM application creation attributes.
name [required]
string
Name of the RUM application.
type
string
Type of the RUM application. Supported values are browser
, ios
, android
, react-native
, flutter
, roku
, electron
, unity
, kotlin-multiplatform
.
type [required]
enum
RUM application creation type.
Allowed enum values: rum_application_create
default: rum_application_create
{
"data": {
"attributes": {
"name": "test-rum-5c67ebb32077e1d9",
"type": "ios"
},
"type": "rum_application_create"
}
}
OK
RUM application response.
항목
유형
설명
data
object
RUM application.
attributes [required]
object
RUM application attributes.
application_id [required]
string
ID of the RUM application.
client_token [required]
string
Client token of the RUM application.
created_at [required]
int64
Timestamp in ms of the creation date.
created_by_handle [required]
string
Handle of the creator user.
hash
string
Hash of the RUM application. Optional.
is_active
boolean
Indicates if the RUM application is active.
name [required]
string
Name of the RUM application.
org_id [required]
int32
Org ID of the RUM application.
type [required]
string
Type of the RUM application. Supported values are browser
, ios
, android
, react-native
, flutter
, roku
, electron
, unity
, kotlin-multiplatform
.
updated_at [required]
int64
Timestamp in ms of the last update date.
updated_by_handle [required]
string
Handle of the updater user.
id [required]
string
RUM application ID.
type [required]
enum
RUM application response type.
Allowed enum values: rum_application
default: rum_application
{
"data": {
"attributes": {
"application_id": "abcd1234-0000-0000-abcd-1234abcd5678",
"client_token": "abcd1234efgh5678ijkl90abcd1234efgh0",
"created_at": 1659479836169,
"created_by_handle": "john.doe",
"hash": "string",
"is_active": true,
"name": "my_rum_application",
"org_id": 999,
"type": "browser",
"updated_at": 1659479836169,
"updated_by_handle": "jane.doe"
},
"id": "abcd1234-0000-0000-abcd-1234abcd5678",
"type": "rum_application"
}
}
Bad Request
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/applications" \
-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": {
"name": "test-rum-5c67ebb32077e1d9",
"type": "ios"
},
"type": "rum_application_create"
}
}
EOF
// Create a new RUM application returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
body := datadogV2.RUMApplicationCreateRequest{
Data: datadogV2.RUMApplicationCreate{
Attributes: datadogV2.RUMApplicationCreateAttributes{
Name: "test-rum-5c67ebb32077e1d9",
Type: datadog.PtrString("ios"),
},
Type: datadogV2.RUMAPPLICATIONCREATETYPE_RUM_APPLICATION_CREATE,
},
}
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewRUMApi(apiClient)
resp, r, err := api.CreateRUMApplication(ctx, body)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RUMApi.CreateRUMApplication`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `RUMApi.CreateRUMApplication`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Create a new RUM application returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumApi;
import com.datadog.api.client.v2.model.RUMApplicationCreate;
import com.datadog.api.client.v2.model.RUMApplicationCreateAttributes;
import com.datadog.api.client.v2.model.RUMApplicationCreateRequest;
import com.datadog.api.client.v2.model.RUMApplicationCreateType;
import com.datadog.api.client.v2.model.RUMApplicationResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
RumApi apiInstance = new RumApi(defaultClient);
RUMApplicationCreateRequest body =
new RUMApplicationCreateRequest()
.data(
new RUMApplicationCreate()
.attributes(
new RUMApplicationCreateAttributes()
.name("test-rum-5c67ebb32077e1d9")
.type("ios"))
.type(RUMApplicationCreateType.RUM_APPLICATION_CREATE));
try {
RUMApplicationResponse result = apiInstance.createRUMApplication(body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RumApi#createRUMApplication");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
"""
Create a new RUM application returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_api import RUMApi
from datadog_api_client.v2.model.rum_application_create import RUMApplicationCreate
from datadog_api_client.v2.model.rum_application_create_attributes import RUMApplicationCreateAttributes
from datadog_api_client.v2.model.rum_application_create_request import RUMApplicationCreateRequest
from datadog_api_client.v2.model.rum_application_create_type import RUMApplicationCreateType
body = RUMApplicationCreateRequest(
data=RUMApplicationCreate(
attributes=RUMApplicationCreateAttributes(
name="test-rum-5c67ebb32077e1d9",
type="ios",
),
type=RUMApplicationCreateType.RUM_APPLICATION_CREATE,
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = RUMApi(api_client)
response = api_instance.create_rum_application(body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Create a new RUM application returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::RUMAPI.new
body = DatadogAPIClient::V2::RUMApplicationCreateRequest.new({
data: DatadogAPIClient::V2::RUMApplicationCreate.new({
attributes: DatadogAPIClient::V2::RUMApplicationCreateAttributes.new({
name: "test-rum-5c67ebb32077e1d9",
type: "ios",
}),
type: DatadogAPIClient::V2::RUMApplicationCreateType::RUM_APPLICATION_CREATE,
}),
})
p api_instance.create_rum_application(body)
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Create a new RUM application returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_rum::RUMAPI;
use datadog_api_client::datadogV2::model::RUMApplicationCreate;
use datadog_api_client::datadogV2::model::RUMApplicationCreateAttributes;
use datadog_api_client::datadogV2::model::RUMApplicationCreateRequest;
use datadog_api_client::datadogV2::model::RUMApplicationCreateType;
#[tokio::main]
async fn main() {
let body = RUMApplicationCreateRequest::new(RUMApplicationCreate::new(
RUMApplicationCreateAttributes::new("test-rum-5c67ebb32077e1d9".to_string())
.type_("ios".to_string()),
RUMApplicationCreateType::RUM_APPLICATION_CREATE,
));
let configuration = datadog::Configuration::new();
let api = RUMAPI::with_config(configuration);
let resp = api.create_rum_application(body).await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* Create a new RUM application returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.RUMApi(configuration);
const params: v2.RUMApiCreateRUMApplicationRequest = {
body: {
data: {
attributes: {
name: "test-rum-5c67ebb32077e1d9",
type: "ios",
},
type: "rum_application_create",
},
},
};
apiInstance
.createRUMApplication(params)
.then((data: v2.RUMApplicationResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"
GET https://api.ap1.datadoghq.com/api/v2/rum/applicationshttps://api.datadoghq.eu/api/v2/rum/applicationshttps://api.ddog-gov.com/api/v2/rum/applicationshttps://api.datadoghq.com/api/v2/rum/applicationshttps://api.us3.datadoghq.com/api/v2/rum/applicationshttps://api.us5.datadoghq.com/api/v2/rum/applications
List all the RUM applications in your organization.
This endpoint requires the rum_apps_read
permission.
OK
RUM applications response.
항목
유형
설명
data
[object]
RUM applications array response.
attributes [required]
object
RUM application list attributes.
application_id [required]
string
ID of the RUM application.
created_at [required]
int64
Timestamp in ms of the creation date.
created_by_handle [required]
string
Handle of the creator user.
hash
string
Hash of the RUM application. Optional.
is_active
boolean
Indicates if the RUM application is active.
name [required]
string
Name of the RUM application.
org_id [required]
int32
Org ID of the RUM application.
type [required]
string
Type of the RUM application. Supported values are browser
, ios
, android
, react-native
, flutter
, roku
, electron
, unity
, kotlin-multiplatform
.
updated_at [required]
int64
Timestamp in ms of the last update date.
updated_by_handle [required]
string
Handle of the updater user.
id
string
RUM application ID.
type [required]
enum
RUM application list type.
Allowed enum values: rum_application
default: rum_application
{
"data": [
{
"attributes": {
"application_id": "abcd1234-0000-0000-abcd-1234abcd5678",
"created_at": 1659479836169,
"created_by_handle": "john.doe",
"hash": "string",
"is_active": true,
"name": "my_rum_application",
"org_id": 999,
"type": "browser",
"updated_at": 1659479836169,
"updated_by_handle": "jane.doe"
},
"id": "abcd1234-0000-0000-abcd-1234abcd5678",
"type": "rum_application"
}
]
}
Not Found
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/applications" \
-H "Accept: application/json" \
-H "DD-API-KEY: ${DD_API_KEY}" \
-H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
List all the RUM applications returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_api import RUMApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = RUMApi(api_client)
response = api_instance.get_rum_applications()
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# List all the RUM applications returns "OK" response
require "datadog_api_client"
api_instance = DatadogAPIClient::V2::RUMAPI.new
p api_instance.get_rum_applications()
First install the library and its dependencies and then save the example to example.rb
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// List all the RUM applications returns "OK" response
package main
import (
"context"
"encoding/json"
"fmt"
"os"
"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
)
func main() {
ctx := datadog.NewDefaultContext(context.Background())
configuration := datadog.NewConfiguration()
apiClient := datadog.NewAPIClient(configuration)
api := datadogV2.NewRUMApi(apiClient)
resp, r, err := api.GetRUMApplications(ctx)
if err != nil {
fmt.Fprintf(os.Stderr, "Error when calling `RUMApi.GetRUMApplications`: %v\n", err)
fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
}
responseContent, _ := json.MarshalIndent(resp, "", " ")
fmt.Fprintf(os.Stdout, "Response from `RUMApi.GetRUMApplications`:\n%s\n", responseContent)
}
First install the library and its dependencies and then save the example to main.go
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// List all the RUM applications returns "OK" response
import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumApi;
import com.datadog.api.client.v2.model.RUMApplicationsResponse;
public class Example {
public static void main(String[] args) {
ApiClient defaultClient = ApiClient.getDefaultApiClient();
RumApi apiInstance = new RumApi(defaultClient);
try {
RUMApplicationsResponse result = apiInstance.getRUMApplications();
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling RumApi#getRUMApplications");
System.err.println("Status code: " + e.getCode());
System.err.println("Reason: " + e.getResponseBody());
System.err.println("Response headers: " + e.getResponseHeaders());
e.printStackTrace();
}
}
}
First install the library and its dependencies and then save the example to Example.java
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// List all the RUM applications returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_rum::RUMAPI;
#[tokio::main]
async fn main() {
let configuration = datadog::Configuration::new();
let api = RUMAPI::with_config(configuration);
let resp = api.get_rum_applications().await;
if let Ok(value) = resp {
println!("{:#?}", value);
} else {
println!("{:#?}", resp.unwrap_err());
}
}
First install the library and its dependencies and then save the example to src/main.rs
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
* List all the RUM applications returns "OK" response
*/
import { client, v2 } from "@datadog/datadog-api-client";
const configuration = client.createConfiguration();
const apiInstance = new v2.RUMApi(configuration);
apiInstance
.getRUMApplications()
.then((data: v2.RUMApplicationsResponse) => {
console.log(
"API called successfully. Returned data: " + JSON.stringify(data)
);
})
.catch((error: any) => console.error(error));
First install the library and its dependencies and then save the example to example.ts
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"