ChmpReports: Reports class

In sckott/chimpr: 'Mailchimp' API Client

Description

Reports class

Reports class

Details

xxx

Methods

Public methods

• ChmpReports$new()

• ChmpReports$print()

• ChmpReports$all()

• ChmpReports$info()

• ChmpReports$abuse_reports()

• ChmpReports$advice()

• ChmpReports$open_details()

• ChmpReports$click_details()

• ChmpReports$domain_performance()

• ChmpReports$eepurl()

• ChmpReports$email_activity()

• ChmpReports$locations()

• ChmpReports$sent_to()

• ChmpReports$sub_reports()

• ChmpReports$unsubscribed()

• ChmpReports$clone()

---

Method new()

Usage

ChmpReports$new(conn, id)

Arguments

conn

a connection object. see ChmpClient

id

a report id. optional, but required for most methods

---

Method print()

Usage

ChmpReports$print(x, ...)

---

Method all()

Usage

ChmpReports$all(
  fields = NULL,
  exclude_fields = NULL,
  count = 10,
  offset = 0,
  type = NULL,
  before_send_time = NULL,
  since_send_time = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method info()

Usage

ChmpReports$info(
  fields = NULL,
  exclude_fields = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method abuse_reports()

Usage

ChmpReports$abuse_reports(
  report = NULL,
  fields = NULL,
  exclude_fields = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method advice()

Usage

ChmpReports$advice(
  fields = NULL,
  exclude_fields = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method open_details()

Usage

ChmpReports$open_details(
  fields = NULL,
  exclude_fields = NULL,
  count = 10,
  offset = 0,
  since = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method click_details()

Usage

ChmpReports$click_details(
  link_id = NULL,
  members = FALSE,
  subscriber_hash = NULL,
  fields = NULL,
  exclude_fields = NULL,
  count = 10,
  offset = 0,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method domain_performance()

Usage

ChmpReports$domain_performance(
  fields = NULL,
  exclude_fields = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method eepurl()

Usage

ChmpReports$eepurl(
  fields = NULL,
  exclude_fields = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method email_activity()

Usage

ChmpReports$email_activity(
  subscriber_hash = NULL,
  fields = NULL,
  exclude_fields = NULL,
  count = 10,
  offset = 0,
  since = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method locations()

Usage

ChmpReports$locations(
  fields = NULL,
  exclude_fields = NULL,
  count = 10,
  offset = 0,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method sent_to()

Usage

ChmpReports$sent_to(
  subscriber_hash = NULL,
  fields = NULL,
  exclude_fields = NULL,
  count = 10,
  offset = 0,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method sub_reports()

Usage

ChmpReports$sub_reports(
  fields = NULL,
  exclude_fields = NULL,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method unsubscribed()

Usage

ChmpReports$unsubscribed(
  subscriber_hash = NULL,
  fields = NULL,
  exclude_fields = NULL,
  count = 10,
  offset = 0,
  key = NULL,
  parse = TRUE,
  ...
)

Arguments

fields

(list/vector) A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fields

(list/vector) A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

---

Method clone()

The objects of this class are cloneable with this method.

Usage

ChmpReports$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Note

not all routes are implemented thus far

Examples

## Not run: 
(conn <- ChmpClient$new())
(x <- ChmpReports$new(conn))
x$all()
x$all(count = 2)
x$all(count = 2, offset = 2)

(x <- ChmpReports$new(conn, id = "<id>"))
x$info()
x$info(parse = FALSE)
x$info(fields = "clicks")
x$abuse_reports()
x$advice()
x$open_details()
x$click_details()
# x$click_details("<id>")
# x$click_details("<id>", members = TRUE)
# x$click_details("<id>", members = TRUE, subscriber_hash = "<hash>")
x$domain_performance()
x$eepurl()
x$email_activity()
x$locations()
x$sent_to()
x$sub_reports()
x$unsubscribed()

## End(Not run)

sckott/chimpr documentation built on Sept. 17, 2021, 11:04 a.m.