--- title: Get metric SQL model description: Get a metric SQL model. Returns a single model by its ID for the organization, including its subject types, measures and properties. breadcrumbs: 문서 > API > Get metric SQL model --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Get metric SQL model {% callout %} This product or feature is not supported for the following sites: app.ddog-gov.com, us2.ddog-gov.com {% /callout %} ## v2 (latest) | Datadog site | API endpoint | | ----------------- | -------------------------------------------------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/experiments/metric-sql-models/{metric_sql_model_id} | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/experiments/metric-sql-models/{metric_sql_model_id} | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/experiments/metric-sql-models/{metric_sql_model_id} | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/experiments/metric-sql-models/{metric_sql_model_id} | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/experiments/metric-sql-models/{metric_sql_model_id} | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/experiments/metric-sql-models/{metric_sql_model_id} | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/experiments/metric-sql-models/{metric_sql_model_id} | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/experiments/metric-sql-models/{metric_sql_model_id} | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/experiments/metric-sql-models/{metric_sql_model_id} | ### Overview Get a metric SQL model. Returns a single model by its ID for the organization, including its subject types, measures and properties. This endpoint requires the `product_analytics_metrics_read` permission. OAuth apps require the `product_analytics_metrics_read` authorization [scope](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/ko/api/latest/scopes.md#experiments) to access this endpoint. ### Arguments #### Path Parameters | Field | Type | Description | | -------------------------------- | ------ | --------------------------------- | | metric_sql_model_id [*required*] | string | The UUID of the metric SQL model. | #### Query Strings | Field | Type | Description | | ------- | ----- | ----------------------------------------------------------------------------------------------------------------------------- | | include | array | Optional fields to include. Repeat this parameter to request several fields. `counts` adds metric_count and experiment_count. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response containing the metric SQL model. | Parent field | Field | Type | Description | | ------------- | ------------------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------- | | | data [*required*] | object | JSON:API resource containing the metric SQL model identity and fields. | | data | attributes | object | Details of the metric SQL model. | | attributes | certified_at | date-time | Time when this resource was certified. | | attributes | created_at | date-time | Time when this resource was created. | | attributes | date_partition_column | string | SQL column used to partition the source data by date. | | attributes | description | string | Text that explains the metric SQL model. | | attributes | event_count_measure_id | string | Read-only measure ID. Pass it as warehouse_metric_measure.id when the metric operation is count. | | attributes | experiment_count | int64 | Number of experiments that reference this resource. | | attributes | is_certified | boolean | Whether this resource has been certified. | | attributes | measures | [object] | Measures available from the SQL model's result columns. | | measures | column_name | string | Name of the SQL result column that supplies this measure. | | measures | column_type | enum | Data type of a column in the SQL model. Allowed enum values: `STRING`, `INTEGER`, `FLOAT`, `BOOLEAN`, `DATE`, `TIMESTAMP`. | | measures | description | string | Text that explains the measure. | | measures | id | string | ID of the measure. | | measures | migration_metadata | any | Metadata retained for resources imported from another system. | | measures | name | string | Display name of the measure. | | attributes | metric_count | int64 | Number of metrics that use this SQL model. | | attributes | migration_metadata | any | Metadata retained for resources imported from another system. | | attributes | name | string | Display name of the metric SQL model. | | attributes | properties | [object] | Property columns exposed by the SQL model. | | properties | column_name | string | Name of the SQL result column that supplies this measure. | | 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 | Text that explains the measure. | | properties | id | string | ID of the measure. | | properties | migration_metadata | any | Metadata retained for resources imported from another system. | | properties | name | string | Display name of the measure. | | attributes | sql | string | SQL query that produces the model's source data. | | attributes | subject_types | [object] | Subject types mapped to columns in the SQL model. | | subject_types | column_name | string | Name of the SQL result column that identifies subjects of this type. | | subject_types | subject_type_id | string | ID of the subject type used by this configuration. | | subject_types | unique_subject_count_measure_id | string | Read-only measure ID. Pass it as warehouse_metric_measure.id when the metric operation is `uniqueSubjects`. | | attributes | timestamp_column | string | SQL column that supplies the event timestamp. | | attributes | updated_at | date-time | Time when this resource was last updated. | | data | id [*required*] | uuid | ID of the metric SQL model. | | data | type [*required*] | enum | Metric SQL models resource type. Allowed enum values: `metric-sql-models`. Default: `metric-sql-models`. | {% /tab %} {% tab label="Example" %} ```json { "data": { "attributes": { "created_at": "2024-01-01T12:00:00Z", "event_count_measure_id": "550e8400-e29b-41d4-a716-446655440024", "is_certified": false, "measures": [ { "column_name": "revenue", "column_type": "FLOAT", "id": "550e8400-e29b-41d4-a716-446655440021", "name": "revenue" } ], "name": "Order facts", "properties": [ { "column_name": "item_type", "column_type": "STRING", "id": "550e8400-e29b-41d4-a716-446655440023", "name": "item_type" } ], "sql": "SELECT user_id, order_id, item_type, revenue, created_at FROM analytics.orders", "subject_types": [ { "column_name": "user_id", "subject_type_id": "550e8400-e29b-41d4-a716-446655440010", "unique_subject_count_measure_id": "550e8400-e29b-41d4-a716-446655440022" } ], "timestamp_column": "created_at", "updated_at": "2024-01-01T12:00:00Z" }, "id": "550e8400-e29b-41d4-a716-446655440020", "type": "metric-sql-models" } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Malformed metric SQL model ID (not a valid UUID), or unknown include value. {% tabs %} {% tab label="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 label="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 %} {% /tabs %} {% /tab %} {% tab label="401" %} Missing or invalid authentication. {% tabs %} {% tab label="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 label="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 %} {% /tabs %} {% /tab %} {% tab label="403" %} Authenticated caller lacks the product_analytics_metrics_read permission. {% tabs %} {% tab label="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 label="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 %} {% /tabs %} {% /tab %} {% tab label="404" %} No metric SQL model with this ID exists for the organization. {% tabs %} {% tab label="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 label="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 %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Path parameters export metric_sql_model_id="550e8400-e29b-41d4-a716-446655440000" # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/experiments/metric-sql-models/${metric_sql_model_id}" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get metric 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() { 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.GetMetricSQLModel(ctx, uuid.MustParse("550e8400-e29b-41d4-a716-446655440000"), *datadogV2.NewGetMetricSQLModelOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `ExperimentsApi.GetMetricSQLModel`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `ExperimentsApi.GetMetricSQLModel`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Get metric 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.ExperimentsMetricSQLModelV2DTO; 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); try { ExperimentsMetricSQLModelV2DTO result = apiInstance.getMetricSQLModel(UUID.fromString("550e8400-e29b-41d4-a716-446655440000")); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling ExperimentsApi#getMetricSQLModel"); 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](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Get metric 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 uuid import UUID configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = ExperimentsApi(api_client) response = api_instance.get_metric_sql_model( metric_sql_model_id=UUID("550e8400-e29b-41d4-a716-446655440000"), ) print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Get metric 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 p api_instance.get_metric_sql_model("550e8400-e29b-41d4-a716-446655440000") ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Get metric 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::GetMetricSQLModelOptionalParams; use uuid::Uuid; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = ExperimentsAPI::with_config(configuration); let resp = api .get_metric_sql_model( Uuid::parse_str("550e8400-e29b-41d4-a716-446655440000").expect("invalid UUID"), GetMetricSQLModelOptionalParams::default(), ) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% /tabs %}