List EepURL activity

GET

https://api.mailchimp.com/3.0/reports/:campaign_id/eepurl

GET

/3.0/reports/:campaign_id/eepurl

curl https://api.mailchimp.com/3.0/reports/campaign_id/eepurl \
     -H "Authorization: Bearer <token>"

200Retrieved

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "campaign_id": "string",
  "clicks": {
    "clicks": 1,
    "first_click": "2024-01-15T09:30:00Z",
    "last_click": "2024-01-15T09:30:00Z",
    "locations": [
      {
        "country": "string",
        "region": "NY"
      }
    ]
  },
  "eepurl": "string",
  "referrers": [
    {
      "clicks": 1,
      "first_click": "2024-01-15T09:30:00Z",
      "last_click": "2024-01-15T09:30:00Z",
      "referrer": "string"
    }
  ],
  "total_items": 1,
  "twitter": {
    "first_tweet": "string",
    "last_tweet": "string",
    "retweets": 1,
    "statuses": [
      {
        "datetime": "2024-01-15T09:30:00Z",
        "is_retweet": true,
        "screen_name": "string",
        "status": "string",
        "status_id": "string"
      }
    ],
    "tweets": 1
  }
}

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

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

campaign_idstringRequired

The unique id for the campaign.

Query parameters

fieldslist of stringsOptional

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

exclude_fieldslist of stringsOptional

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

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

campaign_idstringOptionalRead-only

The unique id for the campaign.

clicksobjectOptionalRead-only

A summary of the click-throughs on the campaign's URL.

eepurlstringOptionalRead-only

The shortened link used for tracking.

referrerslist of objectsOptionalRead-only

A summary of the top referrers for the campaign.

total_itemsintegerOptionalRead-only

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

twitterobjectOptional

A summary of Twitter activity for a campaign.