For AI agents: A markdown version of this page is available at https://docs.datadoghq.com/api/latest/rum-remote-config/get-a-rum-sdk-configuration.md. A documentation index is available at /llms.txt.

Get a RUM SDK configuration

Note: This endpoint is in preview and is subject to change. If you have any feedback, contact Datadog support.

GET https://api.ap1.datadoghq.com/api/v2/remote_config/products/rum/configs/{config_id}https://api.ap2.datadoghq.com/api/v2/remote_config/products/rum/configs/{config_id}https://api.datadoghq.eu/api/v2/remote_config/products/rum/configs/{config_id}https://api.ddog-gov.com/api/v2/remote_config/products/rum/configs/{config_id}https://api.us2.ddog-gov.com/api/v2/remote_config/products/rum/configs/{config_id}https://api.uk1.datadoghq.com/api/v2/remote_config/products/rum/configs/{config_id}https://api.datadoghq.com/api/v2/remote_config/products/rum/configs/{config_id}https://api.us3.datadoghq.com/api/v2/remote_config/products/rum/configs/{config_id}https://api.us5.datadoghq.com/api/v2/remote_config/products/rum/configs/{config_id}

Overview

Retrieve a RUM SDK configuration by its identifier.

Arguments

Path Parameters

Name

Type

Description

config_id [required]

string

The ID of the RUM SDK configuration.

Response

OK

Response containing a RUM SDK configuration.

Expand All

Field

Type

Description

data [required]

object

The RUM SDK configuration data object.

attributes [required]

object

Attributes of the RUM SDK configuration.

rum [required]

object

The RUM SDK settings for a configuration.

allowed_tracing_urls

[object]

A list of URL configurations for distributed tracing.

match [required]

object

A match option used for URL or origin pattern matching.

rc_serialized_type [required]

enum

The type of match pattern, either a literal string or a regex. Allowed enum values: string,regex

value [required]

string

The value to match against.

propagator_types [required]

[string]

The list of trace propagator types to use for this URL.

allowed_tracking_origins

[object]

A list of origin patterns allowed for cross-origin session tracking.

rc_serialized_type [required]

enum

The type of match pattern, either a literal string or a regex. Allowed enum values: string,regex

value [required]

string

The value to match against.

application_id [required]

string

The ID of the RUM application this configuration belongs to.

context

[object]

A list of dynamic option key-value pairs.

key [required]

string

The key name for this dynamic configuration pair.

value [required]

object

A dynamic configuration option that extracts a value at runtime using a specified strategy.

attribute

string

The element attribute to read. Used when strategy is dom.

extractor

object

A serialized regex used as an extractor in dynamic options.

rc_serialized_type [required]

enum

The type identifier for a serialized regex. Always regex. Allowed enum values: regex

value [required]

string

The regex pattern used for extraction.

key

string

The localStorage key to read. Required when strategy is localStorage.

name

string

The cookie name to read. Required when strategy is cookie.

path

string

The JavaScript path used to extract the value. Required when strategy is js.

rc_serialized_type [required]

enum

The type identifier for a dynamic option. Always dynamic. Allowed enum values: dynamic

selector

string

The CSS selector to read from the page. Required when strategy is dom.

strategy [required]

enum

The strategy used to extract the dynamic value. Allowed enum values: js,cookie,dom,localStorage

default_privacy_level [required]

string

The default privacy masking level applied to all RUM data.

enable_privacy_for_action_name [required]

boolean

Whether to mask user-interaction action names for privacy.

env

string

The environment tag for the RUM application.

service

string

The service name tag for the RUM application.

session_replay_sample_rate [required]

int64

The percentage of collected sessions for which a replay is captured (0–100).

session_sample_rate [required]

int64

The percentage of user sessions to collect (0–100).

trace_sample_rate

int64

The percentage of requests to forward as APM traces (0–100).

track_session_across_subdomains

boolean

