ActivityResponse

Provides information about an activity that was performed by a campaign.

CampaignsCommunicationsEmailMarketingMessagingPush NotificationsSMSVoiceCustomer EngagementSegmentationJourneysAnalytics

Properties

Name	Type	Description
ApplicationId	object
CampaignId	object
End	object
Id	object
Result	object
ScheduledStart	object
Start	object
State	object
SuccessfulEndpointCount	object
TimezonesCompletedCount	object
TimezonesTotalCount	object
TotalEndpointCount	object
TreatmentId	object

View JSON Schema on GitHub

JSON Schema

{
  "$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-activity-response-schema.json",
  "title": "ActivityResponse",
  "description": "Provides information about an activity that was performed by a campaign.",
  "type": "object",
  "properties": {
    "ApplicationId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the application that the campaign applies to."
        }
      ]
    },
    "CampaignId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the campaign that the activity applies to."
        }
      ]
    },
    "End": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED."
        }
      ]
    },
    "Id": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the activity."
        }
      ]
    },
    "Result": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL."
        }
      ]
    },
    "ScheduledStart": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The scheduled start time, in ISO 8601 format, for the activity."
        }
      ]
    },
    "Start": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The actual start time, in ISO 8601 format, of the activity."
        }
      ]
    },
    "State": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED."
        }
      ]
    },
    "SuccessfulEndpointCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The total number of endpoints that the campaign successfully delivered messages to."
        }
      ]
    },
    "TimezonesCompletedCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The total number of time zones that were completed."
        }
      ]
    },
    "TimezonesTotalCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The total number of unique time zones that are in the segment for the campaign."
        }
      ]
    },
    "TotalEndpointCount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__integer"
        },
        {
          "description": "The total number of endpoints that the campaign attempted to deliver messages to."
        }
      ]
    },
    "TreatmentId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/__string"
        },
        {
          "description": "The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign."
        }
      ]
    }
  },
  "required": [
    "CampaignId",
    "Id",
    "ApplicationId"
  ]
}