Starting with GraphQL Admin API version 2027-01, you can read and configure the capability on metaobject definitions. This applies to apps that create, update, or inspect metaobject definitions. No action is required unless you want your app to control whether a metaobject definition can be queried in analytics.
What changed
The GraphQL Admin API now exposes the analytics queryable capability for metaobject definitions.
You can read , which includes:
eligible: whether the metaobject definition can use the capability. A definition is eligible if at least one of its fields uses an analytics-compatible type.enabled: whether the capability is currently enabled.
You can also set the capability when you create or update a metaobject definition by using:
The enum now includes ANALYTICS_QUERYABLE, and includes CAPABILITY_NOT_ELIGIBLE for definitions that can’t enable the capability.
Who's affected
This change applies to apps that use GraphQL Admin API version 2027-01 or later to create, update, or inspect metaobject definitions.
Apps that use earlier versions don’t see the field, input, enum value, or error code. Existing apps don’t need to make changes unless they want to support analytics queryability for metaobject definitions.
Why this matters
You can now determine whether a metaobject definition is eligible to be queried in analytics and enable that capability through the public GraphQL Admin API. This brings metaobject definitions in line with metafield definitions, and you get consistent control over which custom data types appear in analytics.
What to do
No action is required.
If you want to use this capability:
- Update your app to use GraphQL Admin API version
2027-01or later. - Update your metaobject definition queries or mutations to include
.
For example, to read a metaobject definition’s capabilities, include:
capabilities {
analyticsQueryable {
eligible
enabled
}
}When you create or update a metaobject definition, set in the capability input. Check eligible first, and handle CAPABILITY_NOT_ELIGIBLE in mutation user errors. Use this method to confirm whether a definition supports the capability and give clear feedback when it doesn't.