Whether to share a session across subdomains of the same site.

user

[object]

A list of dynamic option key-value pairs.

key [required]

string

The key name for this dynamic configuration pair.

value [required]

object

A dynamic configuration option that extracts a value at runtime using a specified strategy.

attribute

string

The element attribute to read. Used when strategy is dom.

extractor

object

A serialized regex used as an extractor in dynamic options.

rc_serialized_type [required]

enum

The type identifier for a serialized regex. Always regex. Allowed enum values: regex

value [required]

string

The regex pattern used for extraction.

key

string

The localStorage key to read. Required when strategy is localStorage.

name

string

The cookie name to read. Required when strategy is cookie.

path

string

The JavaScript path used to extract the value. Required when strategy is js.

rc_serialized_type [required]

enum

The type identifier for a dynamic option. Always dynamic. Allowed enum values: dynamic

selector

string

The CSS selector to read from the page. Required when strategy is dom.

strategy [required]

enum

The strategy used to extract the dynamic value. Allowed enum values: js,cookie,dom,localStorage

version

object

A dynamic configuration option that extracts a value at runtime using a specified strategy.

attribute

string

The element attribute to read. Used when strategy is dom.

extractor

object

A serialized regex used as an extractor in dynamic options.

rc_serialized_type [required]

enum

The type identifier for a serialized regex. Always regex. Allowed enum values: regex

value [required]

string

The regex pattern used for extraction.

key

string

The localStorage key to read. Required when strategy is localStorage.

name

string

The cookie name to read. Required when strategy is cookie.

path

string

The JavaScript path used to extract the value. Required when strategy is js.

rc_serialized_type [required]

enum

The type identifier for a dynamic option. Always dynamic. Allowed enum values: dynamic

selector

string

The CSS selector to read from the page. Required when strategy is dom.

strategy [required]

enum

The strategy used to extract the dynamic value. Allowed enum values: js,cookie,dom,localStorage

id [required]

string

The unique identifier of the RUM SDK configuration.

meta

object

Metadata associated with a RUM SDK configuration.

updated_at [required]

date-time

The timestamp of the last update to this configuration.

updated_by [required]

string

The handle of the user who last updated this configuration.

type [required]

enum

The type of the resource. The value should always be rum_sdk_config. Allowed enum values: rum_sdk_config

default: rum_sdk_config

{
  "data": {
    "attributes": {
      "rum": {
        "allowed_tracing_urls": [
          {
            "match": {
              "rc_serialized_type": "string",
              "value": "https://app.datadoghq.com"
            },
            "propagator_types": [
              "datadog",
              "tracecontext"
            ]
          }
        ],
        "allowed_tracking_origins": [
          {
            "rc_serialized_type": "string",
            "value": "https://app.datadoghq.com"
          }
        ],
        "application_id": "f80e917c-3cd0-4048-ade7-1c4c207baa99",
        "context": [
          {
            "key": "id",
            "value": {
              "attribute": "data-version",
              "extractor": {
                "rc_serialized_type": "regex",
                "value": "^https://app-.*.datadoghq.com"
              },
              "key": "app.version",
              "name": "app_version",
              "path": "application.version",
              "rc_serialized_type": "dynamic",
              "selector": "#app-version",
              "strategy": "js"
            }
          }
        ],
        "default_privacy_level": "mask-user-input",
        "enable_privacy_for_action_name": false,
        "env": "production",
        "service": "my-service",
        "session_replay_sample_rate": 10,
        "session_sample_rate": 50,
        "trace_sample_rate": 100,
        "track_session_across_subdomains": false,
        "user": [
          {
            "key": "id",
            "value": {
              "attribute": "data-version",
              "extractor": {
                "rc_serialized_type": "regex",
                "value": "^https://app-.*.datadoghq.com"
              },
              "key": "app.version",
              "name": "app_version",
              "path": "application.version",
              "rc_serialized_type": "dynamic",
              "selector": "#app-version",
              "strategy": "js"
            }
          }
        ],
        "version": {
          "attribute": "data-version",
          "extractor": {
            "rc_serialized_type": "regex",
            "value": "^https://app-.*.datadoghq.com"
          },
          "key": "app.version",
          "name": "app_version",
          "path": "application.version",
          "rc_serialized_type": "dynamic",
          "selector": "#app-version",
          "strategy": "js"
        }
      }
    },
    "id": "abc12345-1234-5678-abcd-ef1234567890",
    "meta": {
      "updated_at": "2024-01-15T09:30:00.000Z",
      "updated_by": "[email protected]"
    },
    "type": "rum_sdk_config"
  }
}

