analytics Schemas
Requires access scope.
Returns the list of available analytics schemas with their dimensions and metrics.
Arguments
- names ([String!])
- Anchor to namesnames•[String!]
Filter schemas by name. When omitted, returns all schemas.
Anchor to Possible returnsPossible returns
- AnalyticsSchema ([AnalyticsSchema!])
- Anchor to AnalyticsSchemaAnalytics•[Analytics
Schema Schema!] A data schema with its dimensions and metrics from the analytics service.
- Anchor to attributionSchemaNameattribution•String
Schema Name The name of the attribution schema if attribution is configured.
- Anchor to deprecateddeprecated•Analytics
Schema Deprecation Deprecation metadata for this schema, if it has been deprecated.
- Anchor to descriptiondescription•String!non-null
A description of what this schema represents.
- Anchor to dimensionsdimensions•[Analytics
Schema Field!]! non-null The dimensions (groupable fields) available in this schema.
- Anchor to matchablesmatchables•[Analytics
Schema Matchable Join!]! non-null Other schemas that can be used with MATCHES for this schema.
- Anchor to metricsmetrics•[Analytics
Schema Field!]! non-null The metrics (aggregatable fields) available in this schema.
- Anchor to multistoremultistore•Analytics
Schema Multistore Config Multi-store configuration for this schema.
- Anchor to namename•String!non-null
The name of the schema.
- Anchor to potentialUsespotential•[String!]!
Uses non-null Potential use cases for this schema.
- Anchor to primaryKeyprimary•String!
Key non-null The primary key field for this schema.
- Anchor to supportsMultiFactQueriessupports•Boolean
Multi Fact Queries Whether this schema can be selected with other schemas in a query.
- Anchor to tierAvailabilitytier•[Analytics
Availability Schema Tier Availability!]! non-null A list of tiers for the schema, controlling access to certain fields based on a date range.