Language

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

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 UK1 US1-FED US2-FED
This product is not supported for your selected Datadog site. ().

Create exposure SQL model

copy Copy pageCopied

POST https://api.ap1.datadoghq.com/api/v2/experiments/exposure-sql-modelshttps://api.ap2.datadoghq.com/api/v2/experiments/exposure-sql-modelshttps://api.datadoghq.eu/api/v2/experiments/exposure-sql-modelshttps://api.ddog-gov.com/api/v2/experiments/exposure-sql-modelshttps://api.us2.ddog-gov.com/api/v2/experiments/exposure-sql-modelshttps://api.uk1.datadoghq.com/api/v2/experiments/exposure-sql-modelshttps://api.datadoghq.com/api/v2/experiments/exposure-sql-modelshttps://api.us3.datadoghq.com/api/v2/experiments/exposure-sql-modelshttps://api.us5.datadoghq.com/api/v2/experiments/exposure-sql-models

Overview

Create an exposure SQL model. Requires at least one subject type. The warehouse connection is resolved from the organization, which has exactly one. This endpoint requires the product_analytics_warehouse_model_write permission.

OAuth apps require the product_analytics_warehouse_model_write authorization scope to access this endpoint.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Exposure SQL model resource to create.

attributes [required]

object

Complete column mappings and query used to replace the exposure SQL model.

date_partition_column

string

SQL column used to partition the source data by date.

experiment_column [required]

string

SQL column that identifies the experiment for each exposure.

migration_metadata

Metadata retained for resources imported from another system.

name [required]

string

Display name of the exposure SQL model.

properties

[object]

Property columns exposed by the SQL model.

column_name [required]

string

Name of the SQL result column that supplies this property.

column_type

enum

Data type of a column in the SQL model. Allowed enum values: STRING,INTEGER,FLOAT,BOOLEAN,DATE,TIMESTAMP

description

string

Optional text that explains what this property represents.

migration_metadata

Opaque metadata preserved when this property is migrated.

name [required]

string

Name used to identify the property in the model.

sql [required]

string

SQL query that produces the model's source data.

subject_types [required]

[object]

Subject types mapped to columns in the SQL model.

column_name [required]

string

SQL result column that contains the subject identifier.

subject_type_id [required]

string

Identifier of the subject type mapped to this column.

timestamp_column [required]

string

SQL column that supplies the event timestamp.

variant_column [required]

string

SQL column that identifies the variant for each exposure.

id

string

Optional JSON:API resource identifier field.

type [required]

enum

Exposure SQL models resource type. Allowed enum values: exposure-sql-models

default: exposure-sql-models

{
  "data": {
    "attributes": {
      "date_partition_column": null,
      "experiment_column": "experiment_id",
      "migration_metadata": "undefined",
      "name": "Exposure events",
      "properties": [
        {
          "column_name": "country",
          "column_type": "STRING",
          "description": null,
          "migration_metadata": "undefined",
          "name": "country"
        }
      ],
      "sql": "SELECT user_id, experiment_id, variant, exposed_at, country FROM analytics.exposures",
      "subject_types": [
        {
          "column_name": "user_id",
          "subject_type_id": "550e8400-e29b-41d4-a716-446655440010"
        }
      ],
      "timestamp_column": "exposed_at",
      "variant_column": "variant"
    },
    "id": "string",
    "type": "exposure-sql-models"
  }
}

Response

Created

Response containing a SQL model for experiment assignment data.

Expand All

Field

Type

Description

data [required]

object

Exposure SQL model resource with its identifier and configuration.

attributes

object

Query and column mappings used to read experiment assignment data.

archived_at

date-time

Time when the exposure SQL model was archived.

created_at

date-time

Time when the exposure SQL model was created.

date_partition_column

string

Column used to identify date partitions in the exposure data.

experiment_column

string

SQL result column that contains the experiment key.

experiment_count

int64

Number of experiments associated with the exposure SQL model.

migration_metadata

