• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
DeleteCampaign
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
Campaign Activities
A campaign represents a messaging initiative that engages a specific segment of users for an Amazon Pinpoint application. The Campaign Activities resource provides information about the activities that were performed by a campaign, such as the time during which the campaign ran and the number of endpoints that the campaign delivered messages to.
You can use this resource to retrieve information about the activities that were performed by a specific campaign.
URI
/v1/apps/application-id/campaigns/campaign-id/activities
HTTP methods
GET
Operation ID: GetCampaignActivities
Retrieves information about all the activities for a campaign.
Path parameters
Name Type Required Description
application-id String True The unique identifier
for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
campaign-id String True The unique identifier
for the campaign.
HTTP methods
Header parameters
Name Type Required Description
accept String False Indicates which content
types, expressed as MIME types, the client understands.
Query parameters
Name Type Required Description
page-size String False The maximum number
of items to include in each page of a paginated response.
This parameter is not supported for application, campaign, and journey metrics.
token String False The NextToken string
that specifies which page of results to return in a paginated response.
Responses
Status code Response model Description
200 ActivitiesResponse (p. 141)The request succeeded.
400 MessageBody (p. 142) The request contains a syntax
error (BadRequestException).
403 MessageBody (p. 142) The request was denied
because access to the
specified resource is forbidden (ForbiddenException).
404 MessageBody (p. 142) The request failed because the
specified resource was not found (NotFoundException).
405 MessageBody (p. 142) The request failed because
the method is not allowed for the specified resource (MethodNotAllowedException).
413 MessageBody (p. 142) The request failed because
the payload for the body of the request is too large
(RequestEntityTooLargeException).
429 MessageBody (p. 142) The request failed because
too many requests were sent
Schemas
Status code Response model Description
during a certain amount of time (TooManyRequestsException).
500 MessageBody (p. 142) The request failed due to
an unknown internal server error, exception, or failure (InternalServerErrorException).
OPTIONS
Retrieves information about the communication requirements and options that are available for the Campaign Activities resource.
Path parameters
Name Type Required Description
campaign-id String True The unique identifier
for the campaign.
application-id String True The unique identifier
for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
Responses
Status code Response model Description
200 None The request succeeded.
Schemas
Response bodies
ActivitiesResponse schema
{ "NextToken": "string", "Item": [
{
"Id": "string",
"ApplicationId": "string", "CampaignId": "string", "TreatmentId": "string", "State": "string", "Result": "string",
"ScheduledStart": "string", "Start": "string",
"End": "string",
"SuccessfulEndpointCount": integer, "TotalEndpointCount": integer,
Properties
"TimezonesTotalCount": integer, "TimezonesCompletedCount": integer }
] }
MessageBody schema
{
"RequestID": "string", "Message": "string"
}
Properties
ActivitiesResponse
Provides information about the activities that were performed by a campaign.
NextToken
The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
Type: string Required: False
Item
An array of responses, one for each activity that was performed by the campaign.
Type: Array of type ActivityResponse (p. 142) Required: True
ActivityResponse
Provides information about an activity that was performed by a campaign.
Id
The unique identifier for the activity.
Type: string Required: True
ApplicationId
The unique identifier for the application that the campaign applies to.
Type: string Required: True
CampaignId
The unique identifier for the campaign that the activity applies to.
Properties
Type: string Required: True
TreatmentId
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.
Type: string Required: False
State
The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
Type: string Required: False
Result
Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
Type: string Required: False
ScheduledStart
The scheduled start time, in ISO 8601 format, for the activity.
Type: string Required: False
Start
The actual start time, in ISO 8601 format, of the activity.
Type: string Required: False
End
The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
Type: string Required: False
SuccessfulEndpointCount
The total number of endpoints that the campaign successfully delivered messages to.
Type: integer Required: False
See also
TotalEndpointCount
The total number of endpoints that the campaign attempted to deliver messages to.
Type: integer Required: False
TimezonesTotalCount
The total number of unique time zones that are in the segment for the campaign.
Type: integer Required: False
TimezonesCompletedCount
The total number of time zones that were completed.
Type: integer Required: False
MessageBody
Provides information about an API request or response.
RequestID
The unique identifier for the request or response.
Type: string Required: False
Message
The message that's returned from the API.
Type: string Required: False
See also
For more information about using this API in one of the language-specific AWS SDKs and references, see the following:
GetCampaignActivities
• AWS Command Line Interface
• AWS SDK for .NET
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3