Update exposure SQL model

v2 (latest)

PUT https://api.ap1.datadoghq.com/api/v2/experiments/exposure-sql-models/{exposure_sql_model_id}https://api.ap2.datadoghq.com/api/v2/experiments/exposure-sql-models/{exposure_sql_model_id}https://api.datadoghq.eu/api/v2/experiments/exposure-sql-models/{exposure_sql_model_id}https://api.ddog-gov.com/api/v2/experiments/exposure-sql-models/{exposure_sql_model_id}https://api.us2.ddog-gov.com/api/v2/experiments/exposure-sql-models/{exposure_sql_model_id}https://api.uk1.datadoghq.com/api/v2/experiments/exposure-sql-models/{exposure_sql_model_id}https://api.datadoghq.com/api/v2/experiments/exposure-sql-models/{exposure_sql_model_id}https://api.us3.datadoghq.com/api/v2/experiments/exposure-sql-models/{exposure_sql_model_id}https://api.us5.datadoghq.com/api/v2/experiments/exposure-sql-models/{exposure_sql_model_id}

Overview

Replace an exposure SQL model. This is a full replacement and is destructive: any subject type or property not present in the body is deleted, and properties are matched on name, column_name and column_type together, so changing one of those replaces the property rather than editing it. Send the complete set you want to keep. Anything removed is listed under meta.removed_subject_type_ids and meta.removed_property_names in the response. The warehouse connection is not settable and is left as stored. 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.

Arguments

Path Parameters

Name

Type

Description

exposure_sql_model_id [required]

string

The UUID of the exposure SQL model.

Query Strings

Name

Type

Description

include

array

Optional fields to include. Repeat this parameter to request several fields. counts adds experiment_count to the updated model.

Request

Body Data (required)

Expand All

Field

Type

Description

data [required]

object

Exposure SQL model resource to create.

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

Updated exposure SQL model and its removed entries.

Expand All

Field

Type

Description

data [required]

object

Exposure SQL model resource with its identifier and configuration.

Code Example

                  ## default
# 

# Path parameters
export exposure_sql_model_id="550e8400-e29b-41d4-a716-446655440000"
# Use a Personal Access Token or Service Access Token
export DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>"

# 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.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/${exposure_sql_model_id}" \
-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

                

"""
Update exposure SQL model returns "OK" response
"""

from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.experiments_api import ExperimentsApi
from datadog_api_client.v2.model.experiments_create_exposure_sql_model_v2_request import (
    ExperimentsCreateExposureSQLModelV2Request,
)
from datadog_api_client.v2.model.experiments_create_exposure_sql_model_v2_request_data import (
    ExperimentsCreateExposureSQLModelV2RequestData,
)
from datadog_api_client.v2.model.experiments_create_exposure_sql_model_v2_request_data_attributes_items_column_type import (
    ExperimentsCreateExposureSQLModelV2RequestDataAttributesItemsColumnType,
)
from datadog_api_client.v2.model.experiments_create_exposure_sql_model_v2_request_data_attributes_subject_types_items import (
    ExperimentsCreateExposureSQLModelV2RequestDataAttributesSubjectTypesItems,
)
from datadog_api_client.v2.model.experiments_sql_model_property_input import ExperimentsSQLModelPropertyInput
from datadog_api_client.v2.model.experiments_update_exposure_sql_model_v2_request_data_attributes import (
    ExperimentsUpdateExposureSQLModelV2RequestDataAttributes,
)
from datadog_api_client.v2.model.experiments_update_exposure_sql_model_v2_request_data_type import (
    ExperimentsUpdateExposureSQLModelV2RequestDataType,
)
from uuid import UUID

