--- title: Rum Audience Management description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Rum Audience Management --- # Rum Audience Management Auto-generated tag Rum Audience Management ## Query accounts{% #query-accounts %} {% tab title="v2" %} **Note**: This endpoint may be subject to changes. | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/product-analytics/accounts/query | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/product-analytics/accounts/query | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/product-analytics/accounts/query | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/product-analytics/accounts/query | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/product-analytics/accounts/query | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/product-analytics/accounts/query | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/product-analytics/accounts/query | ### Overview Query accounts with flexible filtering by account properties ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------- | -------- | ------------------------------------------------------------------------------------ | | | data | object | The data object containing the resource type and attributes for querying accounts. | | data | attributes | object | Attributes for filtering and shaping the account query results. | | attributes | limit | int64 | Maximum number of account records to return in the response. | | attributes | query | string | Filter expression using account attribute conditions to narrow results. | | attributes | select_columns | [string] | List of account attribute column names to include in the response. | | attributes | sort | object | Sorting configuration specifying the field and direction for ordering query results. | | sort | field | string | The attribute field name to sort results by. | | sort | order | string | The sort direction, either ascending or descending. | | attributes | wildcard_search_term | string | Free-text term used for wildcard search across account attribute values. | | data | id | string | Unique identifier for the query account request resource. | | data | type [*required*] | enum | Query account request resource type. Allowed enum values: `query_account_request` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "limit": "integer", "query": "string", "select_columns": [], "sort": { "field": "string", "order": "string" }, "wildcard_search_term": "string" }, "id": "string", "type": "query_account_request" } } ``` {% /tab %} ### Response {% tab title="200" %} Successful response with account data {% tab title="Model" %} Response containing the query results with matched records and total count. | Parent field | Field | Type | Description | | ------------ | ---------------------- | ------ | ----------------------------------------------------------------------------------------------- | | | data | object | The data object containing the resource type and attributes of the query response. | | data | attributes | object | Attributes of the query response, containing the matched records and total count. | | attributes | hits | [] | The list of matching records returned by the query, each as a map of attribute names to values. | | attributes | total | int64 | Total number of records matching the query, regardless of the limit applied. | | data | id | string | Unique identifier for the query response resource. | | data | type [*required*] | enum | Query response resource type. Allowed enum values: `query_response` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "hits": [ { "first_browser_name": "Chrome", "first_city": "San Francisco", "first_country_code": "US", "first_device_type": "Desktop", "last_seen": "2025-08-14T06:45:12.142Z", "session_count": 47, "user_created": "2024-12-15T08:42:33.287Z", "user_email": "john.smith@techcorp.com", "user_id": "150847", "user_name": "John Smith", "user_org_id": "5001" }, { "first_browser_name": "Chrome", "first_city": "Austin", "first_country_code": "US", "first_device_type": "Desktop", "last_seen": "2025-08-14T05:22:08.951Z", "session_count": 89, "user_created": "2024-11-28T14:17:45.634Z", "user_email": "john.williams@techcorp.com", "user_id": "150848", "user_name": "John Williams", "user_org_id": "5001" }, { "first_browser_name": "Chrome", "first_city": "Seattle", "first_country_code": "US", "first_device_type": "Desktop", "last_seen": "2025-08-14T04:18:34.726Z", "session_count": 23, "user_created": "2025-01-03T16:33:21.445Z", "user_email": "john.jones@techcorp.com", "user_id": "150849", "user_name": "John Jones", "user_org_id": "5001" } ], "total": 147 }, "id": "query_response", "type": "query_response" } } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl commandcurl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.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/product-analytics/accounts/query" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "type": "query_account_request" } } EOF ##### ```python """ Query accounts returns "Successful response with account data" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_audience_management_api import RumAudienceManagementApi from datadog_api_client.v2.model.query_account_request import QueryAccountRequest from datadog_api_client.v2.model.query_account_request_data import QueryAccountRequestData from datadog_api_client.v2.model.query_account_request_data_attributes import QueryAccountRequestDataAttributes from datadog_api_client.v2.model.query_account_request_data_attributes_sort import QueryAccountRequestDataAttributesSort from datadog_api_client.v2.model.query_account_request_data_type import QueryAccountRequestDataType body = QueryAccountRequest( data=QueryAccountRequestData( attributes=QueryAccountRequestDataAttributes( limit=20, query="plan_type:enterprise AND user_count:>100 AND subscription_status:active", select_columns=[ "account_id", "account_name", "user_count", "plan_type", "subscription_status", "created_at", "mrr", "industry", ], sort=QueryAccountRequestDataAttributesSort( field="user_count", order="DESC", ), wildcard_search_term="tech", ), id="query_account_request", type=QueryAccountRequestDataType.QUERY_ACCOUNT_REQUEST, ), ) configuration = Configuration() configuration.unstable_operations["query_accounts"] = True with ApiClient(configuration) as api_client: api_instance = RumAudienceManagementApi(api_client) response = api_instance.query_accounts(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Query accounts returns "Successful response with account data" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.query_accounts".to_sym] = true end api_instance = DatadogAPIClient::V2::RumAudienceManagementAPI.new body = DatadogAPIClient::V2::QueryAccountRequest.new({ data: DatadogAPIClient::V2::QueryAccountRequestData.new({ attributes: DatadogAPIClient::V2::QueryAccountRequestDataAttributes.new({ limit: 20, query: "plan_type:enterprise AND user_count:>100 AND subscription_status:active", select_columns: [ "account_id", "account_name", "user_count", "plan_type", "subscription_status", "created_at", "mrr", "industry", ], sort: DatadogAPIClient::V2::QueryAccountRequestDataAttributesSort.new({ field: "user_count", order: "DESC", }), wildcard_search_term: "tech", }), id: "query_account_request", type: DatadogAPIClient::V2::QueryAccountRequestDataType::QUERY_ACCOUNT_REQUEST, }), }) p api_instance.query_accounts(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Query accounts returns "Successful response with account data" 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.QueryAccountRequest{ Data: &datadogV2.QueryAccountRequestData{ Attributes: &datadogV2.QueryAccountRequestDataAttributes{ Limit: datadog.PtrInt64(20), Query: datadog.PtrString("plan_type:enterprise AND user_count:>100 AND subscription_status:active"), SelectColumns: []string{ "account_id", "account_name", "user_count", "plan_type", "subscription_status", "created_at", "mrr", "industry", }, Sort: &datadogV2.QueryAccountRequestDataAttributesSort{ Field: datadog.PtrString("user_count"), Order: datadog.PtrString("DESC"), }, WildcardSearchTerm: datadog.PtrString("tech"), }, Id: datadog.PtrString("query_account_request"), Type: datadogV2.QUERYACCOUNTREQUESTDATATYPE_QUERY_ACCOUNT_REQUEST, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.QueryAccounts", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRumAudienceManagementApi(apiClient) resp, r, err := api.QueryAccounts(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RumAudienceManagementApi.QueryAccounts`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `RumAudienceManagementApi.QueryAccounts`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Query accounts returns "Successful response with account data" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumAudienceManagementApi; import com.datadog.api.client.v2.model.QueryAccountRequest; import com.datadog.api.client.v2.model.QueryAccountRequestData; import com.datadog.api.client.v2.model.QueryAccountRequestDataAttributes; import com.datadog.api.client.v2.model.QueryAccountRequestDataAttributesSort; import com.datadog.api.client.v2.model.QueryAccountRequestDataType; import com.datadog.api.client.v2.model.QueryResponse; import java.util.Arrays; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.queryAccounts", true); RumAudienceManagementApi apiInstance = new RumAudienceManagementApi(defaultClient); QueryAccountRequest body = new QueryAccountRequest() .data( new QueryAccountRequestData() .attributes( new QueryAccountRequestDataAttributes() .limit(20L) .query( "plan_type:enterprise AND user_count:>100 AND" + " subscription_status:active") .selectColumns( Arrays.asList( "account_id", "account_name", "user_count", "plan_type", "subscription_status", "created_at", "mrr", "industry")) .sort( new QueryAccountRequestDataAttributesSort() .field("user_count") .order("DESC")) .wildcardSearchTerm("tech")) .id("query_account_request") .type(QueryAccountRequestDataType.QUERY_ACCOUNT_REQUEST)); try { QueryResponse result = apiInstance.queryAccounts(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RumAudienceManagementApi#queryAccounts"); 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](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Query accounts returns "Successful response with account data" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum_audience_management::RumAudienceManagementAPI; use datadog_api_client::datadogV2::model::QueryAccountRequest; use datadog_api_client::datadogV2::model::QueryAccountRequestData; use datadog_api_client::datadogV2::model::QueryAccountRequestDataAttributes; use datadog_api_client::datadogV2::model::QueryAccountRequestDataAttributesSort; use datadog_api_client::datadogV2::model::QueryAccountRequestDataType; #[tokio::main] async fn main() { let body = QueryAccountRequest::new().data( QueryAccountRequestData::new(QueryAccountRequestDataType::QUERY_ACCOUNT_REQUEST) .attributes( QueryAccountRequestDataAttributes::new() .limit(20) .query( "plan_type:enterprise AND user_count:>100 AND subscription_status:active" .to_string(), ) .select_columns(vec![ "account_id".to_string(), "account_name".to_string(), "user_count".to_string(), "plan_type".to_string(), "subscription_status".to_string(), "created_at".to_string(), "mrr".to_string(), "industry".to_string(), ]) .sort( QueryAccountRequestDataAttributesSort::new() .field("user_count".to_string()) .order("DESC".to_string()), ) .wildcard_search_term("tech".to_string()), ) .id("query_account_request".to_string()), ); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.QueryAccounts", true); let api = RumAudienceManagementAPI::with_config(configuration); let resp = api.query_accounts(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) 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.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Query accounts returns "Successful response with account data" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.queryAccounts"] = true; const apiInstance = new v2.RumAudienceManagementApi(configuration); const params: v2.RumAudienceManagementApiQueryAccountsRequest = { body: { data: { attributes: { limit: 20, query: "plan_type:enterprise AND user_count:>100 AND subscription_status:active", selectColumns: [ "account_id", "account_name", "user_count", "plan_type", "subscription_status", "created_at", "mrr", "industry", ], sort: { field: "user_count", order: "DESC", }, wildcardSearchTerm: "tech", }, id: "query_account_request", type: "query_account_request", }, }, }; apiInstance .queryAccounts(params) .then((data: v2.QueryResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Create connection{% #create-connection %} {% tab title="v2" %} **Note**: This endpoint may be subject to changes. | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/product-analytics/{entity}/mapping/connection | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/product-analytics/{entity}/mapping/connection | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection | ### Overview Create a new data connection and its fields for an entity ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------ | ------ | --------------------------------------------- | | entity [*required*] | string | The entity for which to create the connection | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | -------------------- | -------------------------------- | -------- | ------------------------------------------------------------------------------------------------ | | | data | object | The data object containing the resource type and attributes for creating a new connection. | | data | attributes | object | Attributes defining the data source connection, including join configuration and custom fields. | | attributes | fields | [object] | List of custom attribute fields to import from the data source. | | fields | description | string | Human-readable explanation of what the field represents. | | fields | display_name | string | The human-readable label for the field shown in the UI. | | fields | groups | [string] | List of group labels used to categorize the field. | | fields | id [*required*] | string | The unique identifier for the field within the connection. | | fields | source_name [*required*] | string | The name of the column or attribute in the source data system that maps to this field. | | fields | type [*required*] | string | The data type of the field (for example, string or number). | | attributes | join_attribute [*required*] | string | The attribute in the data source used to join records with the entity. | | attributes | join_type [*required*] | string | The type of join key used to link the data source to the entity (for example, email or user_id). | | attributes | metadata | object | Additional key-value metadata associated with the connection. | | additionalProperties | | string | | attributes | type [*required*] | string | The type of data source connection (for example, ref_table). | | data | id | string | Unique identifier for the new connection resource. | | data | type [*required*] | enum | Connection id resource type. Allowed enum values: `connection_id` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "fields": [ { "description": "string", "display_name": "string", "groups": [], "id": "", "source_name": "", "type": "" } ], "join_attribute": "", "join_type": "", "metadata": { "": "string" }, "type": "" }, "id": "string", "type": "connection_id" } } ``` {% /tab %} ### Response {% tab title="201" %} Connection created successfully {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parametersexport entity="users"\# Curl commandcurl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.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/product-analytics/${entity}/mapping/connection" \ -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": { "fields": [ { "id": "", "source_name": "", "type": "" } ], "join_attribute": "", "join_type": "", "type": "" }, "type": "connection_id" } } EOF ##### ```python """ Create connection returns "Connection created successfully" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_audience_management_api import RumAudienceManagementApi from datadog_api_client.v2.model.create_connection_request import CreateConnectionRequest from datadog_api_client.v2.model.create_connection_request_data import CreateConnectionRequestData from datadog_api_client.v2.model.create_connection_request_data_attributes import CreateConnectionRequestDataAttributes from datadog_api_client.v2.model.create_connection_request_data_attributes_fields_items import ( CreateConnectionRequestDataAttributesFieldsItems, ) from datadog_api_client.v2.model.update_connection_request_data_type import UpdateConnectionRequestDataType body = CreateConnectionRequest( data=CreateConnectionRequestData( attributes=CreateConnectionRequestDataAttributes( fields=[ CreateConnectionRequestDataAttributesFieldsItems( description="Customer subscription tier from `CRM`", display_name="Customer Tier", id="customer_tier", source_name="subscription_tier", type="string", ), CreateConnectionRequestDataAttributesFieldsItems( description="Customer lifetime value in `USD`", display_name="Lifetime Value", id="lifetime_value", source_name="ltv", type="number", ), ], join_attribute="user_email", join_type="email", type="ref_table", ), id="crm-integration", type=UpdateConnectionRequestDataType.CONNECTION_ID, ), ) configuration = Configuration() configuration.unstable_operations["create_connection"] = True with ApiClient(configuration) as api_client: api_instance = RumAudienceManagementApi(api_client) api_instance.create_connection(entity="users", body=body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Create connection returns "Connection created successfully" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.create_connection".to_sym] = true end api_instance = DatadogAPIClient::V2::RumAudienceManagementAPI.new body = DatadogAPIClient::V2::CreateConnectionRequest.new({ data: DatadogAPIClient::V2::CreateConnectionRequestData.new({ attributes: DatadogAPIClient::V2::CreateConnectionRequestDataAttributes.new({ fields: [ DatadogAPIClient::V2::CreateConnectionRequestDataAttributesFieldsItems.new({ description: "Customer subscription tier from `CRM`", display_name: "Customer Tier", id: "customer_tier", source_name: "subscription_tier", type: "string", }), DatadogAPIClient::V2::CreateConnectionRequestDataAttributesFieldsItems.new({ description: "Customer lifetime value in `USD`", display_name: "Lifetime Value", id: "lifetime_value", source_name: "ltv", type: "number", }), ], join_attribute: "user_email", join_type: "email", type: "ref_table", }), id: "crm-integration", type: DatadogAPIClient::V2::UpdateConnectionRequestDataType::CONNECTION_ID, }), }) p api_instance.create_connection("users", body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Create connection returns "Connection created successfully" 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() { body := datadogV2.CreateConnectionRequest{ Data: &datadogV2.CreateConnectionRequestData{ Attributes: &datadogV2.CreateConnectionRequestDataAttributes{ Fields: []datadogV2.CreateConnectionRequestDataAttributesFieldsItems{ { Description: datadog.PtrString(`Customer subscription tier from ` + "`" + `CRM` + "`"), DisplayName: datadog.PtrString("Customer Tier"), Id: "customer_tier", SourceName: "subscription_tier", Type: "string", }, { Description: datadog.PtrString(`Customer lifetime value in ` + "`" + `USD` + "`"), DisplayName: datadog.PtrString("Lifetime Value"), Id: "lifetime_value", SourceName: "ltv", Type: "number", }, }, JoinAttribute: "user_email", JoinType: "email", Type: "ref_table", }, Id: datadog.PtrString("crm-integration"), Type: datadogV2.UPDATECONNECTIONREQUESTDATATYPE_CONNECTION_ID, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.CreateConnection", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRumAudienceManagementApi(apiClient) r, err := api.CreateConnection(ctx, "users", body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RumAudienceManagementApi.CreateConnection`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Create connection returns "Connection created successfully" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumAudienceManagementApi; import com.datadog.api.client.v2.model.CreateConnectionRequest; import com.datadog.api.client.v2.model.CreateConnectionRequestData; import com.datadog.api.client.v2.model.CreateConnectionRequestDataAttributes; import com.datadog.api.client.v2.model.CreateConnectionRequestDataAttributesFieldsItems; import com.datadog.api.client.v2.model.UpdateConnectionRequestDataType; import java.util.Arrays; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.createConnection", true); RumAudienceManagementApi apiInstance = new RumAudienceManagementApi(defaultClient); CreateConnectionRequest body = new CreateConnectionRequest() .data( new CreateConnectionRequestData() .attributes( new CreateConnectionRequestDataAttributes() .fields( Arrays.asList( new CreateConnectionRequestDataAttributesFieldsItems() .description("Customer subscription tier from `CRM`") .displayName("Customer Tier") .id("customer_tier") .sourceName("subscription_tier") .type("string"), new CreateConnectionRequestDataAttributesFieldsItems() .description("Customer lifetime value in `USD`") .displayName("Lifetime Value") .id("lifetime_value") .sourceName("ltv") .type("number"))) .joinAttribute("user_email") .joinType("email") .type("ref_table")) .id("crm-integration") .type(UpdateConnectionRequestDataType.CONNECTION_ID)); try { apiInstance.createConnection("users", body); } catch (ApiException e) { System.err.println("Exception when calling RumAudienceManagementApi#createConnection"); 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](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Create connection returns "Connection created successfully" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum_audience_management::RumAudienceManagementAPI; use datadog_api_client::datadogV2::model::CreateConnectionRequest; use datadog_api_client::datadogV2::model::CreateConnectionRequestData; use datadog_api_client::datadogV2::model::CreateConnectionRequestDataAttributes; use datadog_api_client::datadogV2::model::CreateConnectionRequestDataAttributesFieldsItems; use datadog_api_client::datadogV2::model::UpdateConnectionRequestDataType; #[tokio::main] async fn main() { let body = CreateConnectionRequest::new().data( CreateConnectionRequestData::new(UpdateConnectionRequestDataType::CONNECTION_ID) .attributes( CreateConnectionRequestDataAttributes::new( "user_email".to_string(), "email".to_string(), "ref_table".to_string(), ) .fields(vec![ CreateConnectionRequestDataAttributesFieldsItems::new( "customer_tier".to_string(), "subscription_tier".to_string(), "string".to_string(), ) .description(r#"Customer subscription tier from `CRM`"#.to_string()) .display_name("Customer Tier".to_string()), CreateConnectionRequestDataAttributesFieldsItems::new( "lifetime_value".to_string(), "ltv".to_string(), "number".to_string(), ) .description(r#"Customer lifetime value in `USD`"#.to_string()) .display_name("Lifetime Value".to_string()), ]), ) .id("crm-integration".to_string()), ); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.CreateConnection", true); let api = RumAudienceManagementAPI::with_config(configuration); let resp = api.create_connection("users".to_string(), body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) 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.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Create connection returns "Connection created successfully" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.createConnection"] = true; const apiInstance = new v2.RumAudienceManagementApi(configuration); const params: v2.RumAudienceManagementApiCreateConnectionRequest = { body: { data: { attributes: { fields: [ { description: `Customer subscription tier from ` + "`" + `CRM` + "`", displayName: "Customer Tier", id: "customer_tier", sourceName: "subscription_tier", type: "string", }, { description: `Customer lifetime value in ` + "`" + `USD` + "`", displayName: "Lifetime Value", id: "lifetime_value", sourceName: "ltv", type: "number", }, ], joinAttribute: "user_email", joinType: "email", type: "ref_table", }, id: "crm-integration", type: "connection_id", }, }, entity: "users", }; apiInstance .createConnection(params) .then((data: any) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Update connection{% #update-connection %} {% tab title="v2" %} **Note**: This endpoint may be subject to changes. | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------------------- | | ap1.datadoghq.com | PUT https://api.ap1.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection | | ap2.datadoghq.com | PUT https://api.ap2.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection | | app.datadoghq.eu | PUT https://api.datadoghq.eu/api/v2/product-analytics/{entity}/mapping/connection | | app.ddog-gov.com | PUT https://api.ddog-gov.com/api/v2/product-analytics/{entity}/mapping/connection | | app.datadoghq.com | PUT https://api.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection | | us3.datadoghq.com | PUT https://api.us3.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection | | us5.datadoghq.com | PUT https://api.us5.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection | ### Overview Update an existing data connection by adding, updating, or deleting fields ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------ | ------ | --------------------------------------------- | | entity [*required*] | string | The entity for which to update the connection | ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ---------------- | ----------------------------- | -------- | ------------------------------------------------------------------------------------------------------ | | | data | object | The data object containing the resource identifier and attributes for updating an existing connection. | | data | attributes | object | Attributes specifying the field modifications to apply to an existing connection. | | attributes | fields_to_add | [object] | New fields to add to the connection from the data source. | | fields_to_add | description | string | Human-readable explanation of what the field represents. | | fields_to_add | display_name | string | The human-readable label for the field shown in the UI. | | fields_to_add | groups | [string] | List of group labels used to categorize the field. | | fields_to_add | id [*required*] | string | The unique identifier for the field within the connection. | | fields_to_add | source_name [*required*] | string | The name of the column or attribute in the source data system that maps to this field. | | fields_to_add | type [*required*] | string | The data type of the field (for example, string or number). | | attributes | fields_to_delete | [string] | Identifiers of existing fields to remove from the connection. | | attributes | fields_to_update | [object] | Existing fields with updated metadata to apply to the connection. | | fields_to_update | field_id [*required*] | string | The identifier of the existing field to update. | | fields_to_update | updated_description | string | The new description to set for the field. | | fields_to_update | updated_display_name | string | The new human-readable display name to set for the field. | | fields_to_update | updated_field_id | string | The new identifier to assign to the field, if renaming it. | | fields_to_update | updated_groups | [string] | The updated list of group labels to associate with the field. | | data | id [*required*] | string | The unique identifier of the connection to update. | | data | type [*required*] | enum | Connection id resource type. Allowed enum values: `connection_id` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "fields_to_add": [ { "description": "string", "display_name": "string", "groups": [], "id": "", "source_name": "", "type": "" } ], "fields_to_delete": [], "fields_to_update": [ { "field_id": "", "updated_description": "string", "updated_display_name": "string", "updated_field_id": "string", "updated_groups": [] } ] }, "id": "", "type": "connection_id" } } ``` {% /tab %} ### Response {% tab title="200" %} Connection updated successfully {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parametersexport entity="users"\# Curl commandcurl -X PUT "https://api.ap1.datadoghq.com"https://api.ap2.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/product-analytics/${entity}/mapping/connection" \ -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": { "fields_to_add": [ { "id": "", "source_name": "", "type": "" } ], "fields_to_update": [ { "field_id": "" } ] }, "id": "", "type": "connection_id" } } EOF ##### ```python """ Update connection returns "Connection updated successfully" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_audience_management_api import RumAudienceManagementApi from datadog_api_client.v2.model.create_connection_request_data_attributes_fields_items import ( CreateConnectionRequestDataAttributesFieldsItems, ) from datadog_api_client.v2.model.update_connection_request import UpdateConnectionRequest from datadog_api_client.v2.model.update_connection_request_data import UpdateConnectionRequestData from datadog_api_client.v2.model.update_connection_request_data_attributes import UpdateConnectionRequestDataAttributes from datadog_api_client.v2.model.update_connection_request_data_attributes_fields_to_update_items import ( UpdateConnectionRequestDataAttributesFieldsToUpdateItems, ) from datadog_api_client.v2.model.update_connection_request_data_type import UpdateConnectionRequestDataType body = UpdateConnectionRequest( data=UpdateConnectionRequestData( attributes=UpdateConnectionRequestDataAttributes( fields_to_add=[ CreateConnectionRequestDataAttributesFieldsItems( description="Net Promoter Score from customer surveys", display_name="NPS Score", groups=[ "Satisfaction", "Metrics", ], id="nps_score", source_name="net_promoter_score", type="number", ), ], fields_to_delete=[ "old_revenue_field", ], fields_to_update=[ UpdateConnectionRequestDataAttributesFieldsToUpdateItems( field_id="lifetime_value", updated_display_name="Customer Lifetime Value (`USD`)", updated_groups=[ "Financial", "Metrics", ], ), ], ), id="crm-integration", type=UpdateConnectionRequestDataType.CONNECTION_ID, ), ) configuration = Configuration() configuration.unstable_operations["update_connection"] = True with ApiClient(configuration) as api_client: api_instance = RumAudienceManagementApi(api_client) api_instance.update_connection(entity="users", body=body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Update connection returns "Connection updated successfully" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.update_connection".to_sym] = true end api_instance = DatadogAPIClient::V2::RumAudienceManagementAPI.new body = DatadogAPIClient::V2::UpdateConnectionRequest.new({ data: DatadogAPIClient::V2::UpdateConnectionRequestData.new({ attributes: DatadogAPIClient::V2::UpdateConnectionRequestDataAttributes.new({ fields_to_add: [ DatadogAPIClient::V2::CreateConnectionRequestDataAttributesFieldsItems.new({ description: "Net Promoter Score from customer surveys", display_name: "NPS Score", groups: [ "Satisfaction", "Metrics", ], id: "nps_score", source_name: "net_promoter_score", type: "number", }), ], fields_to_delete: [ "old_revenue_field", ], fields_to_update: [ DatadogAPIClient::V2::UpdateConnectionRequestDataAttributesFieldsToUpdateItems.new({ field_id: "lifetime_value", updated_display_name: "Customer Lifetime Value (`USD`)", updated_groups: [ "Financial", "Metrics", ], }), ], }), id: "crm-integration", type: DatadogAPIClient::V2::UpdateConnectionRequestDataType::CONNECTION_ID, }), }) p api_instance.update_connection("users", body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Update connection returns "Connection updated successfully" 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() { body := datadogV2.UpdateConnectionRequest{ Data: &datadogV2.UpdateConnectionRequestData{ Attributes: &datadogV2.UpdateConnectionRequestDataAttributes{ FieldsToAdd: []datadogV2.CreateConnectionRequestDataAttributesFieldsItems{ { Description: datadog.PtrString("Net Promoter Score from customer surveys"), DisplayName: datadog.PtrString("NPS Score"), Groups: []string{ "Satisfaction", "Metrics", }, Id: "nps_score", SourceName: "net_promoter_score", Type: "number", }, }, FieldsToDelete: []string{ "old_revenue_field", }, FieldsToUpdate: []datadogV2.UpdateConnectionRequestDataAttributesFieldsToUpdateItems{ { FieldId: "lifetime_value", UpdatedDisplayName: datadog.PtrString(`Customer Lifetime Value (` + "`" + `USD` + "`" + `)`), UpdatedGroups: []string{ "Financial", "Metrics", }, }, }, }, Id: "crm-integration", Type: datadogV2.UPDATECONNECTIONREQUESTDATATYPE_CONNECTION_ID, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.UpdateConnection", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRumAudienceManagementApi(apiClient) r, err := api.UpdateConnection(ctx, "users", body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RumAudienceManagementApi.UpdateConnection`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Update connection returns "Connection updated successfully" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumAudienceManagementApi; import com.datadog.api.client.v2.model.CreateConnectionRequestDataAttributesFieldsItems; import com.datadog.api.client.v2.model.UpdateConnectionRequest; import com.datadog.api.client.v2.model.UpdateConnectionRequestData; import com.datadog.api.client.v2.model.UpdateConnectionRequestDataAttributes; import com.datadog.api.client.v2.model.UpdateConnectionRequestDataAttributesFieldsToUpdateItems; import com.datadog.api.client.v2.model.UpdateConnectionRequestDataType; import java.util.Arrays; import java.util.Collections; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.updateConnection", true); RumAudienceManagementApi apiInstance = new RumAudienceManagementApi(defaultClient); UpdateConnectionRequest body = new UpdateConnectionRequest() .data( new UpdateConnectionRequestData() .attributes( new UpdateConnectionRequestDataAttributes() .fieldsToAdd( Collections.singletonList( new CreateConnectionRequestDataAttributesFieldsItems() .description("Net Promoter Score from customer surveys") .displayName("NPS Score") .groups(Arrays.asList("Satisfaction", "Metrics")) .id("nps_score") .sourceName("net_promoter_score") .type("number"))) .fieldsToDelete(Collections.singletonList("old_revenue_field")) .fieldsToUpdate( Collections.singletonList( new UpdateConnectionRequestDataAttributesFieldsToUpdateItems() .fieldId("lifetime_value") .updatedDisplayName("Customer Lifetime Value (`USD`)") .updatedGroups(Arrays.asList("Financial", "Metrics"))))) .id("crm-integration") .type(UpdateConnectionRequestDataType.CONNECTION_ID)); try { apiInstance.updateConnection("users", body); } catch (ApiException e) { System.err.println("Exception when calling RumAudienceManagementApi#updateConnection"); 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](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Update connection returns "Connection updated successfully" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum_audience_management::RumAudienceManagementAPI; use datadog_api_client::datadogV2::model::CreateConnectionRequestDataAttributesFieldsItems; use datadog_api_client::datadogV2::model::UpdateConnectionRequest; use datadog_api_client::datadogV2::model::UpdateConnectionRequestData; use datadog_api_client::datadogV2::model::UpdateConnectionRequestDataAttributes; use datadog_api_client::datadogV2::model::UpdateConnectionRequestDataAttributesFieldsToUpdateItems; use datadog_api_client::datadogV2::model::UpdateConnectionRequestDataType; #[tokio::main] async fn main() { let body = UpdateConnectionRequest::new().data( UpdateConnectionRequestData::new( "crm-integration".to_string(), UpdateConnectionRequestDataType::CONNECTION_ID, ) .attributes( UpdateConnectionRequestDataAttributes::new() .fields_to_add(vec![CreateConnectionRequestDataAttributesFieldsItems::new( "nps_score".to_string(), "net_promoter_score".to_string(), "number".to_string(), ) .description("Net Promoter Score from customer surveys".to_string()) .display_name("NPS Score".to_string()) .groups(vec!["Satisfaction".to_string(), "Metrics".to_string()])]) .fields_to_delete(vec!["old_revenue_field".to_string()]) .fields_to_update(vec![ UpdateConnectionRequestDataAttributesFieldsToUpdateItems::new( "lifetime_value".to_string(), ) .updated_display_name(r#"Customer Lifetime Value (`USD`)"#.to_string()) .updated_groups(vec!["Financial".to_string(), "Metrics".to_string()]), ]), ), ); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.UpdateConnection", true); let api = RumAudienceManagementAPI::with_config(configuration); let resp = api.update_connection("users".to_string(), body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) 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.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Update connection returns "Connection updated successfully" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.updateConnection"] = true; const apiInstance = new v2.RumAudienceManagementApi(configuration); const params: v2.RumAudienceManagementApiUpdateConnectionRequest = { body: { data: { attributes: { fieldsToAdd: [ { description: "Net Promoter Score from customer surveys", displayName: "NPS Score", groups: ["Satisfaction", "Metrics"], id: "nps_score", sourceName: "net_promoter_score", type: "number", }, ], fieldsToDelete: ["old_revenue_field"], fieldsToUpdate: [ { fieldId: "lifetime_value", updatedDisplayName: `Customer Lifetime Value (` + "`" + `USD` + "`" + `)`, updatedGroups: ["Financial", "Metrics"], }, ], }, id: "crm-integration", type: "connection_id", }, }, entity: "users", }; apiInstance .updateConnection(params) .then((data: any) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Query event filtered users{% #query-event-filtered-users %} {% tab title="v2" %} **Note**: This endpoint may be subject to changes. | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/product-analytics/users/event_filtered_query | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/product-analytics/users/event_filtered_query | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/product-analytics/users/event_filtered_query | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/product-analytics/users/event_filtered_query | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/product-analytics/users/event_filtered_query | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/product-analytics/users/event_filtered_query | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/product-analytics/users/event_filtered_query | ### Overview Query users filtered by both user properties and event platform data ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------- | -------- | ----------------------------------------------------------------------------------------------------------- | | | data | object | The data object containing the resource type and attributes for querying event-filtered users. | | data | attributes | object | Attributes for filtering users by both user properties and event platform activity. | | attributes | event_query | object | Event platform query used to filter users based on their event activity within a specified time window. | | event_query | query | string | The event platform query expression for filtering users by their event activity. | | event_query | time_frame | object | The time window defining the start and end of the event query period as Unix timestamps. | | time_frame | end | int64 | End of the time frame as a Unix timestamp in seconds. | | time_frame | start | int64 | Start of the time frame as a Unix timestamp in seconds. | | attributes | include_row_count | boolean | Whether to include the total count of matching users in the response. | | attributes | limit | int64 | Maximum number of user records to return in the response. | | attributes | query | string | Filter expression using user attribute conditions to narrow results. | | attributes | select_columns | [string] | List of user attribute column names to include in the response. | | data | id | string | Unique identifier for the query event filtered users request resource. | | data | type [*required*] | enum | Query event filtered users request resource type. Allowed enum values: `query_event_filtered_users_request` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "event_query": { "query": "string", "time_frame": { "end": "integer", "start": "integer" } }, "include_row_count": false, "limit": "integer", "query": "string", "select_columns": [] }, "id": "string", "type": "query_event_filtered_users_request" } } ``` {% /tab %} ### Response {% tab title="200" %} Successful response with filtered user data {% tab title="Model" %} Response containing the query results with matched records and total count. | Parent field | Field | Type | Description | | ------------ | ---------------------- | ------ | ----------------------------------------------------------------------------------------------- | | | data | object | The data object containing the resource type and attributes of the query response. | | data | attributes | object | Attributes of the query response, containing the matched records and total count. | | attributes | hits | [] | The list of matching records returned by the query, each as a map of attribute names to values. | | attributes | total | int64 | Total number of records matching the query, regardless of the limit applied. | | data | id | string | Unique identifier for the query response resource. | | data | type [*required*] | enum | Query response resource type. Allowed enum values: `query_response` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "hits": [ { "first_browser_name": "Chrome", "first_city": "San Francisco", "first_country_code": "US", "first_device_type": "Desktop", "last_seen": "2025-08-14T06:45:12.142Z", "session_count": 47, "user_created": "2024-12-15T08:42:33.287Z", "user_email": "john.smith@techcorp.com", "user_id": "150847", "user_name": "John Smith", "user_org_id": "5001" }, { "first_browser_name": "Chrome", "first_city": "Austin", "first_country_code": "US", "first_device_type": "Desktop", "last_seen": "2025-08-14T05:22:08.951Z", "session_count": 89, "user_created": "2024-11-28T14:17:45.634Z", "user_email": "john.williams@techcorp.com", "user_id": "150848", "user_name": "John Williams", "user_org_id": "5001" }, { "first_browser_name": "Chrome", "first_city": "Seattle", "first_country_code": "US", "first_device_type": "Desktop", "last_seen": "2025-08-14T04:18:34.726Z", "session_count": 23, "user_created": "2025-01-03T16:33:21.445Z", "user_email": "john.jones@techcorp.com", "user_id": "150849", "user_name": "John Jones", "user_org_id": "5001" } ], "total": 147 }, "id": "query_response", "type": "query_response" } } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl commandcurl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.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/product-analytics/users/event_filtered_query" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "type": "query_event_filtered_users_request" } } EOF ##### ```python """ Query event filtered users returns "Successful response with filtered user data" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_audience_management_api import RumAudienceManagementApi from datadog_api_client.v2.model.query_event_filtered_users_request import QueryEventFilteredUsersRequest from datadog_api_client.v2.model.query_event_filtered_users_request_data import QueryEventFilteredUsersRequestData from datadog_api_client.v2.model.query_event_filtered_users_request_data_attributes import ( QueryEventFilteredUsersRequestDataAttributes, ) from datadog_api_client.v2.model.query_event_filtered_users_request_data_attributes_event_query import ( QueryEventFilteredUsersRequestDataAttributesEventQuery, ) from datadog_api_client.v2.model.query_event_filtered_users_request_data_attributes_event_query_time_frame import ( QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame, ) from datadog_api_client.v2.model.query_event_filtered_users_request_data_type import ( QueryEventFilteredUsersRequestDataType, ) body = QueryEventFilteredUsersRequest( data=QueryEventFilteredUsersRequestData( attributes=QueryEventFilteredUsersRequestDataAttributes( event_query=QueryEventFilteredUsersRequestDataAttributesEventQuery( query="@type:view AND @view.loading_time:>3000 AND @application.name:ecommerce-platform", time_frame=QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame( end=1761309676, start=1760100076, ), ), include_row_count=True, limit=25, query="user_org_id:5001 AND first_country_code:US AND first_browser_name:Chrome", select_columns=[ "user_id", "user_email", "first_country_code", "first_browser_name", "events_count", "session_count", "error_count", "avg_loading_time", ], ), id="query_event_filtered_users_request", type=QueryEventFilteredUsersRequestDataType.QUERY_EVENT_FILTERED_USERS_REQUEST, ), ) configuration = Configuration() configuration.unstable_operations["query_event_filtered_users"] = True with ApiClient(configuration) as api_client: api_instance = RumAudienceManagementApi(api_client) response = api_instance.query_event_filtered_users(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Query event filtered users returns "Successful response with filtered user data" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.query_event_filtered_users".to_sym] = true end api_instance = DatadogAPIClient::V2::RumAudienceManagementAPI.new body = DatadogAPIClient::V2::QueryEventFilteredUsersRequest.new({ data: DatadogAPIClient::V2::QueryEventFilteredUsersRequestData.new({ attributes: DatadogAPIClient::V2::QueryEventFilteredUsersRequestDataAttributes.new({ event_query: DatadogAPIClient::V2::QueryEventFilteredUsersRequestDataAttributesEventQuery.new({ query: "@type:view AND @view.loading_time:>3000 AND @application.name:ecommerce-platform", time_frame: DatadogAPIClient::V2::QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame.new({ _end: 1761309676, start: 1760100076, }), }), include_row_count: true, limit: 25, query: "user_org_id:5001 AND first_country_code:US AND first_browser_name:Chrome", select_columns: [ "user_id", "user_email", "first_country_code", "first_browser_name", "events_count", "session_count", "error_count", "avg_loading_time", ], }), id: "query_event_filtered_users_request", type: DatadogAPIClient::V2::QueryEventFilteredUsersRequestDataType::QUERY_EVENT_FILTERED_USERS_REQUEST, }), }) p api_instance.query_event_filtered_users(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Query event filtered users returns "Successful response with filtered user data" 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.QueryEventFilteredUsersRequest{ Data: &datadogV2.QueryEventFilteredUsersRequestData{ Attributes: &datadogV2.QueryEventFilteredUsersRequestDataAttributes{ EventQuery: &datadogV2.QueryEventFilteredUsersRequestDataAttributesEventQuery{ Query: datadog.PtrString("@type:view AND @view.loading_time:>3000 AND @application.name:ecommerce-platform"), TimeFrame: &datadogV2.QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame{ End: datadog.PtrInt64(1761309676), Start: datadog.PtrInt64(1760100076), }, }, IncludeRowCount: datadog.PtrBool(true), Limit: datadog.PtrInt64(25), Query: datadog.PtrString("user_org_id:5001 AND first_country_code:US AND first_browser_name:Chrome"), SelectColumns: []string{ "user_id", "user_email", "first_country_code", "first_browser_name", "events_count", "session_count", "error_count", "avg_loading_time", }, }, Id: datadog.PtrString("query_event_filtered_users_request"), Type: datadogV2.QUERYEVENTFILTEREDUSERSREQUESTDATATYPE_QUERY_EVENT_FILTERED_USERS_REQUEST, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.QueryEventFilteredUsers", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRumAudienceManagementApi(apiClient) resp, r, err := api.QueryEventFilteredUsers(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RumAudienceManagementApi.QueryEventFilteredUsers`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `RumAudienceManagementApi.QueryEventFilteredUsers`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Query event filtered users returns "Successful response with filtered user data" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumAudienceManagementApi; import com.datadog.api.client.v2.model.QueryEventFilteredUsersRequest; import com.datadog.api.client.v2.model.QueryEventFilteredUsersRequestData; import com.datadog.api.client.v2.model.QueryEventFilteredUsersRequestDataAttributes; import com.datadog.api.client.v2.model.QueryEventFilteredUsersRequestDataAttributesEventQuery; import com.datadog.api.client.v2.model.QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame; import com.datadog.api.client.v2.model.QueryEventFilteredUsersRequestDataType; import com.datadog.api.client.v2.model.QueryResponse; import java.util.Arrays; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.queryEventFilteredUsers", true); RumAudienceManagementApi apiInstance = new RumAudienceManagementApi(defaultClient); QueryEventFilteredUsersRequest body = new QueryEventFilteredUsersRequest() .data( new QueryEventFilteredUsersRequestData() .attributes( new QueryEventFilteredUsersRequestDataAttributes() .eventQuery( new QueryEventFilteredUsersRequestDataAttributesEventQuery() .query( "@type:view AND @view.loading_time:>3000 AND" + " @application.name:ecommerce-platform") .timeFrame( new QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame() .end(1761309676L) .start(1760100076L))) .includeRowCount(true) .limit(25L) .query( "user_org_id:5001 AND first_country_code:US AND" + " first_browser_name:Chrome") .selectColumns( Arrays.asList( "user_id", "user_email", "first_country_code", "first_browser_name", "events_count", "session_count", "error_count", "avg_loading_time"))) .id("query_event_filtered_users_request") .type( QueryEventFilteredUsersRequestDataType.QUERY_EVENT_FILTERED_USERS_REQUEST)); try { QueryResponse result = apiInstance.queryEventFilteredUsers(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RumAudienceManagementApi#queryEventFilteredUsers"); 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](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Query event filtered users returns "Successful response with filtered user // data" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum_audience_management::RumAudienceManagementAPI; use datadog_api_client::datadogV2::model::QueryEventFilteredUsersRequest; use datadog_api_client::datadogV2::model::QueryEventFilteredUsersRequestData; use datadog_api_client::datadogV2::model::QueryEventFilteredUsersRequestDataAttributes; use datadog_api_client::datadogV2::model::QueryEventFilteredUsersRequestDataAttributesEventQuery; use datadog_api_client::datadogV2::model::QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame; use datadog_api_client::datadogV2::model::QueryEventFilteredUsersRequestDataType; #[tokio::main] async fn main() { let body = QueryEventFilteredUsersRequest ::new().data( QueryEventFilteredUsersRequestData::new( QueryEventFilteredUsersRequestDataType::QUERY_EVENT_FILTERED_USERS_REQUEST, ) .attributes( QueryEventFilteredUsersRequestDataAttributes::new() .event_query( QueryEventFilteredUsersRequestDataAttributesEventQuery::new() .query( "@type:view AND @view.loading_time:>3000 AND @application.name:ecommerce-platform".to_string(), ) .time_frame( QueryEventFilteredUsersRequestDataAttributesEventQueryTimeFrame::new() .end(1761309676) .start(1760100076), ), ) .include_row_count(true) .limit(25) .query("user_org_id:5001 AND first_country_code:US AND first_browser_name:Chrome".to_string()) .select_columns( vec![ "user_id".to_string(), "user_email".to_string(), "first_country_code".to_string(), "first_browser_name".to_string(), "events_count".to_string(), "session_count".to_string(), "error_count".to_string(), "avg_loading_time".to_string() ], ), ) .id("query_event_filtered_users_request".to_string()), ); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.QueryEventFilteredUsers", true); let api = RumAudienceManagementAPI::with_config(configuration); let resp = api.query_event_filtered_users(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) 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.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Query event filtered users returns "Successful response with filtered user data" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.queryEventFilteredUsers"] = true; const apiInstance = new v2.RumAudienceManagementApi(configuration); const params: v2.RumAudienceManagementApiQueryEventFilteredUsersRequest = { body: { data: { attributes: { eventQuery: { query: "@type:view AND @view.loading_time:>3000 AND @application.name:ecommerce-platform", timeFrame: { end: 1761309676, start: 1760100076, }, }, includeRowCount: true, limit: 25, query: "user_org_id:5001 AND first_country_code:US AND first_browser_name:Chrome", selectColumns: [ "user_id", "user_email", "first_country_code", "first_browser_name", "events_count", "session_count", "error_count", "avg_loading_time", ], }, id: "query_event_filtered_users_request", type: "query_event_filtered_users_request", }, }, }; apiInstance .queryEventFilteredUsers(params) .then((data: v2.QueryResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Get account facet info{% #get-account-facet-info %} {% tab title="v2" %} **Note**: This endpoint may be subject to changes. | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/product-analytics/accounts/facet_info | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/product-analytics/accounts/facet_info | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/product-analytics/accounts/facet_info | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/product-analytics/accounts/facet_info | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/product-analytics/accounts/facet_info | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/product-analytics/accounts/facet_info | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/product-analytics/accounts/facet_info | ### Overview Get facet information for account attributes including possible values and counts ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | -------------------------- | ------ | ----------------------------------------------------------------------------------------------------- | | | data | object | The data object containing the resource type and attributes for the facet info request. | | data | attributes | object | Attributes for the facet info request, specifying which facet to query and optional filters to apply. | | attributes | facet_id [*required*] | string | The identifier of the facet attribute to retrieve value information for. | | attributes | limit [*required*] | int64 | Maximum number of facet values to return in the response. | | attributes | search | object | Query-based search configuration for filtering the audience context when retrieving facet values. | | search | query | string | The filter expression used to scope the audience from which facet values are retrieved. | | attributes | term_search | object | Term-level search configuration for filtering facet values by an exact or partial term match. | | term_search | value | string | The term string to match against facet values. | | data | id | string | Unique identifier for the facet info request resource. | | data | type [*required*] | enum | Users facet info request resource type. Allowed enum values: `users_facet_info_request` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "facet_id": "", "limit": 0, "search": { "query": "string" }, "term_search": { "value": "string" } }, "id": "string", "type": "users_facet_info_request" } } ``` {% /tab %} ### Response {% tab title="200" %} Successful response with facet information {% tab title="Model" %} Response containing facet information for an attribute, including its distinct values and occurrence counts. | Parent field | Field | Type | Description | | ------------ | ---------------------- | -------- | --------------------------------------------------------------------------------------------------- | | | data | object | The data object containing the resource type and attributes for the facet info response. | | data | attributes | object | Attributes of the facet info response, containing the facet result data. | | attributes | result | object | The facet query result containing discrete value counts or a numeric range for the requested facet. | | result | range | object | The numeric range of a facet attribute, representing the minimum and maximum observed values. | | range | max | object | The maximum observed value for the numeric facet attribute. | | range | min | object | The minimum observed value for the numeric facet attribute. | | result | values | [object] | List of discrete facet values with their occurrence counts. | | values | count | int64 | The number of records that have this facet value. | | values | value | string | The facet value (for example, a browser name or country code). | | data | id | string | Unique identifier for the facet info response resource. | | data | type [*required*] | enum | Users facet info resource type. Allowed enum values: `users_facet_info` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "result": { "values": [ { "count": 4892, "value": "Chrome" }, { "count": 2341, "value": "Safari" }, { "count": 1567, "value": "Firefox" }, { "count": 892, "value": "Edge" }, { "count": 234, "value": "Opera" } ] } }, "id": "facet_info_response", "type": "users_facet_info" } } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl commandcurl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.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/product-analytics/accounts/facet_info" \ -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": { "facet_id": "", "limit": 0 }, "type": "users_facet_info_request" } } EOF ##### ```python """ Get account facet info returns "Successful response with facet information" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_audience_management_api import RumAudienceManagementApi from datadog_api_client.v2.model.facet_info_request import FacetInfoRequest from datadog_api_client.v2.model.facet_info_request_data import FacetInfoRequestData from datadog_api_client.v2.model.facet_info_request_data_attributes import FacetInfoRequestDataAttributes from datadog_api_client.v2.model.facet_info_request_data_attributes_search import FacetInfoRequestDataAttributesSearch from datadog_api_client.v2.model.facet_info_request_data_attributes_term_search import ( FacetInfoRequestDataAttributesTermSearch, ) from datadog_api_client.v2.model.facet_info_request_data_type import FacetInfoRequestDataType body = FacetInfoRequest( data=FacetInfoRequestData( attributes=FacetInfoRequestDataAttributes( facet_id="first_browser_name", limit=10, search=FacetInfoRequestDataAttributesSearch( query="user_org_id:5001 AND first_country_code:US", ), term_search=FacetInfoRequestDataAttributesTermSearch( value="Chrome", ), ), id="facet_info_request", type=FacetInfoRequestDataType.USERS_FACET_INFO_REQUEST, ), ) configuration = Configuration() configuration.unstable_operations["get_account_facet_info"] = True with ApiClient(configuration) as api_client: api_instance = RumAudienceManagementApi(api_client) response = api_instance.get_account_facet_info(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get account facet info returns "Successful response with facet information" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.get_account_facet_info".to_sym] = true end api_instance = DatadogAPIClient::V2::RumAudienceManagementAPI.new body = DatadogAPIClient::V2::FacetInfoRequest.new({ data: DatadogAPIClient::V2::FacetInfoRequestData.new({ attributes: DatadogAPIClient::V2::FacetInfoRequestDataAttributes.new({ facet_id: "first_browser_name", limit: 10, search: DatadogAPIClient::V2::FacetInfoRequestDataAttributesSearch.new({ query: "user_org_id:5001 AND first_country_code:US", }), term_search: DatadogAPIClient::V2::FacetInfoRequestDataAttributesTermSearch.new({ value: "Chrome", }), }), id: "facet_info_request", type: DatadogAPIClient::V2::FacetInfoRequestDataType::USERS_FACET_INFO_REQUEST, }), }) p api_instance.get_account_facet_info(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get account facet info returns "Successful response with facet information" 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.FacetInfoRequest{ Data: &datadogV2.FacetInfoRequestData{ Attributes: &datadogV2.FacetInfoRequestDataAttributes{ FacetId: "first_browser_name", Limit: 10, Search: &datadogV2.FacetInfoRequestDataAttributesSearch{ Query: datadog.PtrString("user_org_id:5001 AND first_country_code:US"), }, TermSearch: &datadogV2.FacetInfoRequestDataAttributesTermSearch{ Value: datadog.PtrString("Chrome"), }, }, Id: datadog.PtrString("facet_info_request"), Type: datadogV2.FACETINFOREQUESTDATATYPE_USERS_FACET_INFO_REQUEST, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.GetAccountFacetInfo", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRumAudienceManagementApi(apiClient) resp, r, err := api.GetAccountFacetInfo(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RumAudienceManagementApi.GetAccountFacetInfo`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `RumAudienceManagementApi.GetAccountFacetInfo`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get account facet info returns "Successful response with facet information" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumAudienceManagementApi; import com.datadog.api.client.v2.model.FacetInfoRequest; import com.datadog.api.client.v2.model.FacetInfoRequestData; import com.datadog.api.client.v2.model.FacetInfoRequestDataAttributes; import com.datadog.api.client.v2.model.FacetInfoRequestDataAttributesSearch; import com.datadog.api.client.v2.model.FacetInfoRequestDataAttributesTermSearch; import com.datadog.api.client.v2.model.FacetInfoRequestDataType; import com.datadog.api.client.v2.model.FacetInfoResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.getAccountFacetInfo", true); RumAudienceManagementApi apiInstance = new RumAudienceManagementApi(defaultClient); FacetInfoRequest body = new FacetInfoRequest() .data( new FacetInfoRequestData() .attributes( new FacetInfoRequestDataAttributes() .facetId("first_browser_name") .limit(10L) .search( new FacetInfoRequestDataAttributesSearch() .query("user_org_id:5001 AND first_country_code:US")) .termSearch( new FacetInfoRequestDataAttributesTermSearch().value("Chrome"))) .id("facet_info_request") .type(FacetInfoRequestDataType.USERS_FACET_INFO_REQUEST)); try { FacetInfoResponse result = apiInstance.getAccountFacetInfo(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RumAudienceManagementApi#getAccountFacetInfo"); 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](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get account facet info returns "Successful response with facet information" // response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum_audience_management::RumAudienceManagementAPI; use datadog_api_client::datadogV2::model::FacetInfoRequest; use datadog_api_client::datadogV2::model::FacetInfoRequestData; use datadog_api_client::datadogV2::model::FacetInfoRequestDataAttributes; use datadog_api_client::datadogV2::model::FacetInfoRequestDataAttributesSearch; use datadog_api_client::datadogV2::model::FacetInfoRequestDataAttributesTermSearch; use datadog_api_client::datadogV2::model::FacetInfoRequestDataType; #[tokio::main] async fn main() { let body = FacetInfoRequest::new().data( FacetInfoRequestData::new(FacetInfoRequestDataType::USERS_FACET_INFO_REQUEST) .attributes( FacetInfoRequestDataAttributes::new("first_browser_name".to_string(), 10) .search( FacetInfoRequestDataAttributesSearch::new() .query("user_org_id:5001 AND first_country_code:US".to_string()), ) .term_search( FacetInfoRequestDataAttributesTermSearch::new().value("Chrome".to_string()), ), ) .id("facet_info_request".to_string()), ); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.GetAccountFacetInfo", true); let api = RumAudienceManagementAPI::with_config(configuration); let resp = api.get_account_facet_info(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) 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.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get account facet info returns "Successful response with facet information" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.getAccountFacetInfo"] = true; const apiInstance = new v2.RumAudienceManagementApi(configuration); const params: v2.RumAudienceManagementApiGetAccountFacetInfoRequest = { body: { data: { attributes: { facetId: "first_browser_name", limit: 10, search: { query: "user_org_id:5001 AND first_country_code:US", }, termSearch: { value: "Chrome", }, }, id: "facet_info_request", type: "users_facet_info_request", }, }, }; apiInstance .getAccountFacetInfo(params) .then((data: v2.FacetInfoResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Delete connection{% #delete-connection %} {% tab title="v2" %} **Note**: This endpoint may be subject to changes. | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------------------------------------- | | ap1.datadoghq.com | DELETE https://api.ap1.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection/{id} | | ap2.datadoghq.com | DELETE https://api.ap2.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection/{id} | | app.datadoghq.eu | DELETE https://api.datadoghq.eu/api/v2/product-analytics/{entity}/mapping/connection/{id} | | app.ddog-gov.com | DELETE https://api.ddog-gov.com/api/v2/product-analytics/{entity}/mapping/connection/{id} | | app.datadoghq.com | DELETE https://api.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection/{id} | | us3.datadoghq.com | DELETE https://api.us3.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection/{id} | | us5.datadoghq.com | DELETE https://api.us5.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection/{id} | ### Overview Delete an existing data connection for an entity ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------ | ------ | --------------------------------------------- | | id [*required*] | string | The connection ID to delete | | entity [*required*] | string | The entity for which to delete the connection | ### Response {% tab title="204" %} Connection deleted successfully {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parametersexport id="connection-id-123"export entity="users"\# Curl commandcurl -X DELETE "https://api.ap1.datadoghq.com"https://api.ap2.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/product-analytics/${entity}/mapping/connection/${id}" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Delete connection returns "Connection deleted successfully" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_audience_management_api import RumAudienceManagementApi configuration = Configuration() configuration.unstable_operations["delete_connection"] = True with ApiClient(configuration) as api_client: api_instance = RumAudienceManagementApi(api_client) api_instance.delete_connection( id="connection-id-123", entity="users", ) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Delete connection returns "Connection deleted successfully" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.delete_connection".to_sym] = true end api_instance = DatadogAPIClient::V2::RumAudienceManagementAPI.new api_instance.delete_connection("connection-id-123", "users") ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Delete connection returns "Connection deleted successfully" 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() { ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.DeleteConnection", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRumAudienceManagementApi(apiClient) r, err := api.DeleteConnection(ctx, "connection-id-123", "users") if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RumAudienceManagementApi.DeleteConnection`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Delete connection returns "Connection deleted successfully" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumAudienceManagementApi; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.deleteConnection", true); RumAudienceManagementApi apiInstance = new RumAudienceManagementApi(defaultClient); try { apiInstance.deleteConnection("connection-id-123", "users"); } catch (ApiException e) { System.err.println("Exception when calling RumAudienceManagementApi#deleteConnection"); 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](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Delete connection returns "Connection deleted successfully" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum_audience_management::RumAudienceManagementAPI; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.DeleteConnection", true); let api = RumAudienceManagementAPI::with_config(configuration); let resp = api .delete_connection("connection-id-123".to_string(), "users".to_string()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) 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.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Delete connection returns "Connection deleted successfully" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.deleteConnection"] = true; const apiInstance = new v2.RumAudienceManagementApi(configuration); const params: v2.RumAudienceManagementApiDeleteConnectionRequest = { id: "connection-id-123", entity: "users", }; apiInstance .deleteConnection(params) .then((data: any) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## List connections{% #list-connections %} {% tab title="v2" %} **Note**: This endpoint may be subject to changes. | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connections | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connections | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/product-analytics/{entity}/mapping/connections | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/product-analytics/{entity}/mapping/connections | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connections | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connections | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connections | ### Overview List all data connections for an entity ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------ | ------ | ---------------------------------------- | | entity [*required*] | string | The entity for which to list connections | ### Response {% tab title="200" %} Successful response with list of connections {% tab title="Model" %} Response containing the list of all data source connections configured for an entity. | Parent field | Field | Type | Description | | -------------------- | ----------------------------- | --------- | -------------------------------------------------------------------------------------------------- | | | data | object | The data object containing the resource type and attributes for the list connections response. | | data | attributes | object | Attributes of the list connections response, containing the collection of data source connections. | | attributes | connections | [object] | The list of data source connections configured for the entity. | | connections | created_at | date-time | Timestamp indicating when the connection was created. | | connections | created_by | string | Identifier of the user who created the connection. | | connections | fields | [object] | List of custom attribute fields imported from the data source. | | fields | description | string | Human-readable explanation of what the field represents. | | fields | display_name | string | The human-readable label for the field shown in the UI. | | fields | groups | [string] | List of group labels used to categorize the field. | | fields | id [*required*] | string | The unique identifier for the field within the connection. | | fields | source_name [*required*] | string | The name of the column or attribute in the source data system that maps to this field. | | fields | type [*required*] | string | The data type of the field (for example, string or number). | | connections | id | string | Unique identifier of the connection. | | connections | join | object | The join configuration describing how the data source is linked to the entity. | | join | attribute | string | The entity attribute used as the join key to link records from the data source. | | join | type | string | The type of join key used (for example, email or user_id). | | connections | metadata | object | Additional key-value metadata associated with the connection. | | additionalProperties | | string | | connections | type | string | The type of data source connection (for example, ref_table). | | connections | updated_at | date-time | Timestamp indicating when the connection was last updated. | | connections | updated_by | string | Identifier of the user who last updated the connection. | | data | id | string | Unique identifier for the list connections response resource. | | data | type [*required*] | enum | List connections response resource type. Allowed enum values: `list_connections_response` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "connections": [ { "created_at": "0001-01-01T00:00:00Z", "created_by": "00000000-0000-0000-0000-000000000000", "fields": [ { "description": "Customer subscription tier", "display_name": "Customer Tier", "groups": [ "Business", "Subscription" ], "id": "customer_tier", "source_name": "subscription_tier", "type": "string" }, { "description": "Channel through which user signed up", "display_name": "Signup Source", "groups": [ "Marketing", "Attribution" ], "id": "signup_source", "source_name": "acquisition_channel", "type": "string" } ], "id": "user-profiles-connection", "join": { "attribute": "user_email", "type": "email" }, "type": "ref_table", "updated_at": "0001-01-01T00:00:00Z", "updated_by": "00000000-0000-0000-0000-000000000000" } ] }, "id": "list_connections_response", "type": "list_connections_response" } } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parametersexport entity="users"\# Curl commandcurl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.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/product-analytics/${entity}/mapping/connections" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ List connections returns "Successful response with list of connections" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_audience_management_api import RumAudienceManagementApi configuration = Configuration() configuration.unstable_operations["list_connections"] = True with ApiClient(configuration) as api_client: api_instance = RumAudienceManagementApi(api_client) response = api_instance.list_connections( entity="users", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # List connections returns "Successful response with list of connections" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.list_connections".to_sym] = true end api_instance = DatadogAPIClient::V2::RumAudienceManagementAPI.new p api_instance.list_connections("users") ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // List connections returns "Successful response with list of connections" 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.ListConnections", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRumAudienceManagementApi(apiClient) resp, r, err := api.ListConnections(ctx, "users") if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RumAudienceManagementApi.ListConnections`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `RumAudienceManagementApi.ListConnections`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // List connections returns "Successful response with list of connections" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumAudienceManagementApi; import com.datadog.api.client.v2.model.ListConnectionsResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.listConnections", true); RumAudienceManagementApi apiInstance = new RumAudienceManagementApi(defaultClient); try { ListConnectionsResponse result = apiInstance.listConnections("users"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RumAudienceManagementApi#listConnections"); 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](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // List connections returns "Successful response with list of connections" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum_audience_management::RumAudienceManagementAPI; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.ListConnections", true); let api = RumAudienceManagementAPI::with_config(configuration); let resp = api.list_connections("users".to_string()).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) 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.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * List connections returns "Successful response with list of connections" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.listConnections"] = true; const apiInstance = new v2.RumAudienceManagementApi(configuration); const params: v2.RumAudienceManagementApiListConnectionsRequest = { entity: "users", }; apiInstance .listConnections(params) .then((data: v2.ListConnectionsResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Query users{% #query-users %} {% tab title="v2" %} **Note**: This endpoint may be subject to changes. | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/product-analytics/users/query | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/product-analytics/users/query | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/product-analytics/users/query | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/product-analytics/users/query | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/product-analytics/users/query | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/product-analytics/users/query | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/product-analytics/users/query | ### Overview Query users with flexible filtering by user properties, with optional wildcard search ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | ---------------------- | -------- | ----------------------------------------------------------------------------------------- | | | data | object | The data object containing the resource type and attributes for querying users. | | data | attributes | object | Attributes for filtering and shaping the user query results. | | attributes | limit | int64 | Maximum number of user records to return in the response. | | attributes | query | string | Filter expression using user attribute conditions to narrow results. | | attributes | select_columns | [string] | List of user attribute column names to include in the response. | | attributes | sort | object | Sorting configuration specifying the field and direction for ordering user query results. | | sort | field | string | The user attribute field name to sort results by. | | sort | order | string | The sort direction, either ascending or descending. | | attributes | wildcard_search_term | string | Free-text term used for wildcard search across user attribute values. | | data | id | string | Unique identifier for the query users request resource. | | data | type [*required*] | enum | Query users request resource type. Allowed enum values: `query_users_request` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "limit": "integer", "query": "string", "select_columns": [], "sort": { "field": "string", "order": "string" }, "wildcard_search_term": "string" }, "id": "string", "type": "query_users_request" } } ``` {% /tab %} ### Response {% tab title="200" %} Successful response with user data {% tab title="Model" %} Response containing the query results with matched records and total count. | Parent field | Field | Type | Description | | ------------ | ---------------------- | ------ | ----------------------------------------------------------------------------------------------- | | | data | object | The data object containing the resource type and attributes of the query response. | | data | attributes | object | Attributes of the query response, containing the matched records and total count. | | attributes | hits | [] | The list of matching records returned by the query, each as a map of attribute names to values. | | attributes | total | int64 | Total number of records matching the query, regardless of the limit applied. | | data | id | string | Unique identifier for the query response resource. | | data | type [*required*] | enum | Query response resource type. Allowed enum values: `query_response` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "hits": [ { "first_browser_name": "Chrome", "first_city": "San Francisco", "first_country_code": "US", "first_device_type": "Desktop", "last_seen": "2025-08-14T06:45:12.142Z", "session_count": 47, "user_created": "2024-12-15T08:42:33.287Z", "user_email": "john.smith@techcorp.com", "user_id": "150847", "user_name": "John Smith", "user_org_id": "5001" }, { "first_browser_name": "Chrome", "first_city": "Austin", "first_country_code": "US", "first_device_type": "Desktop", "last_seen": "2025-08-14T05:22:08.951Z", "session_count": 89, "user_created": "2024-11-28T14:17:45.634Z", "user_email": "john.williams@techcorp.com", "user_id": "150848", "user_name": "John Williams", "user_org_id": "5001" }, { "first_browser_name": "Chrome", "first_city": "Seattle", "first_country_code": "US", "first_device_type": "Desktop", "last_seen": "2025-08-14T04:18:34.726Z", "session_count": 23, "user_created": "2025-01-03T16:33:21.445Z", "user_email": "john.jones@techcorp.com", "user_id": "150849", "user_name": "John Jones", "user_org_id": "5001" } ], "total": 147 }, "id": "query_response", "type": "query_response" } } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl commandcurl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.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/product-analytics/users/query" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" \ -d @- << EOF { "data": { "type": "query_users_request" } } EOF ##### ```python """ Query users returns "Successful response with user data" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_audience_management_api import RumAudienceManagementApi from datadog_api_client.v2.model.query_users_request import QueryUsersRequest from datadog_api_client.v2.model.query_users_request_data import QueryUsersRequestData from datadog_api_client.v2.model.query_users_request_data_attributes import QueryUsersRequestDataAttributes from datadog_api_client.v2.model.query_users_request_data_attributes_sort import QueryUsersRequestDataAttributesSort from datadog_api_client.v2.model.query_users_request_data_type import QueryUsersRequestDataType body = QueryUsersRequest( data=QueryUsersRequestData( attributes=QueryUsersRequestDataAttributes( limit=25, query="user_email:*@techcorp.com AND first_country_code:US AND first_browser_name:Chrome", select_columns=[ "user_id", "user_email", "user_name", "user_org_id", "first_country_code", "first_browser_name", "first_device_type", "last_seen", ], sort=QueryUsersRequestDataAttributesSort( field="first_seen", order="DESC", ), wildcard_search_term="john", ), id="query_users_request", type=QueryUsersRequestDataType.QUERY_USERS_REQUEST, ), ) configuration = Configuration() configuration.unstable_operations["query_users"] = True with ApiClient(configuration) as api_client: api_instance = RumAudienceManagementApi(api_client) response = api_instance.query_users(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Query users returns "Successful response with user data" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.query_users".to_sym] = true end api_instance = DatadogAPIClient::V2::RumAudienceManagementAPI.new body = DatadogAPIClient::V2::QueryUsersRequest.new({ data: DatadogAPIClient::V2::QueryUsersRequestData.new({ attributes: DatadogAPIClient::V2::QueryUsersRequestDataAttributes.new({ limit: 25, query: "user_email:*@techcorp.com AND first_country_code:US AND first_browser_name:Chrome", select_columns: [ "user_id", "user_email", "user_name", "user_org_id", "first_country_code", "first_browser_name", "first_device_type", "last_seen", ], sort: DatadogAPIClient::V2::QueryUsersRequestDataAttributesSort.new({ field: "first_seen", order: "DESC", }), wildcard_search_term: "john", }), id: "query_users_request", type: DatadogAPIClient::V2::QueryUsersRequestDataType::QUERY_USERS_REQUEST, }), }) p api_instance.query_users(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Query users returns "Successful response with user data" 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.QueryUsersRequest{ Data: &datadogV2.QueryUsersRequestData{ Attributes: &datadogV2.QueryUsersRequestDataAttributes{ Limit: datadog.PtrInt64(25), Query: datadog.PtrString("user_email:*@techcorp.com AND first_country_code:US AND first_browser_name:Chrome"), SelectColumns: []string{ "user_id", "user_email", "user_name", "user_org_id", "first_country_code", "first_browser_name", "first_device_type", "last_seen", }, Sort: &datadogV2.QueryUsersRequestDataAttributesSort{ Field: datadog.PtrString("first_seen"), Order: datadog.PtrString("DESC"), }, WildcardSearchTerm: datadog.PtrString("john"), }, Id: datadog.PtrString("query_users_request"), Type: datadogV2.QUERYUSERSREQUESTDATATYPE_QUERY_USERS_REQUEST, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.QueryUsers", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRumAudienceManagementApi(apiClient) resp, r, err := api.QueryUsers(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RumAudienceManagementApi.QueryUsers`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `RumAudienceManagementApi.QueryUsers`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Query users returns "Successful response with user data" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumAudienceManagementApi; import com.datadog.api.client.v2.model.QueryResponse; import com.datadog.api.client.v2.model.QueryUsersRequest; import com.datadog.api.client.v2.model.QueryUsersRequestData; import com.datadog.api.client.v2.model.QueryUsersRequestDataAttributes; import com.datadog.api.client.v2.model.QueryUsersRequestDataAttributesSort; import com.datadog.api.client.v2.model.QueryUsersRequestDataType; import java.util.Arrays; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.queryUsers", true); RumAudienceManagementApi apiInstance = new RumAudienceManagementApi(defaultClient); QueryUsersRequest body = new QueryUsersRequest() .data( new QueryUsersRequestData() .attributes( new QueryUsersRequestDataAttributes() .limit(25L) .query( "user_email:*@techcorp.com AND first_country_code:US AND" + " first_browser_name:Chrome") .selectColumns( Arrays.asList( "user_id", "user_email", "user_name", "user_org_id", "first_country_code", "first_browser_name", "first_device_type", "last_seen")) .sort( new QueryUsersRequestDataAttributesSort() .field("first_seen") .order("DESC")) .wildcardSearchTerm("john")) .id("query_users_request") .type(QueryUsersRequestDataType.QUERY_USERS_REQUEST)); try { QueryResponse result = apiInstance.queryUsers(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RumAudienceManagementApi#queryUsers"); 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](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Query users returns "Successful response with user data" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum_audience_management::RumAudienceManagementAPI; use datadog_api_client::datadogV2::model::QueryUsersRequest; use datadog_api_client::datadogV2::model::QueryUsersRequestData; use datadog_api_client::datadogV2::model::QueryUsersRequestDataAttributes; use datadog_api_client::datadogV2::model::QueryUsersRequestDataAttributesSort; use datadog_api_client::datadogV2::model::QueryUsersRequestDataType; #[tokio::main] async fn main() { let body = QueryUsersRequest ::new().data( QueryUsersRequestData::new(QueryUsersRequestDataType::QUERY_USERS_REQUEST) .attributes( QueryUsersRequestDataAttributes::new() .limit(25) .query( "user_email:*@techcorp.com AND first_country_code:US AND first_browser_name:Chrome".to_string(), ) .select_columns( vec![ "user_id".to_string(), "user_email".to_string(), "user_name".to_string(), "user_org_id".to_string(), "first_country_code".to_string(), "first_browser_name".to_string(), "first_device_type".to_string(), "last_seen".to_string() ], ) .sort( QueryUsersRequestDataAttributesSort::new() .field("first_seen".to_string()) .order("DESC".to_string()), ) .wildcard_search_term("john".to_string()), ) .id("query_users_request".to_string()), ); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.QueryUsers", true); let api = RumAudienceManagementAPI::with_config(configuration); let resp = api.query_users(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) 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.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Query users returns "Successful response with user data" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.queryUsers"] = true; const apiInstance = new v2.RumAudienceManagementApi(configuration); const params: v2.RumAudienceManagementApiQueryUsersRequest = { body: { data: { attributes: { limit: 25, query: "user_email:*@techcorp.com AND first_country_code:US AND first_browser_name:Chrome", selectColumns: [ "user_id", "user_email", "user_name", "user_org_id", "first_country_code", "first_browser_name", "first_device_type", "last_seen", ], sort: { field: "first_seen", order: "DESC", }, wildcardSearchTerm: "john", }, id: "query_users_request", type: "query_users_request", }, }, }; apiInstance .queryUsers(params) .then((data: v2.QueryResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Get user facet info{% #get-user-facet-info %} {% tab title="v2" %} **Note**: This endpoint may be subject to changes. | Datadog site | API endpoint | | ----------------- | ---------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/product-analytics/users/facet_info | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/product-analytics/users/facet_info | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/product-analytics/users/facet_info | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/product-analytics/users/facet_info | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/product-analytics/users/facet_info | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/product-analytics/users/facet_info | | us5.datadoghq.com | POST https://api.us5.datadoghq.com/api/v2/product-analytics/users/facet_info | ### Overview Get facet information for user attributes including possible values and counts ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------ | -------------------------- | ------ | ----------------------------------------------------------------------------------------------------- | | | data | object | The data object containing the resource type and attributes for the facet info request. | | data | attributes | object | Attributes for the facet info request, specifying which facet to query and optional filters to apply. | | attributes | facet_id [*required*] | string | The identifier of the facet attribute to retrieve value information for. | | attributes | limit [*required*] | int64 | Maximum number of facet values to return in the response. | | attributes | search | object | Query-based search configuration for filtering the audience context when retrieving facet values. | | search | query | string | The filter expression used to scope the audience from which facet values are retrieved. | | attributes | term_search | object | Term-level search configuration for filtering facet values by an exact or partial term match. | | term_search | value | string | The term string to match against facet values. | | data | id | string | Unique identifier for the facet info request resource. | | data | type [*required*] | enum | Users facet info request resource type. Allowed enum values: `users_facet_info_request` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "facet_id": "", "limit": 0, "search": { "query": "string" }, "term_search": { "value": "string" } }, "id": "string", "type": "users_facet_info_request" } } ``` {% /tab %} ### Response {% tab title="200" %} Successful response with facet information {% tab title="Model" %} Response containing facet information for an attribute, including its distinct values and occurrence counts. | Parent field | Field | Type | Description | | ------------ | ---------------------- | -------- | --------------------------------------------------------------------------------------------------- | | | data | object | The data object containing the resource type and attributes for the facet info response. | | data | attributes | object | Attributes of the facet info response, containing the facet result data. | | attributes | result | object | The facet query result containing discrete value counts or a numeric range for the requested facet. | | result | range | object | The numeric range of a facet attribute, representing the minimum and maximum observed values. | | range | max | object | The maximum observed value for the numeric facet attribute. | | range | min | object | The minimum observed value for the numeric facet attribute. | | result | values | [object] | List of discrete facet values with their occurrence counts. | | values | count | int64 | The number of records that have this facet value. | | values | value | string | The facet value (for example, a browser name or country code). | | data | id | string | Unique identifier for the facet info response resource. | | data | type [*required*] | enum | Users facet info resource type. Allowed enum values: `users_facet_info` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "result": { "values": [ { "count": 4892, "value": "Chrome" }, { "count": 2341, "value": "Safari" }, { "count": 1567, "value": "Firefox" }, { "count": 892, "value": "Edge" }, { "count": 234, "value": "Opera" } ] } }, "id": "facet_info_response", "type": "users_facet_info" } } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Curl commandcurl -X POST "https://api.ap1.datadoghq.com"https://api.ap2.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/product-analytics/users/facet_info" \ -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": { "facet_id": "", "limit": 0 }, "type": "users_facet_info_request" } } EOF ##### ```python """ Get user facet info returns "Successful response with facet information" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_audience_management_api import RumAudienceManagementApi from datadog_api_client.v2.model.facet_info_request import FacetInfoRequest from datadog_api_client.v2.model.facet_info_request_data import FacetInfoRequestData from datadog_api_client.v2.model.facet_info_request_data_attributes import FacetInfoRequestDataAttributes from datadog_api_client.v2.model.facet_info_request_data_attributes_search import FacetInfoRequestDataAttributesSearch from datadog_api_client.v2.model.facet_info_request_data_attributes_term_search import ( FacetInfoRequestDataAttributesTermSearch, ) from datadog_api_client.v2.model.facet_info_request_data_type import FacetInfoRequestDataType body = FacetInfoRequest( data=FacetInfoRequestData( attributes=FacetInfoRequestDataAttributes( facet_id="first_browser_name", limit=10, search=FacetInfoRequestDataAttributesSearch( query="user_org_id:5001 AND first_country_code:US", ), term_search=FacetInfoRequestDataAttributesTermSearch( value="Chrome", ), ), id="facet_info_request", type=FacetInfoRequestDataType.USERS_FACET_INFO_REQUEST, ), ) configuration = Configuration() configuration.unstable_operations["get_user_facet_info"] = True with ApiClient(configuration) as api_client: api_instance = RumAudienceManagementApi(api_client) response = api_instance.get_user_facet_info(body=body) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get user facet info returns "Successful response with facet information" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.get_user_facet_info".to_sym] = true end api_instance = DatadogAPIClient::V2::RumAudienceManagementAPI.new body = DatadogAPIClient::V2::FacetInfoRequest.new({ data: DatadogAPIClient::V2::FacetInfoRequestData.new({ attributes: DatadogAPIClient::V2::FacetInfoRequestDataAttributes.new({ facet_id: "first_browser_name", limit: 10, search: DatadogAPIClient::V2::FacetInfoRequestDataAttributesSearch.new({ query: "user_org_id:5001 AND first_country_code:US", }), term_search: DatadogAPIClient::V2::FacetInfoRequestDataAttributesTermSearch.new({ value: "Chrome", }), }), id: "facet_info_request", type: DatadogAPIClient::V2::FacetInfoRequestDataType::USERS_FACET_INFO_REQUEST, }), }) p api_instance.get_user_facet_info(body) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get user facet info returns "Successful response with facet information" 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.FacetInfoRequest{ Data: &datadogV2.FacetInfoRequestData{ Attributes: &datadogV2.FacetInfoRequestDataAttributes{ FacetId: "first_browser_name", Limit: 10, Search: &datadogV2.FacetInfoRequestDataAttributesSearch{ Query: datadog.PtrString("user_org_id:5001 AND first_country_code:US"), }, TermSearch: &datadogV2.FacetInfoRequestDataAttributesTermSearch{ Value: datadog.PtrString("Chrome"), }, }, Id: datadog.PtrString("facet_info_request"), Type: datadogV2.FACETINFOREQUESTDATATYPE_USERS_FACET_INFO_REQUEST, }, } ctx := datadog.NewDefaultContext(context.Background()) configuration := datadog.NewConfiguration() configuration.SetUnstableOperationEnabled("v2.GetUserFacetInfo", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRumAudienceManagementApi(apiClient) resp, r, err := api.GetUserFacetInfo(ctx, body) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RumAudienceManagementApi.GetUserFacetInfo`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `RumAudienceManagementApi.GetUserFacetInfo`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get user facet info returns "Successful response with facet information" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumAudienceManagementApi; import com.datadog.api.client.v2.model.FacetInfoRequest; import com.datadog.api.client.v2.model.FacetInfoRequestData; import com.datadog.api.client.v2.model.FacetInfoRequestDataAttributes; import com.datadog.api.client.v2.model.FacetInfoRequestDataAttributesSearch; import com.datadog.api.client.v2.model.FacetInfoRequestDataAttributesTermSearch; import com.datadog.api.client.v2.model.FacetInfoRequestDataType; import com.datadog.api.client.v2.model.FacetInfoResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.getUserFacetInfo", true); RumAudienceManagementApi apiInstance = new RumAudienceManagementApi(defaultClient); FacetInfoRequest body = new FacetInfoRequest() .data( new FacetInfoRequestData() .attributes( new FacetInfoRequestDataAttributes() .facetId("first_browser_name") .limit(10L) .search( new FacetInfoRequestDataAttributesSearch() .query("user_org_id:5001 AND first_country_code:US")) .termSearch( new FacetInfoRequestDataAttributesTermSearch().value("Chrome"))) .id("facet_info_request") .type(FacetInfoRequestDataType.USERS_FACET_INFO_REQUEST)); try { FacetInfoResponse result = apiInstance.getUserFacetInfo(body); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RumAudienceManagementApi#getUserFacetInfo"); 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](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get user facet info returns "Successful response with facet information" // response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum_audience_management::RumAudienceManagementAPI; use datadog_api_client::datadogV2::model::FacetInfoRequest; use datadog_api_client::datadogV2::model::FacetInfoRequestData; use datadog_api_client::datadogV2::model::FacetInfoRequestDataAttributes; use datadog_api_client::datadogV2::model::FacetInfoRequestDataAttributesSearch; use datadog_api_client::datadogV2::model::FacetInfoRequestDataAttributesTermSearch; use datadog_api_client::datadogV2::model::FacetInfoRequestDataType; #[tokio::main] async fn main() { let body = FacetInfoRequest::new().data( FacetInfoRequestData::new(FacetInfoRequestDataType::USERS_FACET_INFO_REQUEST) .attributes( FacetInfoRequestDataAttributes::new("first_browser_name".to_string(), 10) .search( FacetInfoRequestDataAttributesSearch::new() .query("user_org_id:5001 AND first_country_code:US".to_string()), ) .term_search( FacetInfoRequestDataAttributesTermSearch::new().value("Chrome".to_string()), ), ) .id("facet_info_request".to_string()), ); let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.GetUserFacetInfo", true); let api = RumAudienceManagementAPI::with_config(configuration); let resp = api.get_user_facet_info(body).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) 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.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get user facet info returns "Successful response with facet information" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.getUserFacetInfo"] = true; const apiInstance = new v2.RumAudienceManagementApi(configuration); const params: v2.RumAudienceManagementApiGetUserFacetInfoRequest = { body: { data: { attributes: { facetId: "first_browser_name", limit: 10, search: { query: "user_org_id:5001 AND first_country_code:US", }, termSearch: { value: "Chrome", }, }, id: "facet_info_request", type: "users_facet_info_request", }, }, }; apiInstance .getUserFacetInfo(params) .then((data: v2.FacetInfoResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %} ## Get mapping{% #get-mapping %} {% tab title="v2" %} **Note**: This endpoint may be subject to changes. | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------------------------- | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/product-analytics/{entity}/mapping | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/product-analytics/{entity}/mapping | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/product-analytics/{entity}/mapping | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/product-analytics/{entity}/mapping | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/product-analytics/{entity}/mapping | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/product-analytics/{entity}/mapping | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/product-analytics/{entity}/mapping | ### Overview Get entity mapping configuration including all available attributes and their properties ### Arguments #### Path Parameters | Name | Type | Description | | ------------------------ | ------ | --------------------------------------- | | entity [*required*] | string | The entity for which to get the mapping | ### Response {% tab title="200" %} Successful response with entity mapping configuration {% tab title="Model" %} Response containing the entity attribute mapping configuration including all available attributes and their properties. | Parent field | Field | Type | Description | | ------------ | ---------------------- | -------- | -------------------------------------------------------------------------------------------- | | | data | object | The data object containing the resource type and attributes for the get mapping response. | | data | attributes | object | Attributes of the get mapping response, containing the list of configured entity attributes. | | attributes | attributes | [object] | The list of entity attributes and their mapping configurations. | | attributes | attribute | string | The attribute identifier as used in the entity data model. | | attributes | description | string | Human-readable explanation of what the attribute represents. | | attributes | display_name | string | The human-readable label for the attribute shown in the UI. | | attributes | groups | [string] | List of group labels used to categorize the attribute. | | attributes | is_custom | boolean | Whether this attribute is a custom user-defined attribute rather than a built-in one. | | attributes | type | string | The data type of the attribute (for example, string or number). | | data | id | string | Unique identifier for the get mapping response resource. | | data | type [*required*] | enum | Get mappings response resource type. Allowed enum values: `get_mappings_response` | {% /tab %} {% tab title="Example" %} ```json { "data": { "attributes": { "attributes": [ { "attribute": "user_id", "description": "Unique user identifier", "display_name": "User ID", "groups": [ "Identity" ], "is_custom": false, "type": "string" }, { "attribute": "user_email", "description": "User email address", "display_name": "Email Address", "groups": [ "Identity", "Contact" ], "is_custom": false, "type": "string" }, { "attribute": "first_country_code", "description": "The ISO code of the country for the user's first session", "display_name": "First Country Code", "groups": [ "Geography" ], "is_custom": false, "type": "string" }, { "attribute": "@customer_tier", "description": "Customer subscription tier", "display_name": "Customer Tier", "groups": [ "Business" ], "is_custom": true, "type": "string" } ] }, "id": "get_mappings_response", "type": "get_mappings_response" } } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \# Path parametersexport entity="users"\# Curl commandcurl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.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/product-analytics/${entity}/mapping" \ -H "Accept: application/json" \ -H "DD-API-KEY: ${DD_API_KEY}" \ -H "DD-APPLICATION-KEY: ${DD_APP_KEY}" ##### ```python """ Get mapping returns "Successful response with entity mapping configuration" response """ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_audience_management_api import RumAudienceManagementApi configuration = Configuration() configuration.unstable_operations["get_mapping"] = True with ApiClient(configuration) as api_client: api_instance = RumAudienceManagementApi(api_client) response = api_instance.get_mapping( entity="users", ) print(response) ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" python3 "example.py" ##### ```ruby # Get mapping returns "Successful response with entity mapping configuration" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.unstable_operations["v2.get_mapping".to_sym] = true end api_instance = DatadogAPIClient::V2::RumAudienceManagementAPI.new p api_instance.get_mapping("users") ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" rb "example.rb" ##### ```go // Get mapping returns "Successful response with entity mapping configuration" 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.GetMapping", true) apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewRumAudienceManagementApi(apiClient) resp, r, err := api.GetMapping(ctx, "users") if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `RumAudienceManagementApi.GetMapping`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `RumAudienceManagementApi.GetMapping`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" go run "main.go" ##### ```java // Get mapping returns "Successful response with entity mapping configuration" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.RumAudienceManagementApi; import com.datadog.api.client.v2.model.GetMappingResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setUnstableOperationEnabled("v2.getMapping", true); RumAudienceManagementApi apiInstance = new RumAudienceManagementApi(defaultClient); try { GetMappingResponse result = apiInstance.getMapping("users"); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling RumAudienceManagementApi#getMapping"); 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](https://docs.datadoghq.com/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" java "Example.java" ##### ```rust // Get mapping returns "Successful response with entity mapping configuration" // response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_rum_audience_management::RumAudienceManagementAPI; #[tokio::main] async fn main() { let mut configuration = datadog::Configuration::new(); configuration.set_unstable_operation_enabled("v2.GetMapping", true); let api = RumAudienceManagementAPI::with_config(configuration); let resp = api.get_mapping("users".to_string()).await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=rust) 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.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" cargo run ##### ```typescript /** * Get mapping returns "Successful response with entity mapping configuration" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration(); configuration.unstableOperations["v2.getMapping"] = true; const apiInstance = new v2.RumAudienceManagementApi(configuration); const params: v2.RumAudienceManagementApiGetMappingRequest = { entity: "users", }; apiInstance .getMapping(params) .then((data: v2.GetMappingResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://docs.datadoghq.com/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.com" DD_API_KEY="" DD_APP_KEY="" tsc "example.ts" {% /tab %}