Get Campaign Activities

pinpoint_get_campaign_activities

R Documentation

Retrieves information about all the activities for a campaign

Description

Retrieves information about all the activities for a campaign.

Usage

pinpoint_get_campaign_activities(ApplicationId, CampaignId, PageSize,
  Token)

Arguments

ApplicationId

[required] The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

CampaignId

[required] The unique identifier for the campaign.

PageSize

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

The NextToken string that specifies which page of results to return in a paginated response.

Value

A list with the following syntax:

list(
  ActivitiesResponse = list(
    Item = list(
      list(
        ApplicationId = "string",
        CampaignId = "string",
        End = "string",
        Id = "string",
        Result = "string",
        ScheduledStart = "string",
        Start = "string",
        State = "string",
        SuccessfulEndpointCount = 123,
        TimezonesCompletedCount = 123,
        TimezonesTotalCount = 123,
        TotalEndpointCount = 123,
        TreatmentId = "string",
        ExecutionMetrics = list(
          "string"
        )
      )
    ),
    NextToken = "string"
  )
)

Request syntax

svc$get_campaign_activities(
  ApplicationId = "string",
  CampaignId = "string",
  PageSize = "string",
  Token = "string"
)