Menu
Amazon Pinpoint
REST API Reference

Campaign Activities

Provides information about the activity performed by a campaign, such as the time during which the campaign ran and the number of endpoints to which it delivered messages. You can use this resource to look up activity information by app ID and campaign ID.

URI

/v1/apps/application-id/campaigns/campaign-id/activities

HTTP Methods

GET

Returns information about the activity performed by a campaign.

Header

Name Required Type

accept

false

string

Path

Name Required Type

application-id

true

string

campaign-id

true

string

Query

Name Required Type

page-size

false

string

token

false

string

Response

Status Code Schema

200

ActivitiesResponse

Errors

Errors

Status Code Schema Error Type

400

MessageBody

BadRequestException

403

MessageBody

ForbiddenException

404

MessageBody

NotFoundException

405

MessageBody

MethodNotAllowedException

429

MessageBody

TooManyRequestsException

500

MessageBody

InternalServerErrorException

Schemas

Response Schemas

Example ActivitiesResponse

Copy
{ "Item": [ { "Id": "string", "ApplicationId": "string", "CampaignId": "string", "TreatmentId": "string", "State": "string", "Result": "string", "ScheduledStart": "string", "Start": "string", "End": "string", "SuccessfulEndpointCount": 0, "TotalEndpointCount": 0, "TimezonesTotalCount": 0, "TimezonesCompletedCount": 0 } ] }

Example MessageBody

Copy
{ "RequestID": "string", "Message": "string" }

Attributes

ActivitiesResponse

Attribute Type Description

Item

array

List of campaign activities

ActivityResponse

Attribute Type Description

ApplicationId

string

The ID of the application to which the campaign applies.

CampaignId

string

The ID of the campaign to which the activity applies.

End

string

The actual time the activity was marked CANCELLED or COMPLETED. Provided in ISO 8601 format.

Id

string

The unique activity ID.

Result

string

Indicates whether the activity succeeded.

Valid values: SUCCESS, FAIL

ScheduledStart

string

The scheduled start time for the activity in ISO 8601 format.

Start

string

The actual start time of the activity in ISO 8601 format.

State

string

The state of the activity.

Valid values: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, COMPLETED

SuccessfulEndpointCount

integer

The total number of endpoints to which the campaign successfully delivered messages.

TimezonesCompletedCount

integer

The total number of timezones completed.

TimezonesTotalCount

integer

The total number of unique timezones present in the segment.

TotalEndpointCount

integer

The total number of endpoints to which the campaign attempts to deliver messages.

TreatmentId

string

The ID of a variation of the campaign used for A/B testing.

MessageBody

Attribute Type Description

Message

string

The error message returned from the API.

RequestID

string

The unique message body ID.