For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/api/latest/rum-audience-management/create-connection.md. A documentation index is available at /llms.txt.
Language
Datadog site

Create connection

WARNINGNote: This endpoint may be subject to changes.
POSThttps://api.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.us3.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.us5.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.datadoghq.eu/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.ap1.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.ap2.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.uk1.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.ddog-gov.com/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.us2.ddog-gov.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)

Field
Type
Description
data
object

The data object containing the resource type and attributes for creating a new connection.

Response

Connection created successfully

Code Example

# Path parameters
export entity="users"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/${entity}/mapping/connection" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "fields": [
        {
          "description": "Customer subscription tier from `CRM`",
          "display_name": "Customer Tier",
          "id": "customer_tier",
          "source_name": "subscription_tier",
          "type": "string"
        },
        {
          "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": "connection_id"
  }
}
EOF
# Path parameters
export entity="users"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/${entity}/mapping/connection" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "fields": [
        {
          "description": "Customer subscription tier from `CRM`",
          "display_name": "Customer Tier",
          "id": "customer_tier",
          "source_name": "subscription_tier",
          "type": "string"
        },
        {
          "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": "connection_id"
  }
}
EOF
# Path parameters
export entity="users"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/${entity}/mapping/connection" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "fields": [
        {
          "description": "Customer subscription tier from `CRM`",
          "display_name": "Customer Tier",
          "id": "customer_tier",
          "source_name": "subscription_tier",
          "type": "string"
        },
        {
          "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": "connection_id"
  }
}
EOF
# Path parameters
export entity="users"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/${entity}/mapping/connection" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "fields": [
        {
          "description": "Customer subscription tier from `CRM`",
          "display_name": "Customer Tier",
          "id": "customer_tier",
          "source_name": "subscription_tier",
          "type": "string"
        },
        {
          "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": "connection_id"
  }
}
EOF
# Path parameters
export entity="users"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/${entity}/mapping/connection" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "fields": [
        {
          "description": "Customer subscription tier from `CRM`",
          "display_name": "Customer Tier",
          "id": "customer_tier",
          "source_name": "subscription_tier",
          "type": "string"
        },
        {
          "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": "connection_id"
  }
}
EOF
# Path parameters
export entity="users"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/${entity}/mapping/connection" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "fields": [
        {
          "description": "Customer subscription tier from `CRM`",
          "display_name": "Customer Tier",
          "id": "customer_tier",
          "source_name": "subscription_tier",
          "type": "string"
        },
        {
          "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": "connection_id"
  }
}
EOF
# Path parameters
export entity="users"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/${entity}/mapping/connection" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "fields": [
        {
          "description": "Customer subscription tier from `CRM`",
          "display_name": "Customer Tier",
          "id": "customer_tier",
          "source_name": "subscription_tier",
          "type": "string"
        },
        {
          "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": "connection_id"
  }
}
EOF
# Path parameters
export entity="users"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/${entity}/mapping/connection" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "fields": [
        {
          "description": "Customer subscription tier from `CRM`",
          "display_name": "Customer Tier",
          "id": "customer_tier",
          "source_name": "subscription_tier",
          "type": "string"
        },
        {
          "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": "connection_id"
  }
}
EOF
# Path parameters
export entity="users"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

curl -X POST "https://api.${DD_SITE}/api/v2/product-analytics/${entity}/mapping/connection" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "fields": [
        {
          "description": "Customer subscription tier from `CRM`",
          "display_name": "Customer Tier",
          "id": "customer_tier",
          "source_name": "subscription_tier",
          "type": "string"
        },
        {
          "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": "connection_id"
  }
}
EOF