--- title: Create exposure SQL model description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > API Reference > Experiments --- > For the complete documentation index, see [llms.txt](https://docs.datadoghq.com/llms.txt). {% callout %} # Important note for users on the following Datadog sites: app.ddog-gov.com, us2.ddog-gov.com {% alert level="danger" %} This product is not supported for your selected [Datadog site](https://docs.datadoghq.com/getting_started/site.md). ({% placeholder "user-datadog-site-name" /%}). {% /alert %} {% /callout %} # Create exposure SQL model{% #create-exposure-sql-model %} {% tab title="v2" %} | Datadog site | API endpoint | | ----------------- | ------------------------------------------------------------------------- | | ap1.datadoghq.com | POST https://api.ap1.datadoghq.com/api/v2/experiments/exposure-sql-models | | ap2.datadoghq.com | POST https://api.ap2.datadoghq.com/api/v2/experiments/exposure-sql-models | | app.datadoghq.eu | POST https://api.datadoghq.eu/api/v2/experiments/exposure-sql-models | | app.ddog-gov.com | POST https://api.ddog-gov.com/api/v2/experiments/exposure-sql-models | | us2.ddog-gov.com | POST https://api.us2.ddog-gov.com/api/v2/experiments/exposure-sql-models | | uk1.datadoghq.com | POST https://api.uk1.datadoghq.com/api/v2/experiments/exposure-sql-models | | app.datadoghq.com | POST https://api.datadoghq.com/api/v2/experiments/exposure-sql-models | | us3.datadoghq.com | POST https://api.us3.datadoghq.com/api/v2/experiments/exposure-sql-models | | us5.datadoghq.com | POST https://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](https://docs.datadoghq.com/api/latest/scopes.md#experiments) to access this endpoint. ### Request #### Body Data (required) {% tab title="Model" %} | Parent field | Field | Type | Description | | ------------- | ----------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | Exposure SQL model resource to create. | | data | attributes [*required*] | object | Complete column mappings and query used to replace the exposure SQL model. | | attributes | date_partition_column | string | SQL column used to partition the source data by date. | | attributes | experiment_column [*required*] | string | SQL column that identifies the experiment for each exposure. | | attributes | migration_metadata | | Metadata retained for resources imported from another system. | | attributes | name [*required*] | string | Display name of the exposure SQL model. | | attributes | properties | [object] | Property columns exposed by the SQL model. | | properties | column_name [*required*] | string | Name of the SQL result column that supplies this property. | | properties | column_type | enum | Data type of a column in the SQL model. Allowed enum values: `STRING,INTEGER,FLOAT,BOOLEAN,DATE,TIMESTAMP` | | properties | description | string | Optional text that explains what this property represents. | | properties | migration_metadata | | Opaque metadata preserved when this property is migrated. | | properties | name [*required*] | string | Name used to identify the property in the model. | | attributes | sql [*required*] | string | SQL query that produces the model's source data. | | attributes | subject_types [*required*] | [object] | Subject types mapped to columns in the SQL model. | | subject_types | column_name [*required*] | string | SQL result column that contains the subject identifier. | | subject_types | subject_type_id [*required*] | string | Identifier of the subject type mapped to this column. | | attributes | timestamp_column [*required*] | string | SQL column that supplies the event timestamp. | | attributes | variant_column [*required*] | string | SQL column that identifies the variant for each exposure. | | data | id | string | Optional JSON:API resource identifier field. | | data | type [*required*] | enum | Exposure SQL models resource type. Allowed enum values: `exposure-sql-models` | {% /tab %} {% tab title="Example" %} ```json { "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" } } ``` {% /tab %} ### Response {% tab title="201" %} Created {% tab title="Model" %} Response containing a SQL model for experiment assignment data. | Parent field | Field | Type | Description | | ------------- | --------------------------------- | --------- | ----------------------------------------------------------------------------- | | | data [*required*] | object | Exposure SQL model resource with its identifier and configuration. | | data | attributes | object | Query and column mappings used to read experiment assignment data. | | attributes | archived_at | date-time | Time when the exposure SQL model was archived. | | attributes | created_at | date-time | Time when the exposure SQL model was created. | | attributes | date_partition_column | string | Column used to identify date partitions in the exposure data. | | attributes | experiment_column | string | SQL result column that contains the experiment key. | | attributes | experiment_count | int64 | Number of experiments associated with the exposure SQL model. | | attributes | migration_metadata | | Metadata associated with migration of this resource. | | attributes | name | string | Display name of the exposure SQL model. | | attributes | properties | [object] | Property columns available for filtering or splitting exposure data. | | properties | column_name | string | SQL result column that contains this property. | | properties | column_type | string | Data type of the property column. | | properties | description | string | Description of the exposure property. | | properties | id | string | Identifier of the exposure property. | | properties | migration_metadata | | Metadata associated with migration of this resource. | | properties | name | string | Display name of the exposure property. | | properties | pipeline_column_suffix | string | Suffix used for this property column in the analysis pipeline. | | attributes | sql | string | SQL query that supplies the experiment assignment data. | | attributes | subject_types | [object] | Mappings between subject types and their identifier columns. | | subject_types | column_name [*required*] | string | SQL result column that contains the subject identifier. | | subject_types | subject_type_id [*required*] | string | Identifier of the subject type mapped to this column. | | attributes | timestamp_column | string | SQL result column that contains the assignment timestamp. | | attributes | updated_at | date-time | Time when the exposure SQL model was last updated. | | attributes | variant_column | string | SQL result column that contains the assigned variant. | | data | id [*required*] | uuid | Identifier of the exposure SQL model. | | data | type [*required*] | enum | Exposure SQL models resource type. Allowed enum values: `exposure-sql-models` | {% /tab %} {% tab title="Example" %} ```json { "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" } } ``` {% /tab %} {% /tab %} {% tab title="400" %} Malformed body, validation failure, or the SQL was rejected by the warehouse validator. {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="401" %} Missing or invalid authentication. {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="403" %} Authenticated caller lacks the product_analytics_warehouse_model_write permission. {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="409" %} The write collided with an existing record for the organization. {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="415" %} Request body sent with a media type other than application/json or application/vnd.api+json. {% tab title="Model" %} API error response. | Parent field | Field | Type | Description | | ------------ | ------------------------ | -------- | ------------------------------------------------------------------------------- | | | errors [*required*] | [object] | A list of errors. | | errors | detail | string | A human-readable explanation specific to this occurrence of the error. | | errors | meta | object | Non-standard meta-information about the error | | errors | source | object | References to the source of the error. | | source | header | string | A string indicating the name of a single request header which caused the error. | | source | parameter | string | A string indicating which URI query parameter caused the error. | | source | pointer | string | A JSON pointer to the value in the request document that caused the error. | | errors | status | string | Status code of the response. | | errors | title | string | Short human-readable summary of the error. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ { "detail": "Missing required attribute in body", "meta": {}, "source": { "header": "Authorization", "parameter": "limit", "pointer": "/data/attributes/title" }, "status": "400", "title": "Bad Request" } ] } ``` {% /tab %} {% /tab %} {% tab title="429" %} Too many requests {% tab title="Model" %} API error response. | Field | Type | Description | | ------------------------ | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab title="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tab %} ### Code Example ##### \## default # \# Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" \# Curl command curl -X POST "https://api.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 {% /tab %}