Language

日本語 English Français 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED
このページは日本語には対応しておりません。随時翻訳に取り組んでいます。
翻訳に関してご質問やご意見ございましたら、お気軽にご連絡ください。

Rum Audience Management

Auto-generated tag Rum Audience Management

Query accounts

Note: This endpoint may be subject to changes.

POST https://api.ap1.datadoghq.com/api/v2/product-analytics/accounts/queryhttps://api.ap2.datadoghq.com/api/v2/product-analytics/accounts/queryhttps://api.datadoghq.eu/api/v2/product-analytics/accounts/queryhttps://api.ddog-gov.com/api/v2/product-analytics/accounts/queryhttps://api.datadoghq.com/api/v2/product-analytics/accounts/queryhttps://api.us3.datadoghq.com/api/v2/product-analytics/accounts/queryhttps://api.us5.datadoghq.com/api/v2/product-analytics/accounts/query

概要

Query accounts with flexible filtering by account properties

リクエスト

Body Data (required)

Expand All

フィールド

種類

説明

data

object

attributes

object

limit

int64

query

string

select_columns

[string]

sort

object

field

string

order

string

wildcard_search_term

string

id

string

type [required]

enum

Query account request resource type. Allowed enum values: query_account_request

default: query_account_request

{
  "data": {
    "attributes": {
      "limit": "integer",
      "query": "string",
      "select_columns": [],
      "sort": {
        "field": "string",
        "order": "string"
      },
      "wildcard_search_term": "string"
    },
    "id": "string",
    "type": "query_account_request"
  }
}

応答

Successful response with account data

Expand All

フィールド

種類

説明

data

object

attributes

object

hits

[]

total

int64

id

string

type [required]

enum

Query response resource type. Allowed enum values: query_response

default: query_response

{
  "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"
  }
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

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

コード例

                  # Curl command
curl -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

Create connection

Note: This endpoint may be subject to changes.

POST https://api.ap1.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.ap2.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.datadoghq.eu/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.ddog-gov.com/api/v2/product-analytics/{entity}/mapping/connectionhttps://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/connection

概要

Create a new data connection and its fields for an entity

引数

パスパラメーター

名前

種類

説明

entity [required]

string

The entity for which to create the connection

リクエスト

Body Data (required)

Expand All

フィールド

種類

説明

data

object

attributes

object

fields

[object]

description

string

display_name

string

groups

[string]

id [required]

string

source_name [required]

string

type [required]

string

join_attribute [required]

string

join_type [required]

string

metadata

object

<any-key>

string

type [required]

string

id

string

type [required]

enum

Connection id resource type. Allowed enum values: connection_id

default: connection_id

{
  "data": {
    "attributes": {
      "fields": [
        {
          "description": "string",
          "display_name": "string",
          "groups": [],
          "id": "",
          "source_name": "",
          "type": ""
        }
      ],
      "join_attribute": "",
      "join_type": "",
      "metadata": {
        "<any-key>": "string"
      },
      "type": ""
    },
    "id": "string",
    "type": "connection_id"
  }
}

応答

Connection created successfully

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

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

コード例

                  # Path parameters
export entity="users"
# Curl command
curl -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

Update connection

Note: This endpoint may be subject to changes.

PUT https://api.ap1.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.ap2.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.datadoghq.eu/api/v2/product-analytics/{entity}/mapping/connectionhttps://api.ddog-gov.com/api/v2/product-analytics/{entity}/mapping/connectionhttps://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/connection

概要

Update an existing data connection by adding, updating, or deleting fields

引数

パスパラメーター

名前

種類

説明

entity [required]

string

The entity for which to update the connection

リクエスト

Body Data (required)

Expand All

フィールド

種類

説明

data

object

attributes

object

fields_to_add

[object]

description

string

display_name

string

groups

[string]

id [required]

string

source_name [required]

string

type [required]

string

fields_to_delete

[string]

fields_to_update

[object]

field_id [required]

string

updated_description

string

updated_display_name

string

updated_field_id

string

updated_groups

[string]

id [required]

string

type [required]

enum

Connection id resource type. Allowed enum values: connection_id

default: connection_id

{
  "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"
  }
}

応答

Connection updated successfully

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

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

コード例

                  # Path parameters
export entity="users"
# Curl command
curl -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

Query event filtered users

Note: This endpoint may be subject to changes.

