« Back to Documentation Overview

campaignEepUrlStats – v1.2

 campaignEepUrlStats(string apikey, string cid)

Retrieve stats for your campaign's eepurl. Note that these are cached for up to half and hour.

Section
Campaign Stats
Parameters
apikey a valid API Key for your user account. Get by visiting your API dashboard
cid the campaign id to pull bounces for (can be gathered using campaigns())
Returns
array stats an array containing tweets, retweets, clicks, and referrer related to using the campaign's eepurl
Returned Fields
arraytwittervarious Twitter related stats
inttweetsTotal number of tweets seen
stringfirst_tweetdate and time of the first tweet seen
stringlast_tweetdate and time of the last tweet seen
intretweetsTotal number of retweets seen
stringfirst_retweetdate and time of the first retweet seen
stringlast_retweetdate and time of the last retweet seen
arraystatusesan array of statuses recorded inclduing the status, screen_name, status_id, and datetime fields plus an is_retweet flag
arrayclicksstats related to click-throughs on the eepurl
intclicksTotal number of clicks seen
stringfirst_clickdate and time of the first click seen
stringlast_clickdate and time of the first click seen
arraylocationsan array of geographic locations including country, region, and total clicks
arrayreferrersan array of arrays, each containing
stringreferrerthe referrer, truncated to 100 characters
intclicksTotal number of clicks seen from this referrer
stringfirst_clickdate and time of the first click seen from this referrer
stringlast_clickdate and time of the first click seen from this referrer