Amazon Pinpoint · Schema

EventDimensions

Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name Type Description
Attributes object
EventType object
Metrics object
View JSON Schema on GitHub

JSON Schema

amazon-pinpoint-event-dimensions-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-schema/amazon-pinpoint-event-dimensions-schema.json",
  "title": "EventDimensions",
  "description": "Specifies the dimensions for an event filter that determines when a campaign is sent or a journey activity is performed.",
  "type": "object",
  "properties": {
    "Attributes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfAttributeDimension"
        },
        {
          "description": "One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter."
        }
      ]
    },
    "EventType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SetDimension"
        },
        {
          "description": "The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see <a href=\"https://docs.aws.amazon.com/pinpoint/latest/developerguide/event-streams.html\">Streaming Amazon Pinpoint Events</a> in the <i>Amazon Pinpoint Developer Guide</i>."
        }
      ]
    },
    "Metrics": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOfMetricDimension"
        },
        {
          "description": "One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter."
        }
      ]
    }
  }
}