reports

Get campaign report

Get report details for a specific sent campaign.

get/3.0/reports/{campaign_id}

Request

Path parameters

campaign_idstring required

The unique id for the campaign.

Query parameters

fieldsstring[]

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

exclude_fieldsstring[]

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

Response

abuse_reportsinteger

The number of abuse reports generated for this campaign.

campaign_titlestring

The title of the campaign.

emails_sentinteger

The total number of emails sent for this campaign.

idstring

A string that uniquely identifies this campaign.

list_idstring

The unique list id.

list_is_activeboolean

The status of the list used, namely if it's deleted or disabled.

list_namestring

The name of the list.

preview_textstring

The preview text for the campaign.

rss_last_sendstring date-time

For RSS campaigns, the date and time of the last send in ISO 8601 format.

send_timestring date-time

The date and time a campaign was sent in ISO 8601 format.

subject_linestring

The subject line for the campaign.

typestring

The type of campaign (regular, plain-text, ab_split, rss, automation, variate, or auto).

unsubscribedinteger

The total number of unsubscribed members for this campaign.

Example response

{
  "ecommerce": {
    "currency_code": "USD"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.