Choose a version:

AnalyticsSchema

object

Requires read_reports access scope.

A data schema with its dimensions and metrics from the analytics service.

Anchor to FieldsFields

Anchor to attributionSchemaNameattributionSchemaName •String: The name of the attribution schema if attribution is configured.
Anchor to deprecateddeprecated •AnalyticsSchemaDeprecation: 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 •[AnalyticsSchemaField!]! non-null: The dimensions (groupable fields) available in this schema.
Anchor to matchablesmatchables •[AnalyticsSchemaMatchableJoin!]! non-null: Other schemas that can be used with MATCHES for this schema.
Anchor to metricsmetrics •[AnalyticsSchemaField!]! non-null: The metrics (aggregatable fields) available in this schema.
Anchor to multistoremultistore •AnalyticsSchemaMultistoreConfig: Multi-store configuration for this schema.
Anchor to namename •String! non-null: The name of the schema.
Anchor to potentialUsespotentialUses •[String!]! non-null: Potential use cases for this schema.
Anchor to primaryKeyprimaryKey •String! non-null: The primary key field for this schema.
Anchor to supportsMultiFactQueriessupportsMultiFactQueries •Boolean: Whether this schema can be selected with other schemas in a query.
Anchor to tierAvailabilitytierAvailability •[AnalyticsSchemaTierAvailability!]! non-null: A list of tiers for the schema, controlling access to certain fields based on a date range.

Was this section helpful?

•query

Returns the list of available analytics schemas with their dimensions and metrics.

Anchor to namesnames •[String!]: Filter schemas by name. When omitted, returns all schemas.

Was this section helpful?