EepURL Reports
Get a summary of social activity for the campaign, tracked by EepURL.
Available methods
-
-
Get Eepurl activity
GET /reports/{campaign_id}/eepurl
Get a summary of social activity for the campaign, tracked by EepURL.
Path parameters
campaign_id |
The unique id for the campaign. |
Query string parameters
fields |
Type: Array |
Title: Fields |
Read only: false |
A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation. |
exclude_fields |
Type: Array |
Title: Exclude Fields |
Read only: false |
A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation. |
Response body parameters
twitter |
Type: Object |
Title: Twitter Stats |
Read only: false |
A summary of Twitter activity for a campaign. |
Show properties
tweets |
Type: Integer |
Title: Tweet Count |
Read only: true |
The number of tweets including a link to the campaign. |
first_tweet |
Type: String |
Title: First Tweet Timestamp |
Read only: true |
The day and time of the first recorded tweet with a link to the campaign. |
last_tweet |
Type: String |
Title: Last Tweet Timestamp |
Read only: true |
The day and time of the last recorded tweet with a link to the campaign. |
retweets |
Type: Integer |
Title: Retweet Count |
Read only: true |
The number of retweets that include a link to the campaign. |
statuses |
Type: Array |
Title: Twitter Status |
Read only: true |
A summary of tweets that include a link to the campaign. |
Show properties
status |
Type: String |
Title: Status Body |
Read only: true |
The body of the tweet. |
screen_name |
Type: String |
Title: Screen Name |
Read only: true |
The Twitter handle for the author of the tweet. |
status_id |
Type: String |
Title: Status ID |
Read only: true |
The individual id for the tweet. |
datetime |
Type: String |
Title: Datetime |
Read only: true |
A timestamp for the tweet. |
is_retweet |
Type: Boolean |
Title: Is Retweet |
Read only: true |
A ‘true’ or ‘false’ status of whether the tweet is a retweet. |
|
|
clicks |
Type: Object |
Title: Click Summary |
Read only: true |
A summary of the click-throughs on the campaign’s URL. |
Show properties
clicks |
Type: Integer |
Title: Clicks |
Read only: true |
The total number of clicks to the campaign’s URL. |
first_click |
Type: String |
Title: First Click |
Read only: true |
The timestamp for the first click to the URL. |
last_click |
Type: String |
Title: Last Click |
Read only: true |
The timestamp for the last click to the URL. |
locations |
Type: Array |
Title: Click Locations |
Read only: true |
A summary of the top click locations. |
Show properties
country |
Type: String |
Title: Country |
Read only: false |
The two-digit country code for a recorded click. |
region |
Type: String |
Title: Region |
Read only: false |
If available, a specific region where the click was recorded. |
|
|
referrers |
Type: Array |
Title: No Title |
Read only: true |
A summary of the top referrers for the campaign. |
Show properties
referrer |
Type: String |
Title: Referrer |
Read only: false |
A referrer (truncated to 100 bytes). |
clicks |
Type: Integer |
Title: Clicks |
Read only: false |
The number of clicks a single referrer generated. |
first_click |
Type: String |
Title: First Click |
Read only: false |
The timestamp for the first click from this referrer. |
last_click |
Type: String |
Title: Last Click |
Read only: false |
The timestamp for the last click from this referrer. |
|
eepurl |
Type: String |
Title: Eepurl |
Read only: true |
The shortened link used for tracking. |
campaign_id |
Type: String |
Title: Campaign ID |
Read only: true |
The unique id for the campaign. |
total_items |
Type: Integer |
Title: Item Count |
Read only: false |
The total number of items matching the query regardless of pagination. |
_links |
Type: Array |
Title: Links |
Read only: true |
A list of link types and descriptions for the API schema documents. |
Show properties
rel |
Type: String |
Title: Rel |
Read only: true |
As with an HTML ‘rel’ attribute, this describes the type of link. |
href |
Type: String |
Title: Href |
Read only: true |
This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action. |
method |
Type: String |
Title: Method |
Read only: true |
The HTTP method that should be used when accessing the URL defined in ‘href’.
Possible Values:
- GET
- POST
- PUT
- PATCH
- DELETE
- OPTIONS
- HEAD
|
targetSchema |
Type: String |
Title: Target Schema |
Read only: true |
For GETs, this is a URL representing the schema that the response should conform to. |
schema |
Type: String |
Title: Schema |
Read only: true |
For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to. |
|
Example request
curl --request GET \
--url 'https://usX.api.mailchimp.com/3.0/reports/b294987f6c/eepurl' \
--user 'anystring:apikey' \
--include
Example response
HTTP/1.1 200 OK
Server: nginx
Content-Type: application/json; charset=utf-8
Content-Length: 457
Vary: Accept-Encoding
X-Request-Id: 819afbc8-b9e6-4ab6-80e4-5be141a5b2f6
Link: <https://api.mailchimp.com/schema/3.0/Reports/Eepurl/Collection.json>; rel="describedBy"
Date: Thu, 12 May 2016 15:18:56 GMT
Connection: keep-alive
{
"eepurl": "http://eepurl.com/b1xQcn",
"campaign_id": "b294987f6c",
"total_items": 0,
"_links": [
{
"rel": "parent",
"href": "https://usX.api.mailchimp.com/3.0/reports/b294987f6c",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/Instance.json"
},
{
"rel": "self",
"href": "https://usX.api.mailchimp.com/3.0/reports/b294987f6c/eepurl",
"method": "GET",
"targetSchema": "https://api.mailchimp.com/schema/3.0/Reports/Eepurl/Collection.json"
}
]
}
Error response
type |
Type: String |
Title: Problem Type |
Read only: false |
An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type. |
title |
Type: String |
Title: Error Title |
Read only: false |
A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization. |
status |
Type: Integer |
Title: HTTP Status Code |
Read only: false |
The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem. |
detail |
Type: String |
Title: Error Message |
Read only: false |
A human-readable explanation specific to this occurrence of the problem. Learn more about errors. |
instance |
Type: String |
Title: Instance ID |
Read only: false |
A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support. |