MAmailchimp
reports

List campaign details

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

get/3.0/reports/{campaign_id}/click-details

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.

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'total_clicks' | 'unique_clicks'

Returns click reports sorted by the specified field.

sort_dir'ASC' | 'DESC'

Determines the order direction for sorted results.

filter_botsboolean

When true, exclude automated bot clicks so the returned click counts reflect human clicks only, matching the in-app Recipient Activity view. Filtering changes a link's counts, but never removes a link from the response. Defaults to false (all clicks).

Response

campaign_idstring

The campaign id.

total_itemsinteger

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

Changes

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