--- title: List connections description: List all data connections for an entity breadcrumbs: Docs > API > List connections --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # List connections ## v2 (latest) {% alert level="warning" %} **Note**: This endpoint may be subject to changes. {% /alert %} | Datadog site | API endpoint | | ----------------- | --------------------------------------------------------------------------------------- | | 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 | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/product-analytics/{entity}/mapping/connections | | 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 | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connections | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/product-analytics/{entity}/mapping/connections | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/product-analytics/{entity}/mapping/connections | ### Overview List all data connections for an entity ### Arguments #### Path Parameters | Field | Type | Description | | ------------------- | ------ | ---------------------------------------- | | entity [*required*] | string | The entity for which to list connections | ### Response {% tabs %} {% tab label="200" %} Successful response with list of connections {% tabs %} {% tab label="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`. Default: `list_connections_response`. | {% /tab %} {% tab label="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 %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export entity="users" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/product-analytics/${entity}/mapping/connections" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```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()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```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.setAccessToken(System.getenv("DD_BEARER_TOKEN")); 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ List connections returns "Successful response with list of connections" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.rum_audience_management_api import RumAudienceManagementApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # List connections returns "Successful response with list of connections" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```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.list_connections", 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * List connections returns "Successful response with list of connections" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); 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://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}