Metadata associated with migration of this resource.

name

string

Display name of the exposure SQL model.

properties

[object]

Property columns available for filtering or splitting exposure data.

column_name

string

SQL result column that contains this property.

column_type

string

Data type of the property column.

description

string

Description of the exposure property.

id

string

Identifier of the exposure property.

migration_metadata

Metadata associated with migration of this resource.

name

string

Display name of the exposure property.

pipeline_column_suffix

string

Suffix used for this property column in the analysis pipeline.

sql

string

SQL query that supplies the experiment assignment data.

subject_types

[object]

Mappings between subject types and their identifier columns.

column_name [required]

string

SQL result column that contains the subject identifier.

subject_type_id [required]

string

Identifier of the subject type mapped to this column.

timestamp_column

string

SQL result column that contains the assignment timestamp.

updated_at

date-time

Time when the exposure SQL model was last updated.

variant_column

string

SQL result column that contains the assigned variant.

id [required]

uuid

Identifier of the exposure SQL model.

type [required]

enum

Exposure SQL models resource type. Allowed enum values: exposure-sql-models

default: exposure-sql-models

{
  "data": {
    "attributes": {
      "created_at": "2024-01-01T12:00:00Z",
      "experiment_column": "experiment_id",
      "name": "Exposure events",
      "properties": [
        {
          "column_name": "country",
          "column_type": "STRING",
          "id": "550e8400-e29b-41d4-a716-446655440031",
          "name": "country",
          "pipeline_column_suffix": "cty001"
        }
      ],
      "sql": "SELECT user_id, experiment_id, variant, exposed_at, country FROM analytics.exposures",
      "subject_types": [
        {
          "column_name": "user_id",
          "subject_type_id": "550e8400-e29b-41d4-a716-446655440010"
        }
      ],
      "timestamp_column": "exposed_at",
      "updated_at": "2024-01-01T12:00:00Z",
      "variant_column": "variant"
    },
    "id": "550e8400-e29b-41d4-a716-446655440030",
    "type": "exposure-sql-models"
  }
}

Malformed body, validation failure, or the SQL was rejected by the warehouse validator.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Missing or invalid authentication.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Authenticated caller lacks the product_analytics_warehouse_model_write permission.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

The write collided with an existing record for the organization.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Request body sent with a media type other than application/json or application/vnd.api+json.

API error response.

Expand All

Field

Type

Description

errors [required]

[object]

A list of errors.

detail

string

A human-readable explanation specific to this occurrence of the error.

meta

object

Non-standard meta-information about the error

source

object

References to the source of the error.

header

string

A string indicating the name of a single request header which caused the error.

parameter

string

A string indicating which URI query parameter caused the error.

pointer

string

A JSON pointer to the value in the request document that caused the error.

status

string

Status code of the response.

title

string

Short human-readable summary of the error.

{
  "errors": [
    {
      "detail": "Missing required attribute in body",
      "meta": {},
      "source": {
        "header": "Authorization",
        "parameter": "limit",
        "pointer": "/data/attributes/title"
      },
      "status": "400",
      "title": "Bad Request"
    }
  ]
}

Too many requests

API error response.

Expand All

Field

Type

Description

errors [required]

[string]

A list of errors.

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

Code Example

                  ## default
# 

# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# 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.us2.ddog-gov.com"https://api.uk1.datadoghq.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/experiments/exposure-sql-models" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}" \
-d @- << EOF
{
  "data": {
    "attributes": {
      "date_partition_column": null,
      "experiment_column": "experiment_id",
      "name": "Exposure events",
      "sql": "SELECT user_id, experiment_id, variant, exposed_at, country FROM analytics.exposures",
      "subject_types": [
        {
          "column_name": "user_id",
          "subject_type_id": "550e8400-e29b-41d4-a716-446655440010"
        }
      ],
      "timestamp_column": "exposed_at",
      "variant_column": "variant"
    },
    "type": "exposure-sql-models"
  }
}
EOF