API Documentation
Back to top  

Activity

Extends \MailChimp\Core\Model

Get recent daily, aggregated activity stats for your list. For example, view unsubscribes, signups, total emails sent, opens, clicks, and more, for up to 180 days.

package

Default

Methods

__construct

__construct(array $data = NULL)
inherited

Arguments

$data

array

api

api()
inherited

clear

clear()
inherited

config

config()
inherited

getAction

getAction( $name)
inherited

Arguments

$name

Returns an ActionField object specified by `$action` and `$name`

getActionField(string $action, string $name) : \MailChimp\Core\ActionField
inherited

Arguments

$action

string

Action Name

$name

string

Field Name

Response

\MailChimp\Core\ActionField

Returns an array of action fields for an action

getActionFields(string $action) : array<mixed,\MailChimp\Core\ActionField>
inherited

Arguments

$action

string

Response

array<mixed,\MailChimp\Core\ActionField>

Returns Field Information

getField(string $name) : \MailChimp\Core\Field
inherited

Arguments

$name

string

Response

\MailChimp\Core\Field

Gets all allowed fields of a Data

getFields() : array
inherited

Response

array

Return API Path

getPath(\MailChimp\Core\string $child = NULL, array $params = NULL) : string
inherited

Arguments

$child

\MailChimp\Core\string

$params

array

Response

string

Return true if field exists or false otherwise

hasField(string $name) : boolean
inherited

Arguments

$name

string

Field name

Response

boolean

initialize

initialize()
inherited

jsonSerialize

jsonSerialize()
inherited

merge

merge( $data)
inherited

Arguments

$data

own

own( $class,  $args)
inherited

Arguments

$class

$args

parseActionPath

parseActionPath( &$params)
inherited

Arguments

$params

reference

reference( &$field,  $name)
inherited

Arguments

$field

$name

setApi

setApi(\MailChimp\Interfaces\MailChimpInterface &$api)
inherited

Arguments

$api

\MailChimp\Interfaces\MailChimpInterface

setConfig

setConfig(\MailChimp\Interfaces\ConfigInterface &$config)
inherited

Arguments

$config

\MailChimp\Interfaces\ConfigInterface

Properties

API Endpoint

path : string
inherited
var

Type(s)

string

Path Parameters

params : array
inherited
var

Type(s)

array

Action Fields Configurations

action : array
inherited
var

Type(s)

array

Info for all action fields

_action : array
inherited
var

Type(s)

array

Data holder for predefined fields

data : object
inherited
var

Type(s)

object

Info for unreferenced action fields

_fields : array
inherited
var

Type(s)

array

API Query builder

builder : \MailChimp\Core\Builder
inherited
var

Type(s)

\MailChimp\Core\Builder

Fields for the model

fields : array
inherited
var

Type(s)

array

Reference map for fields

_reference : array
inherited
var

Type(s)

array

_api

_api :
inherited

Type(s)

_config

_config :
inherited

Type(s)

day

day : string

The date for the activity summary.

Type(s)

string

emails_sent

emails_sent : integer

The total number of emails sent on the date for the activity summary.

Type(s)

integer

unique_opens

unique_opens : integer

The number of unique opens.

Type(s)

integer

recipient_clicks

recipient_clicks : integer

The number of clicks.

Type(s)

integer

hard_bounce

hard_bounce : integer

The number of hard bounces.

Type(s)

integer

soft_bounce

soft_bounce : integer

The number of soft bounces

Type(s)

integer

subs

subs : integer

The number of subscribes.

Type(s)

integer

unsubs

unsubs : integer

The number of unsubscribes.

Type(s)

integer

other_adds

other_adds : integer

The number of subscribers who may have been added outside of the double opt-in process, such as imports or API activity.

Type(s)

integer

other_removes

other_removes : integer

The number of subscribers who may have been removed outside of unsubscribing or reporting an email as spam (for example, deleted subscribers).

Type(s)

integer

list_id

list_id : string

The unique id for the list.

Type(s)

string

total_items

total_items : integer

The total number of items matching the query regardless of pagination.

Type(s)

integer

_links

_links : array<mixed,\MailChimp\Data\Link>

A list of link types and descriptions for the API schema documents.

Type(s)

array<mixed,\MailChimp\Data\Link>