Response containing the list of all data source connections configured for an entity.
Expand All
Field
Type
Description
data
object
The data object containing the resource type and attributes for the list connections response.
attributes
object
Attributes of the list connections response, containing the collection of data source connections.
connections
[object]
The list of data source connections configured for the entity.
created_at
date-time
Timestamp indicating when the connection was created.
created_by
string
Identifier of the user who created the connection.
fields
[object]
List of custom attribute fields imported from the data source.
description
string
Human-readable explanation of what the field represents.
display_name
string
The human-readable label for the field shown in the UI.
groups
[string]
List of group labels used to categorize the field.
id [required]
string
The unique identifier for the field within the connection.
source_name [required]
string
The name of the column or attribute in the source data system that maps to this field.
type [required]
string
The data type of the field (for example, string or number).
id
string
Unique identifier of the connection.
join
object
The join configuration describing how the data source is linked to the entity.
attribute
string
The entity attribute used as the join key to link records from the data source.
type
string
The type of join key used (for example, email or user_id).
metadata
object
Additional key-value metadata associated with the connection.
<any-key>
string
type
string
The type of data source connection (for example, ref_table).
updated_at
date-time
Timestamp indicating when the connection was last updated.
updated_by
string
Identifier of the user who last updated the connection.
id
string
Unique identifier for the list connections response resource.
type [required]
enum
List connections response resource type.
Allowed enum values: list_connections_response
default: list_connections_response
{"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"}}
"""
List connections returns "Successful response with list of connections" response
"""fromdatadog_api_clientimportApiClient,Configurationfromdatadog_api_client.v2.api.rum_audience_management_apiimportRumAudienceManagementApiconfiguration=Configuration()configuration.unstable_operations["list_connections"]=TruewithApiClient(configuration)asapi_client:api_instance=RumAudienceManagementApi(api_client)response=api_instance.list_connections(entity="users",)print(response)
# List connections returns "Successful response with list of connections" responserequire"datadog_api_client"DatadogAPIClient.configuredo|config|config.unstable_operations["v2.list_connections".to_sym]=trueendapi_instance=DatadogAPIClient::V2::RumAudienceManagementAPI.newpapi_instance.list_connections("users")
// List connections returns "Successful response with list of connections" responsepackagemainimport("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")funcmain(){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")iferr!=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)}
// List connections returns "Successful response with list of connections" responseimportcom.datadog.api.client.ApiClient;importcom.datadog.api.client.ApiException;importcom.datadog.api.client.v2.api.RumAudienceManagementApi;importcom.datadog.api.client.v2.model.ListConnectionsResponse;publicclassExample{publicstaticvoidmain(String[]args){ApiClientdefaultClient=ApiClient.getDefaultApiClient();defaultClient.setUnstableOperationEnabled("v2.listConnections",true);RumAudienceManagementApiapiInstance=newRumAudienceManagementApi(defaultClient);try{ListConnectionsResponseresult=apiInstance.listConnections("users");System.out.println(result);}catch(ApiExceptione){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();}}}
// List connections returns "Successful response with list of connections" response
usedatadog_api_client::datadog;usedatadog_api_client::datadogV2::api_rum_audience_management::RumAudienceManagementAPI;#[tokio::main]asyncfnmain(){letmutconfiguration=datadog::Configuration::new();configuration.set_unstable_operation_enabled("v2.ListConnections",true);letapi=RumAudienceManagementAPI::with_config(configuration);letresp=api.list_connections("users".to_string()).await;ifletOk(value)=resp{println!("{:#?}",value);}else{println!("{:#?}",resp.unwrap_err());}}
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comddog-gov.comus2.ddog-gov.com"DD_API_KEY="<DD_API_KEY>"DD_APP_KEY="<DD_APP_KEY>"cargo run
/**
* List connections returns "Successful response with list of connections" response
*/import{client,v2}from"@datadog/datadog-api-client";constconfiguration=client.createConfiguration();configuration.unstableOperations["v2.listConnections"]=true;constapiInstance=newv2.RumAudienceManagementApi(configuration);constparams: 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));