GET https://api.ap1.datadoghq.com/api/v2/experiments/metric-sql-models https://api.ap2.datadoghq.com/api/v2/experiments/metric-sql-models https://api.datadoghq.eu/api/v2/experiments/metric-sql-models https://api.ddog-gov.com/api/v2/experiments/metric-sql-models https://api.us2.ddog-gov.com/api/v2/experiments/metric-sql-models https://api.uk1.datadoghq.com/api/v2/experiments/metric-sql-models https://api.datadoghq.com/api/v2/experiments/metric-sql-models https://api.us3.datadoghq.com/api/v2/experiments/metric-sql-models https://api.us5.datadoghq.com/api/v2/experiments/metric-sql-models
Overview List metric SQL models. Returns a paginated list of the SQL models that metrics are defined on for the organization.
This endpoint requires the product_analytics_metrics_read permission.
OAuth apps require the product_analytics_metrics_read authorization scope to access this endpoint.
Arguments Query Strings Optional fields to include. Repeat this parameter to request several fields. counts adds metric_count
and experiment_count, which cost an extra aggregate query.
Maximum number of results to return. Defaults to 25 when omitted, and is capped at 50 (larger values are clamped to 50). The response includes meta.page (with total) and pagination links.
Number of results to skip for pagination. Defaults to 0 when omitted.
Sort field: name, created_at, updated_at, metric_count, or experiment_count. A single field only; a
comma-separated list is rejected. Prefix with - for descending (for example, -created_at). Defaults to
created_at descending.
Response OK
List of metric SQL model resources with pagination information.
Expand All
Resources returned in this response.
Details of the metric SQL model.
Time when this resource was certified.
Time when this resource was created.
SQL column used to partition the source data by date.
Text that explains the metric SQL model.
Read-only measure ID. Pass it as warehouse_metric_measure.id when the metric operation is count.
Number of experiments that reference this resource.
Whether this resource has been certified.
Measures available from the SQL model's result columns.
Name of the SQL result column that supplies this measure.
Data type of a column in the SQL model.
Allowed enum values: STRING,INTEGER,FLOAT,BOOLEAN,DATE,TIMESTAMP
Text that explains the measure.
Metadata retained for resources imported from another system.
Display name of the measure.
Number of metrics that use this SQL model.
Metadata retained for resources imported from another system.
Display name of the metric SQL model.
Property columns exposed by the SQL model.
Name of the SQL result column that supplies this measure.
Data type of a column in the SQL model.
Allowed enum values: STRING,INTEGER,FLOAT,BOOLEAN,DATE,TIMESTAMP
Text that explains the measure.
Metadata retained for resources imported from another system.
Display name of the measure.
SQL query that produces the model's source data.
Subject types mapped to columns in the SQL model.
Name of the SQL result column that identifies subjects of this type.
ID of the subject type used by this configuration.
unique_subject_count_measure_id
Read-only measure ID. Pass it as warehouse_metric_measure.id when the metric operation is uniqueSubjects.
SQL column that supplies the event timestamp.
Time when this resource was last updated.
ID of the metric SQL model.
Metric SQL models resource type.
Allowed enum values: metric-sql-models
default: metric-sql-models
Links for navigating a paginated result set.
URL of the first page of results.
URL of the last page of results.
URL of the next page of results.
URL of the previous page of results.
URL of the current page of results.
Pagination information for a list response.
Result counts and offsets for a page of results.
Offset of the first page of results.
Offset of the last page of results.
Maximum number of results returned in one page.
Offset of the next page of results.
Number of results skipped before this page.
Offset of the previous page of results.
Total number of matching results across all pages.
Pagination method used for this result set.
{
"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"
}
]
} Invalid query parameter: bad page[offset]/page[limit], unknown sort field, or unknown include value.
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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 (dd-api-key + dd-application-key headers, or a valid user session).
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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_metrics_read permission.
API error response.
Expand All
A human-readable explanation specific to this occurrence of the error.
Non-standard meta-information about the error
References to the source of the error.
A string indicating the name of a single request header which caused the error.
A string indicating which URI query parameter caused the error.
A JSON pointer to the value in the request document that caused the error.
Status code of the response.
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
{
"errors" : [
"Bad Request"
]
} Code Example Copy
# Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN = "<PERSONAL_ACCESS_TOKEN OR SERVICE_ACCESS_TOKEN>" # Curl command curl -X GET "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 " \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN} " 
