Struct mailchimp_api::reports::Reports

pub struct Reports {
    pub client: Client,
}

Fields

client: Client

Implementations

impl Reports

pub async fn get(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    type_: CampaignType,
    before_send_time: Option<DateTime<Utc>>,
    since_send_time: Option<DateTime<Utc>>
) -> Result<CampaignReportsData>

List campaign reports.

This function performs a GET to the /reports endpoint.

Get campaign reports.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• type_: crate::types::CampaignType – There are four types of campaigns you can create in Mailchimp. A/B Split campaigns have been deprecated and variate campaigns should be used instead.
• before_send_time: chrono::DateTime<chrono::Utc> – Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.
• since_send_time: chrono::DateTime<chrono::Utc> – Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

pub async fn get_reports(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str
) -> Result<Reports>

Get campaign report.

This function performs a GET to the /reports/{campaign_id} endpoint.

Get report details for a specific sent campaign.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.

pub async fn get_abuse(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str
) -> Result<AbuseComplaintsData>

List abuse reports.

This function performs a GET to the /reports/{campaign_id}/abuse-reports endpoint.

Get a list of abuse complaints for a specific campaign.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.

pub async fn get_abuse_reports(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str,
    report_id: &str
) -> Result<AbuseComplaint>

Get abuse report.

This function performs a GET to the /reports/{campaign_id}/abuse-reports/{report_id} endpoint.

Get information about a specific abuse report for a campaign.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.
• report_id: &str – The id for the abuse report.

pub async fn get_advice(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str
) -> Result<CampaignAdviceReport>

List campaign feedback.

This function performs a GET to the /reports/{campaign_id}/advice endpoint.

Get feedback based on a campaign’s statistics. Advice feedback is based on campaign stats like opens, clicks, unsubscribes, bounces, and more.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.

pub async fn get_click_detail(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    campaign_id: &str
) -> Result<ClickDetailReport>

List campaign details.

This function performs a GET to the /reports/{campaign_id}/click-details endpoint.

Get information about clicks on specific links in your Mailchimp campaigns.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• campaign_id: &str – The unique id for the campaign.

pub async fn get_click_detail_reports(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str,
    link_id: &str
) -> Result<UrlsClicked>

Get campaign link details.

This function performs a GET to the /reports/{campaign_id}/click-details/{link_id} endpoint.

Get click details for a specific link in a campaign.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.
• link_id: &str – The name of the folder.

pub async fn get_click_details_member(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    campaign_id: &str,
    link_id: &str
) -> Result<ClickDetailMembers>

List clicked link subscribers.

This function performs a GET to the /reports/{campaign_id}/click-details/{link_id}/members endpoint.

Get information about list members who clicked on a specific link in a campaign.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• campaign_id: &str – The unique id for the campaign.
• link_id: &str – The name of the folder.

pub async fn get_click_details_member_reports(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str,
    link_id: &str,
    subscriber_hash: &str
) -> Result<ClickDetailMember>

Get clicked link subscriber.

This function performs a GET to the /reports/{campaign_id}/click-details/{link_id}/members/{subscriber_hash} endpoint.

Get information about a specific subscriber who clicked a link in a specific campaign.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.
• link_id: &str – The name of the folder.
• subscriber_hash: &str – The MD5 hash of the lowercase version of the list member’s email address.

pub async fn get_open_detail(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    campaign_id: &str,
    since: &str
) -> Result<OpenDetailReport>

List campaign open details.

This function performs a GET to the /reports/{campaign_id}/open-details endpoint.

Get detailed information about any campaign emails that were opened by a list member.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• campaign_id: &str – The unique id for the campaign.
• since: &str – Restrict results to campaign open events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

pub async fn get_open_details_member(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str,
    subscriber_hash: &str
) -> Result<OpenActivity>

Get opened campaign subscriber.

This function performs a GET to the /reports/{campaign_id}/open-details/{subscriber_hash} endpoint.

Get information about a specific subscriber who opened a campaign.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.
• subscriber_hash: &str – The MD5 hash of the lowercase version of the list member’s email address.

