reports

List campaign reports

Get campaign reports.

get/3.0/reports

Request

Base URL
https://api.mailchimp.com
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://login.mailchimp.com/oauth2/authorize
  Token URLhttps://login.mailchimp.com/oauth2/token
TypeScript
https://skmtc.dev/mailchimp/apis/mailchimp-api/docs/3.0/reports/get.ts
A function with typed inputs. Its response is checked against the schema.

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.

countinteger

The number of records to return. Default value is 10. Maximum value is 1000

offsetinteger

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

type'regular' | 'plaintext' | 'absplit' | 'rss' | 'variate'

The campaign type.

before_send_timestring date-time

Restrict the response to campaigns sent before the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

since_send_timestring date-time

Restrict the response to campaigns sent after the set time. Uses ISO 8601 time format: 2015-10-21T15:41:36+00:00.

total_itemsinteger

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

{
  "reports": [
    {
      "ecommerce": {
        "currency_code": "USD"
      }
    }
  ]
}

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