Returns a single blend by ID, including all active data sources.
Bearer token authentication. Include the token in the Authorization header:
Authorization: Bearer <your-token>
ID of the team
ID of the blend to retrieve
Blend retrieved successfully
{
"meta": {
"request_id": "RWmTkuYcXdfdjvA7xaDnusTYu8u8AMXG"
},
"data": {
"blend_id": 569,
"blend_uuid": "71bc0582-31b5-11f1-a55c-4201ac182030",
"type": "join",
"display_name": "Example Blend",
"description": "Example blend description",
"modified_time_utc": "2026-04-07T10:00:00Z",
"last_modify_user_email": "user@supermetrics.com",
"blended_data_sources": {
"items": [
{
"blend_data_source_id": 1,
"blend_id": 569,
"data_source_id": "GA4",
"display_name": "Google Analytics 4",
"accounts": {
"items": []
},
"segments": {
"items": []
},
"data_source_settings": {
"items": []
},
"report_type_settings": {
"items": []
}
},
{
"blend_data_source_id": 2,
"blend_id": 569,
"data_source_id": "GADS",
"display_name": "Google Ads",
"accounts": {
"items": []
},
"segments": {
"items": []
},
"data_source_settings": {
"items": []
},
"report_type_settings": {
"items": []
}
}
]
},
"config": {
"query_table": {
"blend_data_source_id": 1
},
"joins": {
"items": [
{
"join_table": {
"blend_data_source_id": 2
},
"type": "left",
"conditions": {
"items": [
{
"operator": "=",
"left": {
"blend_data_source_id": 1,
"datasource_field_name": "Date",
"datasource_field_display_name": "Date",
"datasource_field_type": "dim",
"datasource_field_data_type": "string.time.date",
"field_source": "standard",
"meta": null
},
"right": {
"blend_data_source_id": 2,
"datasource_field_name": "Date",
"datasource_field_display_name": "Date",
"datasource_field_type": "dim",
"datasource_field_data_type": "string.time.date",
"field_source": "standard",
"meta": null
}
}
]
}
}
]
},
"fields": {
"items": [
{
"blend_field_name": "impressions",
"blend_field_display_name": "Impressions",
"blend_field_type": "met",
"blend_field_data_type": "int.number.value",
"blend_datasource_fields": {
"items": [
{
"blend_data_source_id": 1,
"datasource_field_name": "Impressions",
"datasource_field_display_name": "Impressions",
"datasource_field_type": "met",
"datasource_field_data_type": "int.number.value",
"field_source": "standard",
"meta": null
}
]
}
}
]
}
}
}
}Success envelope wrapping a single blend.
Metadata included in every API response.
Unique identifier for the request, for tracking and debugging.
A blend with its fields and data sources, as returned for a single-blend read.
Blend ID.
Blend UUID.
Blend type.
Display name of the blend.
Description of the blend.
Timestamp of the last modification, in UTC. Serialized with a numeric offset (e.g. "+0000") rather than a trailing "Z".
Email of the user who last modified the blend.
Data sources included in this blend.
Data source items.
A data source included in the blend response, with field mappings and account details.
Internal ID of the blended data source.
ID of the blend this data source belongs to.
Data source identifier.
Display name of the data source.
Settings applied when querying this data source.
Setting items.
A single data source setting.
Accounts queried from this data source.
Account items.
An account queried from this data source.
Segments applied when querying this data source.
Segment items.
A segment applied when querying this data source.
Report type ID.
Settings for the selected report type.
Report type setting items.
A single setting for the selected report type.
Data source logo URL.
Field mappings and join configuration for the blend (response). Union blends contain only fields; join blends also include query_table and joins.
Primary (left-hand) data source — present for join blends only.
Internal ID of the primary data source.
Join definitions — present for join blends only.
Join items.
Join definition between two data sources (response).
Data source joined with the primary table.
Internal ID of the data source to join.
Join type.
Conditions that define how the two data sources are joined.
Condition items.
A condition comparing one field from each data source (response).
Comparison operator.
Field from the primary table.
Internal ID of the blended data source.
Field name as defined by the data source.
Display name of the field.
Field type: dim (dimension) or met (metric).
Data type of the field (e.g. string.time.date, int.number.value).
Origin of the field: standard = from the data source, transformation = computed field, data_source_account_custom = account-level custom field.
Optional metadata, e.g. account-level overrides.
Field from the join table.
Internal ID of the blended data source.
Field name as defined by the data source.
Display name of the field.
Field type: dim (dimension) or met (metric).
Data type of the field (e.g. string.time.date, int.number.value).
Origin of the field: standard = from the data source, transformation = computed field, data_source_account_custom = account-level custom field.
Optional metadata, e.g. account-level overrides.
Field definitions for the blend.
Field items.
A blend field and its mapping to fields in each data source (response).
Unique name of the blend field — cannot be changed once created.
Display name of the blend field.
Field type: dim (dimension) or met (metric).
Data type of the field (e.g. string.time.date, int.number.value).
Per-data-source field mappings for this blend field.
Datasource field items.
A field reference within a data source (response).
Internal ID of the blended data source.
Field name as defined by the data source.
Display name of the field.
Field type: dim (dimension) or met (metric).
Data type of the field (e.g. string.time.date, int.number.value).
Origin of the field: standard = from the data source, transformation = computed field, data_source_account_custom = account-level custom field.
Optional metadata, e.g. account-level overrides.
Bad request - invalid parameters
{
"meta": {
"request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
},
"error": {
"code": "BAD_REQUEST",
"message": "The request was invalid."
}
}Standard envelope returned by all error (4xx/5xx) responses.
Metadata included in every API response.
Unique identifier for the request, for tracking and debugging.
Machine- and human-readable detail for a failed request.
Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on message. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.
Short, human-readable summary of the error.
Optional longer explanation specific to this occurrence.
Unauthorized
{
"meta": {
"request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
},
"error": {
"code": "UNAUTHORIZED",
"message": "Authentication is required."
}
}Standard envelope returned by all error (4xx/5xx) responses.
Metadata included in every API response.
Unique identifier for the request, for tracking and debugging.
Machine- and human-readable detail for a failed request.
Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on message. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.
Short, human-readable summary of the error.
Optional longer explanation specific to this occurrence.
Access forbidden
{
"meta": {
"request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
},
"error": {
"code": "FORBIDDEN",
"message": "You do not have access to this resource."
}
}Standard envelope returned by all error (4xx/5xx) responses.
Metadata included in every API response.
Unique identifier for the request, for tracking and debugging.
Machine- and human-readable detail for a failed request.
Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on message. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.
Short, human-readable summary of the error.
Optional longer explanation specific to this occurrence.
Blend not found
Not found
NOT_FOUND
Too Many Requests
{
"meta": {
"request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
},
"error": {
"code": "TOO_MANY_REQUESTS",
"message": "Rate limit exceeded. Retry later."
}
}Standard envelope returned by all error (4xx/5xx) responses.
Metadata included in every API response.
Unique identifier for the request, for tracking and debugging.
Machine- and human-readable detail for a failed request.
Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on message. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.
Short, human-readable summary of the error.
Optional longer explanation specific to this occurrence.
Internal server error
{
"meta": {
"request_id": "BXaEFVtjc7TXaJxgZhmFgSUD9edqq_CN"
},
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred."
}
}Standard envelope returned by all error (4xx/5xx) responses.
Metadata included in every API response.
Unique identifier for the request, for tracking and debugging.
Machine- and human-readable detail for a failed request.
Stable, screaming-snake-case identifier for the error condition. Clients should branch on this, not on message. Common values include BAD_REQUEST, UNAUTHORIZED, FORBIDDEN, NOT_FOUND, CONFLICT_ERROR, PERMISSION_ERROR, UNPROCESSABLE_ENTITY, UNPROCESSABLE_CONTENT, TOO_MANY_REQUESTS, INTERNAL_SERVER_ERROR, DUPLICATION_FAILED, SERVICE_UNAVAILABLE; domains may define additional codes.
Short, human-readable summary of the error.
Optional longer explanation specific to this occurrence.