lists

List growth history data

Get a month-by-month summary of a specific list's growth activity.

get/3.0/lists/{list_id}/growth-history

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/lists/:list_id/growth-history/get.ts
A function with typed inputs. Its response is checked against the schema.

list_idstring required

The unique ID for the list.

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.

sort_field'month'

Returns files sorted by the specified field.

sort_dir'ASC' | 'DESC'

Determines the order direction for sorted results.

list_idstring

The list id.

total_itemsinteger

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

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