pub async fn get_domain_performance(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str
) -> Result<DomainPerformance>

List domain performance stats.

This function performs a GET to the /reports/{campaign_id}/domain-performance endpoint.

Get statistics for the top-performing email domains in a campaign.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.

pub async fn get_eepurl(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str
) -> Result<EepurlActivity>

List EepURL activity.

This function performs a GET to the /reports/{campaign_id}/eepurl endpoint.

Get a summary of social activity for the campaign, tracked by EepURL.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.

pub async fn get_email_activity(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    campaign_id: &str,
    since: &str
) -> Result<EmailActivityData>

List email activity.

This function performs a GET to the /reports/{campaign_id}/email-activity endpoint.

Get a list of member’s subscriber activity in a specific campaign.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• campaign_id: &str – The unique id for the campaign.
• since: &str – Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

pub async fn get_email_activity_reports(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str,
    subscriber_hash: &str,
    since: &str
) -> Result<EmailActivity>

Get subscriber email activity.

This function performs a GET to the /reports/{campaign_id}/email-activity/{subscriber_hash} endpoint.

Get a specific list member’s activity in a campaign including opens, clicks, and bounces.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.
• subscriber_hash: &str – The MD5 hash of the lowercase version of the list member’s email address.
• since: &str – Restrict results to email activity events that occur after a specific time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

pub async fn get_location(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str,
    count: i64,
    offset: i64
) -> Result<OpenLocationsData>

List top open activities.

This function performs a GET to the /reports/{campaign_id}/locations endpoint.

Get top open locations for a specific campaign.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.

pub async fn get_sent(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    campaign_id: &str
) -> Result<SentData>

List campaign recipients.

This function performs a GET to the /reports/{campaign_id}/sent-to endpoint.

Get information about campaign recipients.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• campaign_id: &str – The unique id for the campaign.

pub async fn get_sent_reports(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str,
    subscriber_hash: &str
) -> Result<SentTo>

Get campaign recipient info.

This function performs a GET to the /reports/{campaign_id}/sent-to/{subscriber_hash} endpoint.

Get information about a specific campaign recipient.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.
• subscriber_hash: &str – The MD5 hash of the lowercase version of the list member’s email address.

pub async fn get_sub(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str
) -> Result<CampaignSubReports>

List child campaign reports.

This function performs a GET to the /reports/{campaign_id}/sub-reports endpoint.

Get a list of reports with child campaigns for a specific parent campaign.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.

pub async fn get_unsubscribed(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    campaign_id: &str
) -> Result<UnsubscribesData>

List unsubscribed members.

This function performs a GET to the /reports/{campaign_id}/unsubscribed endpoint.

Get information about members who have unsubscribed from a specific campaign.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• campaign_id: &str – The unique id for the campaign.

pub async fn get_unsubscribed_reports(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    campaign_id: &str,
    subscriber_hash: &str
) -> Result<Unsubscribes>

Get unsubscribed member.

This function performs a GET to the /reports/{campaign_id}/unsubscribed/{subscriber_hash} endpoint.

Get information about a specific list member who unsubscribed from a campaign.

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• campaign_id: &str – The unique id for the campaign.
• subscriber_hash: &str – The MD5 hash of the lowercase version of the list member’s email address.

pub async fn get_ecommerce_product_activity(
    &self,
    fields: &[String],
    exclude_fields: &[String],
    count: i64,
    offset: i64,
    campaign_id: &str,
    sort_field: GetReportsEcommerceProductActivitySortField
) -> Result<GetReportsEcommerceProductActivityResponse>

List campaign product activity.

This function performs a GET to the /reports/{campaign_id}/ecommerce-product-activity endpoint.

Get breakdown of product activity for a campaign

Parameters:

• fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• exclude_fields: &[String] – A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.
• count: i64 – The number of records to return. Default value is 10. Maximum value is 1000.
• offset: i64 – Used for pagination, this it the number of records from a collection to skip. Default value is 0.
• campaign_id: &str – The unique id for the campaign.
• sort_field: crate::types::GetReportsEcommerceProductActivitySortField – Returns files sorted by the specified field.