AnalyticsAnnotationCreatePayload

The newly created analytics annotation.

The list of errors that occurred from executing the mutation.

Creates an analytics annotation on the shop. Annotations are notable events that can be overlaid on analytics charts to provide context for changes in metrics. The annotation is attributed to the app that calls the mutation.

Shopify limits how many annotations an app can have for a shop. If the app reaches this limit, then the mutation returns a LIMIT_REACHED error. Delete existing annotations or contact Shopify Support to request a higher limit.

Use analyticsAnnotationUpdate to modify existing annotations or analyticsAnnotationDelete to remove them.

The type field must specify a supported type for app-created annotations. Refer to the list of supported types.