For AI agents: A markdown version of this page is available at https://dnd37xeb23o8n.cloudfront.net/jen.gilbert/astro-base/api/latest/rum-audience-management/query-users.md. A documentation index is available at /llms.txt.
Language
Datadog site

Query users

WARNINGNote: This endpoint may be subject to changes.
POSThttps://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/queryhttps://api.datadoghq.eu/api/v2/product-analytics/users/queryhttps://api.ap1.datadoghq.com/api/v2/product-analytics/users/queryhttps://api.ap2.datadoghq.com/api/v2/product-analytics/users/queryhttps://api.uk1.datadoghq.com/api/v2/product-analytics/users/queryhttps://api.ddog-gov.com/api/v2/product-analytics/users/queryhttps://api.us2.ddog-gov.com/api/v2/product-analytics/users/query

Overview

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

Request

Body Data (required)

Field
Type
Description
data
object

The data object containing the resource type and attributes for querying users.

Response

Successful response with user data

Response containing the query results with matched records and total count.

Field
Type
Description
data
object

The data object containing the resource type and attributes of the query response.

Code Example

Query 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/users/query" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "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": {
        "field": "first_seen",
        "order": "DESC"
      },
      "wildcard_search_term": "john"
    },
    "id": "query_users_request",
    "type": "query_users_request"
  }
}
EOF
# 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/users/query" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "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": {
        "field": "first_seen",
        "order": "DESC"
      },
      "wildcard_search_term": "john"
    },
    "id": "query_users_request",
    "type": "query_users_request"
  }
}
EOF
# 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/users/query" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "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": {
        "field": "first_seen",
        "order": "DESC"
      },
      "wildcard_search_term": "john"
    },
    "id": "query_users_request",
    "type": "query_users_request"
  }
}
EOF
# 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/users/query" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "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": {
        "field": "first_seen",
        "order": "DESC"
      },
      "wildcard_search_term": "john"
    },
    "id": "query_users_request",
    "type": "query_users_request"
  }
}
EOF
# 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/users/query" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "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": {
        "field": "first_seen",
        "order": "DESC"
      },
      "wildcard_search_term": "john"
    },
    "id": "query_users_request",
    "type": "query_users_request"
  }
}
EOF
# 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/users/query" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "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": {
        "field": "first_seen",
        "order": "DESC"
      },
      "wildcard_search_term": "john"
    },
    "id": "query_users_request",
    "type": "query_users_request"
  }
}
EOF
# 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/users/query" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "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": {
        "field": "first_seen",
        "order": "DESC"
      },
      "wildcard_search_term": "john"
    },
    "id": "query_users_request",
    "type": "query_users_request"
  }
}
EOF
# 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/users/query" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "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": {
        "field": "first_seen",
        "order": "DESC"
      },
      "wildcard_search_term": "john"
    },
    "id": "query_users_request",
    "type": "query_users_request"
  }
}
EOF
# 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/users/query" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "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": {
        "field": "first_seen",
        "order": "DESC"
      },
      "wildcard_search_term": "john"
    },
    "id": "query_users_request",
    "type": "query_users_request"
  }
}
EOF