POST https://api.ap1.datadoghq.com/api/v2/product-analytics/users/event_filtered_queryhttps://api.ap2.datadoghq.com/api/v2/product-analytics/users/event_filtered_queryhttps://api.datadoghq.eu/api/v2/product-analytics/users/event_filtered_queryhttps://api.ddog-gov.com/api/v2/product-analytics/users/event_filtered_queryhttps://api.datadoghq.com/api/v2/product-analytics/users/event_filtered_queryhttps://api.us3.datadoghq.com/api/v2/product-analytics/users/event_filtered_queryhttps://api.us5.datadoghq.com/api/v2/product-analytics/users/event_filtered_query

概要

Query users filtered by both user properties and event platform data

リクエスト

Body Data (required)

Expand All

フィールド

種類

説明

data

object

attributes

object

event_query

object

query

string

time_frame

object

end

int64

start

int64

include_row_count

boolean

limit

int64

query

string

select_columns

[string]

id

string

type [required]

enum

Query event filtered users request resource type. Allowed enum values: query_event_filtered_users_request

default: query_event_filtered_users_request

{
  "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"
  }
}

応答

Successful response with filtered user data

Expand All

フィールド

種類

説明

data

object

attributes

object

hits

[]

total

int64

id

string

type [required]

enum

Query response resource type. Allowed enum values: query_response

default: query_response

{
  "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"
  }
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

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

コード例

                  # Curl command
curl -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

Get account facet info

Note: This endpoint may be subject to changes.

POST https://api.ap1.datadoghq.com/api/v2/product-analytics/accounts/facet_infohttps://api.ap2.datadoghq.com/api/v2/product-analytics/accounts/facet_infohttps://api.datadoghq.eu/api/v2/product-analytics/accounts/facet_infohttps://api.ddog-gov.com/api/v2/product-analytics/accounts/facet_infohttps://api.datadoghq.com/api/v2/product-analytics/accounts/facet_infohttps://api.us3.datadoghq.com/api/v2/product-analytics/accounts/facet_infohttps://api.us5.datadoghq.com/api/v2/product-analytics/accounts/facet_info

概要

Get facet information for account attributes including possible values and counts

リクエスト

Body Data (required)

Expand All

フィールド

種類

説明

data

object

attributes

object

facet_id [required]

string

limit [required]

int64

search

object

query

string

term_search

object

value

string

id

string

type [required]

enum

Users facet info request resource type. Allowed enum values: users_facet_info_request

default: users_facet_info_request

{
  "data": {
    "attributes": {
      "facet_id": "",
      "limit": 0,
      "search": {
        "query": "string"
      },
      "term_search": {
        "value": "string"
      }
    },
    "id": "string",
    "type": "users_facet_info_request"
  }
}

応答

Successful response with facet information

Expand All

フィールド

種類

説明

data

object

attributes

object

result

object

range

object

max

object

min

object

values

[object]

count

int64

value

string

id

string

type [required]

enum

Users facet info resource type. Allowed enum values: users_facet_info

default: users_facet_info

{
  "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"
  }
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

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

コード例

                  # Curl command
curl -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

Delete connection

Note: This endpoint may be subject to changes.

DELETE https://api.ap1.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection/{id}https://api.ap2.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection/{id}https://api.datadoghq.eu/api/v2/product-analytics/{entity}/mapping/connection/{id}https://api.ddog-gov.com/api/v2/product-analytics/{entity}/mapping/connection/{id}https://api.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection/{id}https://api.us3.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection/{id}https://api.us5.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connection/{id}

概要

Delete an existing data connection for an entity

引数

パスパラメーター

名前

種類

説明

id [required]

string

The connection ID to delete

entity [required]

string

The entity for which to delete the connection

応答

Connection deleted successfully

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

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

コード例

                  # Path parameters
export id="connection-id-123"
export entity="users"
# Curl command
curl -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}"

List connections

Note: This endpoint may be subject to changes.

GET https://api.ap1.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionshttps://api.ap2.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionshttps://api.datadoghq.eu/api/v2/product-analytics/{entity}/mapping/connectionshttps://api.ddog-gov.com/api/v2/product-analytics/{entity}/mapping/connectionshttps://api.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionshttps://api.us3.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connectionshttps://api.us5.datadoghq.com/api/v2/product-analytics/{entity}/mapping/connections

概要

List all data connections for an entity

引数

パスパラメーター

名前

種類

説明

entity [required]

string

The entity for which to list connections

応答

Successful response with list of connections

Expand All

フィールド

種類

説明

data

object

attributes

object

connections

[object]

created_at

date-time

created_by

string

fields

[object]

description

string

display_name

string

groups

[string]

id [required]

string

source_name [required]

string

type [required]

string

id

string

join

object

attribute

string

type

string

metadata

object

<any-key>

string

type

string

updated_at

date-time

updated_by

string

id

string

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"
  }
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

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

コード例

                  # Path parameters