body = ExperimentsCreateExposureSQLModelV2Request(
    data=ExperimentsCreateExposureSQLModelV2RequestData(
        attributes=ExperimentsUpdateExposureSQLModelV2RequestDataAttributes(
            date_partition_column=None,
            experiment_column="experiment_id",
            name="Exposure events",
            properties=[
                ExperimentsSQLModelPropertyInput(
                    column_name="country",
                    column_type=ExperimentsCreateExposureSQLModelV2RequestDataAttributesItemsColumnType.STRING,
                    description=None,
                    name="country",
                ),
            ],
            sql="SELECT user_id, experiment_id, variant, exposed_at, country FROM analytics.exposures",
            subject_types=[
                ExperimentsCreateExposureSQLModelV2RequestDataAttributesSubjectTypesItems(
                    column_name="user_id",
                    subject_type_id="550e8400-e29b-41d4-a716-446655440010",
                ),
            ],
            timestamp_column="exposed_at",
            variant_column="variant",
        ),
        type=ExperimentsUpdateExposureSQLModelV2RequestDataType.EXPOSURE_SQL_MODELS,
    ),
)

configuration = Configuration()
configuration.access_token = environ["DD_BEARER_TOKEN"]
with ApiClient(configuration) as api_client:
    api_instance = ExperimentsApi(api_client)
    response = api_instance.update_exposure_sql_model(
        exposure_sql_model_id=UUID("550e8400-e29b-41d4-a716-446655440000"), body=body
    )

    print(response)

Instructions

First install the library and its dependencies and then save the example to example.py and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" python3 "example.py"

# Update exposure SQL model returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
  config.access_token = ENV["DD_BEARER_TOKEN"]
end
api_instance = DatadogAPIClient::V2::ExperimentsAPI.new

body = DatadogAPIClient::V2::ExperimentsCreateExposureSQLModelV2Request.new({
  data: DatadogAPIClient::V2::ExperimentsCreateExposureSQLModelV2RequestData.new({
    attributes: DatadogAPIClient::V2::ExperimentsUpdateExposureSQLModelV2RequestDataAttributes.new({
      date_partition_column: nil,
      experiment_column: "experiment_id",
      name: "Exposure events",
      properties: [
        DatadogAPIClient::V2::ExperimentsSQLModelPropertyInput.new({
          column_name: "country",
          column_type: DatadogAPIClient::V2::ExperimentsCreateExposureSQLModelV2RequestDataAttributesItemsColumnType::STRING,
          description: nil,
          name: "country",
        }),
      ],
      sql: "SELECT user_id, experiment_id, variant, exposed_at, country FROM analytics.exposures",
      subject_types: [
        DatadogAPIClient::V2::ExperimentsCreateExposureSQLModelV2RequestDataAttributesSubjectTypesItems.new({
          column_name: "user_id",
          subject_type_id: "550e8400-e29b-41d4-a716-446655440010",
        }),
      ],
      timestamp_column: "exposed_at",
      variant_column: "variant",
    }),
    type: DatadogAPIClient::V2::ExperimentsUpdateExposureSQLModelV2RequestDataType::EXPOSURE_SQL_MODELS,
  }),
})
p api_instance.update_exposure_sql_model("550e8400-e29b-41d4-a716-446655440000", body)

Instructions

First install the library and its dependencies and then save the example to example.rb and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" rb "example.rb"

// Update exposure SQL model returns "OK" response

package main

import (
	"context"
	"encoding/json"
	"fmt"
	"os"

	"github.com/DataDog/datadog-api-client-go/v2/api/datadog"
	"github.com/DataDog/datadog-api-client-go/v2/api/datadogV2"
	"github.com/google/uuid"
)

