Skip to content
Console(opens in a new tab)

ListMaterialization

A materialization is one run of a list that produces an output file.

Selection. This type is a selection. An intent returns it, and you choose which of its fields come back.

A materialization is one run of a list that produces an output file. It keeps a copy of the list settings from the time it starts, so later changes to the list do not affect it. Use status and progressPercentComplete to follow the run.

No connection leads here from a primary entity.

Field Type Description
id ID! The ID of the materialization.
listId ID! The ID of the list that the materialization runs.
customerId ID! The ID of the organization that owns the materialization.
workspaceId ID The ID of the workspace that the materialization belongs to. The value is null when the materialization has no workspace.
createdTimestamp DateTime! The date and time when the materialization was created.
status String! The state of the run. The values are CREATED, IN_PROGRESS, PAUSED, COMPLETED, FAILED, and CANCELED. A run that pauses for insufficient credits resumes when the organization has credits again.
updatedTimestamp DateTime! The date and time of the last change to the state of the materialization.
searchInput ListSearchInput The search settings of the list, as they were when the materialization started.
fieldAliases [FieldAlias] The new names for fields of the list query, as they were when the materialization started.
columnOrdering [String] The order of the output columns, as it was when the materialization started.
columnCounts [ColumnCount] The connection fields of the list query that have a first argument, as they were when the materialization started.
columnMapping [ColumnMapping] The input file columns and their search fields, as they were when the materialization started.
inputFileUri String The reference to the uploaded input file, as it was when the materialization started.
listType ListType The type of the list that this materialization runs. The API does not fill this field today, so it is always null. Read listType on the list instead. One of LIST_GENERATION, ENRICHMENT.
resourceUri String The reference to the output file of the materialization. The value ends with the ID of the output file.
progressPercentComplete Int The percentage of the run that is complete, from 0 to 100. A completed materialization shows 100.
progressMessage String A short message about the progress of the run. For example, a run that pauses for insufficient credits shows Insufficient credits. in this field.

Each one is a connection: read it through edges { node { … } }, page it with first, and narrow it with conditions.

Field Leads to Description
metrics ListMaterializationMetric Statistics about the output of the materialization, such as the row count, newest first.
billingEventDetails ListMaterializationBillingEventDetail The billing records of the materialization. Each record counts billable units for one pricing tier and entity type, or for one data product and disposition.
query {
lists {
edges { node {
materializations(first: 1) {
edges { node {
id
listId
customerId
workspaceId
createdTimestamp
} }
}
} }
}
}

Response, as returned:

{
"data": {
"lists": {
"edges": [
{
"node": {
"materializations": {
"edges": [
{
"node": {
"id": "00000000-0000-4000-8000-000000000001",
"listId": "00000000-0000-4000-8000-000000000002",
"customerId": "00000000-0000-4000-8000-000000000003",
"workspaceId": "00000000-0000-4000-8000-000000000004",
"createdTimestamp": "2025-06-13T14:48:24.055884"
}
}
]
}
}
},
{
"node": {
"materializations": {
"edges": [
{
"node": {
"id": "00000000-0000-4000-8000-000000000005",
"listId": "00000000-0000-4000-8000-000000000006",
"customerId": "00000000-0000-4000-8000-000000000003",
"workspaceId": "00000000-0000-4000-8000-000000000004",
"createdTimestamp": "2025-06-16T17:37:37.907757"
}
}
]
}
}
},
{
"node": {
…
}