export entity="users"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.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}"

Query users

Note: This endpoint may be subject to changes.

POST https://api.ap1.datadoghq.com/api/v2/product-analytics/users/queryhttps://api.ap2.datadoghq.com/api/v2/product-analytics/users/queryhttps://api.datadoghq.eu/api/v2/product-analytics/users/queryhttps://api.ddog-gov.com/api/v2/product-analytics/users/queryhttps://api.datadoghq.com/api/v2/product-analytics/users/queryhttps://api.us3.datadoghq.com/api/v2/product-analytics/users/queryhttps://api.us5.datadoghq.com/api/v2/product-analytics/users/query

概要

Query users with flexible filtering by user properties, with optional wildcard search

リクエスト

Body Data (required)

Expand All

フィールド

種類

説明

data

object

attributes

object

limit

int64

query

string

select_columns

[string]

sort

object

field

string

order

string

wildcard_search_term

string

id

string

type [required]

enum

Query users request resource type. Allowed enum values: query_users_request

default: query_users_request

{
  "data": {
    "attributes": {
      "limit": "integer",
      "query": "string",
      "select_columns": [],
      "sort": {
        "field": "string",
        "order": "string"
      },
      "wildcard_search_term": "string"
    },
    "id": "string",
    "type": "query_users_request"
  }
}

応答

Successful response with user data

Expand All

フィールド

種類

説明

data

object

attributes

object

hits

[]

total

int64

id

string

type [required]

enum

Query response resource type. Allowed enum values: query_response

default: query_response

{
  "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"
  }
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

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

コード例

                  # Curl command
curl -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

Get user facet info

Note: This endpoint may be subject to changes.

POST https://api.ap1.datadoghq.com/api/v2/product-analytics/users/facet_infohttps://api.ap2.datadoghq.com/api/v2/product-analytics/users/facet_infohttps://api.datadoghq.eu/api/v2/product-analytics/users/facet_infohttps://api.ddog-gov.com/api/v2/product-analytics/users/facet_infohttps://api.datadoghq.com/api/v2/product-analytics/users/facet_infohttps://api.us3.datadoghq.com/api/v2/product-analytics/users/facet_infohttps://api.us5.datadoghq.com/api/v2/product-analytics/users/facet_info

概要

Get facet information for user attributes including possible values and counts

リクエスト

Body Data (required)

Expand All

フィールド

種類

説明

data

object

attributes

object

facet_id [required]

string

limit [required]

int64

search

object

query

string

term_search

object

value

string

id

string

type [required]

enum

Users facet info request resource type. Allowed enum values: users_facet_info_request

default: users_facet_info_request

{
  "data": {
    "attributes": {
      "facet_id": "",
      "limit": 0,
      "search": {
        "query": "string"
      },
      "term_search": {
        "value": "string"
      }
    },
    "id": "string",
    "type": "users_facet_info_request"
  }
}

応答

Successful response with facet information

Expand All

フィールド

種類

説明

data

object

attributes

object

result

object

range

object

max

object

min

object

values

[object]

count

int64

value

string

id

string

type [required]

enum

Users facet info resource type. Allowed enum values: users_facet_info

default: users_facet_info

{
  "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"
  }
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

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

コード例

                  # Curl command
curl -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

Get mapping

Note: This endpoint may be subject to changes.

GET https://api.ap1.datadoghq.com/api/v2/product-analytics/{entity}/mappinghttps://api.ap2.datadoghq.com/api/v2/product-analytics/{entity}/mappinghttps://api.datadoghq.eu/api/v2/product-analytics/{entity}/mappinghttps://api.ddog-gov.com/api/v2/product-analytics/{entity}/mappinghttps://api.datadoghq.com/api/v2/product-analytics/{entity}/mappinghttps://api.us3.datadoghq.com/api/v2/product-analytics/{entity}/mappinghttps://api.us5.datadoghq.com/api/v2/product-analytics/{entity}/mapping

概要

Get entity mapping configuration including all available attributes and their properties

引数

パスパラメーター

名前

種類

説明

entity [required]

string

The entity for which to get the mapping

応答

Successful response with entity mapping configuration

Expand All

フィールド

種類

説明

data

object

attributes

object

attributes

[object]

attribute

string

description

string

display_name

string

groups

[string]

is_custom

boolean

type

string

id

string

type [required]

enum

Get mappings response resource type. Allowed enum values: get_mappings_response

default: get_mappings_response

{
  "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"
  }
}

Too many requests

API error response.

Expand All

フィールド

種類

説明

errors [required]

[string]

A list of errors.

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

コード例

                  # Path parameters
export entity="users"
# Curl command
curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.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}"