func main() {
	body := datadogV2.ExperimentsCreateExposureSQLModelV2Request{
		Data: datadogV2.ExperimentsCreateExposureSQLModelV2RequestData{
			Attributes: datadogV2.ExperimentsUpdateExposureSQLModelV2RequestDataAttributes{
				DatePartitionColumn: *datadog.NewNullableString(nil),
				ExperimentColumn:    "experiment_id",
				Name:                "Exposure events",
				Properties: []datadogV2.ExperimentsSQLModelPropertyInput{
					{
						ColumnName:  "country",
						ColumnType:  datadogV2.EXPERIMENTSCREATEEXPOSURESQLMODELV2REQUESTDATAATTRIBUTESITEMSCOLUMNTYPE_STRING.Ptr(),
						Description: *datadog.NewNullableString(nil),
						Name:        "country",
					},
				},
				Sql: "SELECT user_id, experiment_id, variant, exposed_at, country FROM analytics.exposures",
				SubjectTypes: []datadogV2.ExperimentsCreateExposureSQLModelV2RequestDataAttributesSubjectTypesItems{
					{
						ColumnName:    "user_id",
						SubjectTypeId: "550e8400-e29b-41d4-a716-446655440010",
					},
				},
				TimestampColumn: "exposed_at",
				VariantColumn:   "variant",
			},
			Type: datadogV2.EXPERIMENTSUPDATEEXPOSURESQLMODELV2REQUESTDATATYPE_EXPOSURE_SQL_MODELS,
		},
	}
	ctx := datadog.NewDefaultContext(context.Background())
	ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN"))
	configuration := datadog.NewConfiguration()
	apiClient := datadog.NewAPIClient(configuration)
	api := datadogV2.NewExperimentsApi(apiClient)
	resp, r, err := api.UpdateExposureSQLModel(ctx, uuid.MustParse("550e8400-e29b-41d4-a716-446655440000"), body, *datadogV2.NewUpdateExposureSQLModelOptionalParameters())

	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ExperimentsApi.UpdateExposureSQLModel`: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}

	responseContent, _ := json.MarshalIndent(resp, "", "  ")
	fmt.Fprintf(os.Stdout, "Response from `ExperimentsApi.UpdateExposureSQLModel`:\n%s\n", responseContent)
}

Instructions

First install the library and its dependencies and then save the example to main.go and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" go run "main.go"

// Update exposure SQL model returns "OK" response

import com.datadog.api.client.ApiClient;
import com.datadog.api.client.ApiException;
import com.datadog.api.client.v2.api.ExperimentsApi;
import com.datadog.api.client.v2.model.ExperimentsCreateExposureSQLModelV2Request;
import com.datadog.api.client.v2.model.ExperimentsCreateExposureSQLModelV2RequestData;
import com.datadog.api.client.v2.model.ExperimentsCreateExposureSQLModelV2RequestDataAttributesItemsColumnType;
import com.datadog.api.client.v2.model.ExperimentsCreateExposureSQLModelV2RequestDataAttributesSubjectTypesItems;
import com.datadog.api.client.v2.model.ExperimentsSQLModelPropertyInput;
import com.datadog.api.client.v2.model.ExperimentsUpdateExposureSQLModelV2RequestDataAttributes;
import com.datadog.api.client.v2.model.ExperimentsUpdateExposureSQLModelV2RequestDataType;
import com.datadog.api.client.v2.model.ExperimentsUpdateExposureSQLModelV2Response;
import java.util.Collections;
import java.util.UUID;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = ApiClient.getDefaultApiClient();
    defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN"));
    ExperimentsApi apiInstance = new ExperimentsApi(defaultClient);

    ExperimentsCreateExposureSQLModelV2Request body =
        new ExperimentsCreateExposureSQLModelV2Request()
            .data(
                new ExperimentsCreateExposureSQLModelV2RequestData()
                    .attributes(
                        new ExperimentsUpdateExposureSQLModelV2RequestDataAttributes()
                            .datePartitionColumn(null)
                            .experimentColumn("experiment_id")
                            .name("Exposure events")
                            .properties(
                                Collections.singletonList(
                                    new ExperimentsSQLModelPropertyInput()
                                        .columnName("country")
                                        .columnType(
                                            ExperimentsCreateExposureSQLModelV2RequestDataAttributesItemsColumnType
                                                .STRING)
                                        .description(null)
                                        .name("country")))
                            .sql(
                                "SELECT user_id, experiment_id, variant, exposed_at, country FROM"
                                    + " analytics.exposures")
                            .subjectTypes(
                                Collections.singletonList(
                                    new ExperimentsCreateExposureSQLModelV2RequestDataAttributesSubjectTypesItems()
                                        .columnName("user_id")
                                        .subjectTypeId("550e8400-e29b-41d4-a716-446655440010")))
                            .timestampColumn("exposed_at")
                            .variantColumn("variant"))
                    .type(ExperimentsUpdateExposureSQLModelV2RequestDataType.EXPOSURE_SQL_MODELS));

    try {
      ExperimentsUpdateExposureSQLModelV2Response result =
          apiInstance.updateExposureSQLModel(
              UUID.fromString("550e8400-e29b-41d4-a716-446655440000"), body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling ExperimentsApi#updateExposureSQLModel");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Instructions

First install the library and its dependencies and then save the example to Example.java and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_BEARER_TOKEN="<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" java "Example.java"

// Update exposure SQL model returns "OK" response
use datadog_api_client::datadog;
use datadog_api_client::datadogV2::api_experiments::ExperimentsAPI;
use datadog_api_client::datadogV2::api_experiments::UpdateExposureSQLModelOptionalParams;
use datadog_api_client::datadogV2::model::ExperimentsCreateExposureSQLModelV2Request;
use datadog_api_client::datadogV2::model::ExperimentsCreateExposureSQLModelV2RequestData;
use datadog_api_client::datadogV2::model::ExperimentsCreateExposureSQLModelV2RequestDataAttributesItemsColumnType;
use datadog_api_client::datadogV2::model::ExperimentsCreateExposureSQLModelV2RequestDataAttributesSubjectTypesItems;
use datadog_api_client::datadogV2::model::ExperimentsSQLModelPropertyInput;
use datadog_api_client::datadogV2::model::ExperimentsUpdateExposureSQLModelV2RequestDataAttributes;
use datadog_api_client::datadogV2::model::ExperimentsUpdateExposureSQLModelV2RequestDataType;
use uuid::Uuid;

#[tokio::main]
async fn main() {
    let body =
        ExperimentsCreateExposureSQLModelV2Request::new(
            ExperimentsCreateExposureSQLModelV2RequestData::new(
                ExperimentsUpdateExposureSQLModelV2RequestDataAttributes::new(
                    "experiment_id".to_string(),
                    "Exposure events".to_string(),
                    "SELECT user_id, experiment_id, variant, exposed_at, country FROM analytics.exposures".to_string(),
                    vec![
                        ExperimentsCreateExposureSQLModelV2RequestDataAttributesSubjectTypesItems::new(
                            "user_id".to_string(),
                            "550e8400-e29b-41d4-a716-446655440010".to_string(),
                        )
                    ],
                    "exposed_at".to_string(),
                    "variant".to_string(),
                )
                    .date_partition_column(None)
                    .properties(
                        vec![
                            ExperimentsSQLModelPropertyInput::new("country".to_string(), "country".to_string())
                                .column_type(
                                    ExperimentsCreateExposureSQLModelV2RequestDataAttributesItemsColumnType::STRING,
                                )
                                .description(None)
                        ],
                    ),
                ExperimentsUpdateExposureSQLModelV2RequestDataType::EXPOSURE_SQL_MODELS,
            ),
        );
    let configuration = datadog::Configuration::new();
    let api = ExperimentsAPI::with_config(configuration);
    let resp = api
        .update_exposure_sql_model(
            Uuid::parse_str("550e8400-e29b-41d4-a716-446655440000").expect("invalid UUID"),
            body,
            UpdateExposureSQLModelOptionalParams::default(),
        )
        .await;
    if let Ok(value) = resp {
        println!("{:#?}", value);
    } else {
        println!("{:#?}", resp.unwrap_err());
    }
}

Instructions

First install the library and its dependencies and then save the example to src/main.rs and run following commands:

    DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comap2.datadoghq.comuk1.datadoghq.comddog-gov.comus2.ddog-gov.com" DD_API_KEY="<DD_API_KEY>" DD_APP_KEY="<DD_APP_KEY>" cargo run

Update exposure SQL model

Overview

Arguments

Path Parameters

Query Strings

Request

Body Data (required)

Response

Code Example

Update exposure SQL model

Update exposure SQL model

Instructions

Update exposure SQL model

Instructions

Update exposure SQL model

Instructions

Update exposure SQL model

Instructions

Update exposure SQL model

Instructions

How can I help you today?