Analytics
Requires access scope.
A dimension or metric field in an analytics schema.
Anchor to FieldsFields
- aggregationType (AnalyticsSchemaFieldAggregationType!)
- benchmarkable (Boolean!)
- benchmarkableFilter (Boolean!)
- category (AnalyticsSchemaFieldCategory!)
- categoryDescription (String!)
- categoryDisplayName (String!)
- customerSegmentationFilter (String!)
- deprecated (AnalyticsSchemaDeprecation)
- description (String!)
- displayName (String!)
- entityFieldAlias (String)
- entityJoins ([AnalyticsSchemaJoin!]!)
- eventConfig (AnalyticsSchemaEventFieldConfig)
- fieldName (String!)
- fieldType (AnalyticsSchemaFieldDataType!)
- formulaDescription (String!)
- hasAttributionExpression (Boolean!)
- includeCumulative (Boolean!)
- isMetafield (Boolean!)
- join ([AnalyticsSchemaJoin!]!)
- matchesParameterSettings (AnalyticsSchemaMatchParameter)
- metafieldMetadata (AnalyticsSchemaMetafieldMetadata)
- metaobjectMetadata (AnalyticsSchemaMetaobjectMetadata)
- possibleValues ([String!]!)
- possibleValuesTranslations (JSON!)
- potentialUses ([String!]!)
- primary (Boolean!)
- restrictOperatorsTo ([String!]!)
- standardizedFormat (String!)
- subType (AnalyticsSchemaFieldDataType!)
- targetable (Boolean!)
- tiers ([String!]!)
- trendIndicator (AnalyticsSchemaFieldTrendIndicator!)
- userInterfaceHints (AnalyticsSchemaUiHints)
- variants (AnalyticsSchemaFieldVariants)
- Anchor to aggregationTypeaggregation•Analytics
Type Schema Field Aggregation Type! non-null The type of aggregation that this field performs.
- Anchor to benchmarkablebenchmarkable•Boolean!non-null
Whether this field can be benchmarked against other merchants.
- Anchor to benchmarkableFilterbenchmarkable•Boolean!
Filter non-null Whether this field can be used as a benchmarkable filter.
- Anchor to categorycategory•Analytics
Schema Field Category! non-null The category this field belongs to.
- Anchor to categoryDescriptioncategory•String!
Description non-null A description of the category this field belongs to.
- Anchor to categoryDisplayNamecategory•String!
Display Name non-null The display name for the category.
- Anchor to customerSegmentationFiltercustomer•String!
Segmentation Filter non-null Filter expression for customer segmentation.
- Anchor to deprecateddeprecated•Analytics
Schema Deprecation Deprecation metadata for this field, if it has been deprecated.
- Anchor to descriptiondescription•String!non-null
A description of what the field represents.
- Anchor to displayNamedisplay•String!
Name non-null The human-readable display name for the field.
- Anchor to entityFieldAliasentity•String
Field Alias For entity-joined (ENTITY type) dimensions, the alias used to reference this field in dot-notation (e.g.
customer.<alias>). Null for non-entity fields.- Anchor to entityJoinsentity•[Analytics
Joins Schema Join!]! non-null Entity join relationships for ENTITY type dimensions.
- Anchor to eventConfigevent•Analytics
Config Schema Event Field Config Configuration for this field in the context of app events queries.
- Anchor to fieldNamefield•String!
Name non-null The raw name for the field without any schema name prefixes.
- Anchor to fieldTypefield•Analytics
Type Schema Field Data Type! non-null The data type of the field.
- Anchor to formulaDescriptionformula•String!
Description non-null A description of the formula used to calculate this field.
- Anchor to hasAttributionExpressionhas•Boolean!
Attribution Expression non-null Whether this field has an attribution expression.
- Anchor to includeCumulativeinclude•Boolean!
Cumulative non-null Whether this field supports cumulative aggregation.
- Anchor to isMetafieldis•Boolean!
Metafield non-null Whether this field is a metafield.
- Anchor to joinjoin•[Analytics
Schema Join!]! non-null Join relationships for this field.
- Anchor to matchesParameterSettingsmatches•Analytics
Parameter Settings Schema Match Parameter Settings to use when validating this field in a MATCHES statement.
- Anchor to metafieldMetadatametafield•Analytics
Metadata Schema Metafield Metadata Metadata associated with the metafield. Empty if the field isn't a metafield.
- Anchor to metaobjectMetadatametaobject•Analytics
Metadata Schema Metaobject Metadata Metadata associated with a metaobject-backed field.
- Anchor to possibleValuespossible•[String!]!
Values non-null Possible values for this field.
- Anchor to possibleValuesTranslationspossible•JSON!
Values Translations non-null Localized, merchant-facing translations for the field's possible enum values, as a
{ value => translation }map (e.g.{ "paid" => "Paid" }). Empty when the field has no enumerable values.- Anchor to potentialUsespotential•[String!]!
Uses non-null Potential use cases for this field.
- Anchor to primaryprimary•Boolean!non-null
Whether this field is the primary entity of the schema it belongs to.
- Anchor to restrictOperatorsTorestrict•[String!]!
Operators To non-null Restricts which operators can be used with this field in WHERE clauses.
- Anchor to standardizedFormatstandardized•String!
Format non-null The standardized format for displaying this field.
- Anchor to subTypesub•Analytics
Type Schema Field Data Type! non-null The element type for array fields. For non-array fields, this is UNSPECIFIED.
- Anchor to targetabletargetable•Boolean!non-null
Whether this metric can be used as an analytics target.
- Anchor to tierstiers•[String!]!non-null
The tiers that this field is valid for, when the schema defines tier availability.
- Anchor to trendIndicatortrend•Analytics
Indicator Schema Field Trend Indicator! non-null Indicates whether an increase in this field is positive, negative, or neutral.
- Anchor to userInterfaceHintsuser•Analytics
Interface Hints Schema Ui Hints Hints for how to display this field in the UI.
- Anchor to variantsvariants•Analytics
Schema Field Variants Variants of this field for different funnel types.