Amazon Pinpoint · JSON Structure

Amazon Pinpoint Journey Execution Metrics Response Structure

Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.

Type: object Properties: 4 Required: 4
CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

JourneyExecutionMetricsResponse is a JSON Structure definition published by Amazon Pinpoint, describing 4 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ApplicationId JourneyId LastEvaluatedTime Metrics

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-pinpoint/refs/heads/main/json-structure/amazon-pinpoint-journey-execution-metrics-response-structure.json",
  "name": "JourneyExecutionMetricsResponse",
  "description": "Provides the results of a query that retrieved the data for a standard execution metric that applies to a journey, and provides information about that query.",
  "type": "object",
  "properties": {
    "ApplicationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the application that the metric applies to."
        }
      ]
    },
    "JourneyId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the journey that the metric applies to."
        }
      ]
    },
    "LastEvaluatedTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric."
        }
      ]
    },
    "Metrics": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MapOf__string"
        },
        {
          "description": "A JSON object that contains the results of the query. For information about the structure and contents of the results, see the <a href=\"https://docs.aws.amazon.com//pinpoint/latest/developerguide/analytics-standard-metrics.html\">Amazon Pinpoint Developer Guide</a>."
        }
      ]
    }
  },
  "required": [
    "Metrics",
    "JourneyId",
    "LastEvaluatedTime",
    "ApplicationId"
  ]
}