Not Authorized

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

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

Not Found

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

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

Code Example

                  # Path parameters
export config_id="abc12345-1234-5678-abcd-ef1234567890"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/remote_config/products/rum/configs/${config_id}" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}"
"""
Get a RUM SDK configuration returns "OK" response
"""

from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.rum_remote_config_api import RUMRemoteConfigApi

configuration = Configuration()
configuration.unstable_operations["get_rum_sdk_config"] = True
with ApiClient(configuration) as api_client:
    api_instance = RUMRemoteConfigApi(api_client)
    response = api_instance.get_rum_sdk_config(
        config_id="config_id",
    )

    print(response)

Instructions

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.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
# Get a RUM SDK configuration returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.unstable_operations["v2.get_rum_sdk_config".to_sym] = true
end
api_instance = DatadogAPIClient::V2::RUMRemoteConfigAPI.new
p api_instance.get_rum_sdk_config("config_id")

Instructions

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.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" rb "example.rb"
// Get a RUM SDK configuration 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()
	configuration.SetUnstableOperationEnabled("v2.GetRumSdkConfig", true)
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewRUMRemoteConfigApi(apiClient)
	resp, r, err := api.GetRumSdkConfig(ctx, "config_id")

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `RUMRemoteConfigApi.GetRumSdkConfig`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `RUMRemoteConfigApi.GetRumSdkConfig`:\n%s\n", responseContent)
}

Instructions

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.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" go run "main.go"
// Get a RUM SDK configuration returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.RumRemoteConfigApi;
import com.datadog.api.client.v2.model.RumSdkConfigResponse;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setUnstableOperationEnabled("v2.getRumSdkConfig", true);
    RumRemoteConfigApi apiInstance = new RumRemoteConfigApi(defaultClient);

    try {
      RumSdkConfigResponse result =
          apiInstance.getRumSdkConfig("abc12345-1234-5678-abcd-ef1234567890");
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling RumRemoteConfigApi#getRumSdkConfig");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

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.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" java "Example.java"
// Get a RUM SDK configuration returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_rum_remote_config::RUMRemoteConfigAPI;

#[tokio::main]
async fn main() {
    let mut configuration = datadog::Configuration::new();
    configuration.set_unstable_operation_enabled("v2.GetRumSdkConfig", true);
    let api = RUMRemoteConfigAPI::with_config(configuration);
    let resp = api.get_rum_sdk_config("config_id".to_string()).await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

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.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" cargo run
/**
 * Get a RUM SDK configuration returns "OK" response
 */

import { client, v2 } from "@datadog/datadog-api-client";

const configuration = client.createConfiguration();
configuration.unstableOperations["v2.getRumSdkConfig"] = true;
const apiInstance = new v2.RUMRemoteConfigApi(configuration);

const params: v2.RUMRemoteConfigApiGetRumSdkConfigRequest = {
  configId: "config_id",
};

apiInstance
  .getRumSdkConfig(params)
  .then((data: v2.RumSdkConfigResponse) => {
    console.log(
      "API called successfully. Returned data: " + JSON.stringify(data)
    );
  })
  .catch((error: any) => console.error(error));

Instructions

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.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" tsc "example.ts"