Campaign: Campaign

Description Usage Arguments Details See Also Examples

Description

Retrieve campaign specific information. The function returns information in a data frame format.

Usage

1
2
3
Campaign(campaignID, type,auth)

Campaign(campaignID, type)

Arguments

campaignID

The ID of the specific campaign that you wish to understand.

type

the type of information you wish to retrieve. Must be one of the following: "recipients", "bounces", "opens", "clicks", "unsubscribes", or "spam"

auth

your accounts API key. This is not necessary if you have set a global variable: Sys.setenv('CampMonauth' = "API_KEY")

Details

recipients - Recipients provides a list of subscribers who received the emailed.

bounces - Emails that bounced and their bounce reason (i.e. hard or soft bounce)

opens - Subscribers who opened the email/n

clicks - Subscribers who opened and clicked through in the email

unsubscribes - Subscribers who opted to unsubscribe

spam - Subscribers who marked the email as 'spam'

See Also

Client

Examples

1
2
3
4
5
#set API Key
Sys.setenv('CampMonauth' = "API_KEY")

#note this is a random campaign ID
Campaign("14a19d1e3b2z1c7s3bc632fcbb179334" , "clicks")

mark-brackenrig/campaignmonitoR documentation built on May 15, 2019, 9:58 p.m.