Update metric SQL model

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

Overview

Replace a metric SQL model. This is a destructive full replace: subject types, customer-defined measures, and properties absent from the body are deleted, so send the complete set. Properties are matched by name; changing a property’s column, type, or description preserves its ID. column_type is required for every measure and property. Removing a measure or property that an active metric references returns 409 Conflict. Server-generated IDs returned by GET are read-only and can be left in a replayed body. The response reports removals in meta.deleted_subject_types, meta.deleted_measures, and meta.deleted_properties. Certification is read-only. Certified models cannot be replaced through this endpoint. 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

Request

Body Data (required)

{
  "data": {
    "attributes": {
      "date_partition_column": null,
      "description": null,
      "measures": [
        {
          "column_name": "revenue",
          "column_type": "STRING",
          "description": null,
          "migration_metadata": "undefined",
          "name": null
        }
      ],
      "migration_metadata": "undefined",
      "name": "Order facts",
      "properties": [
        {
          "column_name": "item_type",
          "column_type": "STRING",
          "description": null,
          "migration_metadata": "undefined",
          "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"
        }
      ],
      "timestamp_column": "created_at"
    },
    "id": "string",
    "type": "metric-sql-models"
  }
}

Response

• 200
• 400
• 401
• 403
• 404
• 409
• 429

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

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

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

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

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

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

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

Code Example

                  ## default
# 

# Path parameters
export metric_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/metric-sql-models/${metric_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,
      "description": null,
      "measures": [
        {
          "column_name": "revenue",
          "column_type": "FLOAT",
          "description": null,
          "name": null
        }
      ],
      "name": "Order facts",
      "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"
        }
      ],
      "timestamp_column": "created_at"
    },
    "type": "metric-sql-models"
  }
}
EOF