Below you will find the API Version 1.0 Endpoints and their request/response structure.
On all of the endpoints below, <CLIENT_KEY> represents the key of the client you are requesting data for, and <API_KEY> represents your personal API Key.
Additionally, any request field with [OPTIONAL] beside it, is an optional piece of the request data.
IMPORTANT NOTE: The data retrieved from these API requests refreshes every 4 hours.
Executive Endpoints
Users Summary
URL:
https://my.socialtoaster.com/api/v1.0/<CLIENT_KEY>/executive/users-summary/
SAMPLE REQUEST DATA:
{
'api_key': '<API_KEY>',
'start_date': '2016-01-01', [OPTIONAL]
'end_date': '2016-05-01' [OPTIONAL]
}
SAMPLE RESPONSE DATA:
{
"recruits_count": 0,
"new_users_count": 3,
"non_posting_users": 1,
"social_networks": [
{
"user_count": 1,
"network": "Facebook"
},
{
"user_count": 1,
"network": "Twitter"
},
{
"user_count": 2,
"network": "LinkedIn"
},
{
"user_count": 1,
"network": "YouTube"
},
{
"user_count": 0,
"network": "Foursquare"
},
{
"user_count": 1,
"network": "Instagram"
},
{
"user_count": 1,
"network": "Tumblr"
},
{
"user_count": 1,
"network": "Spotify"
},
{
"user_count": 0,
"network": "Pinterest"
}
],
"users_count": 3
}Sharing and Traffic Summary
URL:
https://my.socialtoaster.com/api/v1.0/<CLIENT_KEY>/executive/sharing-and-traffic-summary/
SAMPLE REQUEST DATA:
{
'api_key': '<API_KEY>',
'start_date': '2016-01-01', [OPTIONAL]
'end_date': '2016-05-01' [OPTIONAL]
}
SAMPLE RESPONSE DATA:
{
"total_links": 58,
"total_visits": 112,
"social_networks": [
{
"user_count": 19,
"network": "Facebook"
},
{
"user_count": 20,
"network": "Twitter"
},
{
"user_count": 2,
"network": "LinkedIn"
},
{
"user_count": 0,
"network": "YouTube"
},
{
"user_count": 17,
"network": "Tumblr"
},
{
"user_count": 0,
"network": "Spotify"
},
{
"user_count": 0,
"network": "Pinterest"
}
]
}
User Trends
URL:
https://my.socialtoaster.com/api/v1.0/<CLIENT_KEY>/executive/users-trends/
SAMPLE REQUEST DATA:
{
'api_key': '<API_KEY>',
'start_date': '2016-01-01', [OPTIONAL]
'end_date': '2016-05-01' [OPTIONAL]
}
SAMPLE RESPONSE DATA:
[
{
"date": "Apr 01, 2016",
"read_only_user_count": 1,
"user_count": 1
},
{
"date": "Apr 03, 2016",
"read_only_user_count": 1,
"user_count": 1
},
{
"date": "Apr 10, 2016",
"read_only_user_count": 1,
"user_count": 1
},
{
"date": "Apr 17, 2016",
"read_only_user_count": 1,
"user_count": 1
},
{
"date": "Apr 24, 2016",
"read_only_user_count": 1,
"user_count": 1
},
{
"date": "May 01, 2016",
"read_only_user_count": 1,
"user_count": 1
}
]
Age Summary
URL:
https://my.socialtoaster.com/api/v1.0/<CLIENT_KEY>/executive/age-summary/
SAMPLE REQUEST DATA:
{
'api_key': '<API_KEY>',
'start_date': '2016-01-01', [OPTIONAL]
'end_date': '2016-05-01' [OPTIONAL]
}
SAMPLE RESPONSE DATA:
{
"average_age": 27.0,
"age_ranges": [
{
"age_range": "<18",
"user_count": 0
},
{
"age_range": "18-24",
"user_count": 0
},
{
"age_range": "25-34",
"user_count": 2
},
{
"age_range": "35-44",
"user_count": 0
},
{
"age_range": "45-54",
"user_count": 0
},
{
"age_range": "55-65",
"user_count": 0
},
{
"age_range": "65+",
"user_count": 0
}
]
}
Gender Summary
URL:
https://my.socialtoaster.com/api/v1.0/<CLIENT_KEY>/executive/gender-summary/
SAMPLE REQUEST DATA:
{
'api_key': '<API_KEY>',
'start_date': '2016-01-01', [OPTIONAL]
'end_date': '2016-05-01' [OPTIONAL]
}
SAMPLE RESPONSE DATA:
[
{
"gender": "Male",
"user_count": 1
},
{
"gender": "Female",
"user_count": 0
},
{
"gender": "Unknown",
"user_count": 1
}
]
Clicks By Network
URL:
https://my.socialtoaster.com/api/v1.0/<CLIENT_KEY>/executive/clicks-by-network/
SAMPLE REQUEST DATA:
{
'api_key': '<API_KEY>',
'start_date': '2016-01-01', [OPTIONAL]
'end_date': '2016-05-01' [OPTIONAL]
}
SAMPLE RESPONSE DATA:
[
{
"visit_count": 47,
"network": "Facebook"
},
{
"visit_count": 63,
"network": "Twitter"
},
{
"visit_count": 1,
"network": "LinkedIn"
},
{
"visit_count": 1,
"network": "Tumblr"
}
]
Unique Clicks By Network
URL:
https://my.socialtoaster.com/api/v1.0/<CLIENT_KEY>/executive/unique-clicks-by-network/
SAMPLE REQUEST DATA:
{
'api_key': '<API_KEY>',
'start_date': '2016-01-01', [OPTIONAL]
'end_date': '2016-05-01' [OPTIONAL]
}
SAMPLE RESPONSE DATA:
[
{
"unique_visit_count": 30,
"network": "Facebook"
},
{
"unique_visit_count": 42,
"network": "Twitter"
},
{
"unique_visit_count": 1,
"network": "LinkedIn"
},
{
"unique_visit_count": 1,
"network": "Tumblr"
}
]
Post List
URL:
https://my.socialtoaster.com/api/v1.0/<CLIENT_KEY>/executive/post-list/
SAMPLE REQUEST DATA:
{
'api_key': '<API_KEY>',
'start_date': '2016-01-01', [OPTIONAL]
'end_date': '2016-05-01' [OPTIONAL]
}
SAMPLE RESPONSE DATA:
[
{
"facebook_comments": 0,
"share_rate": null,
"links_shared_linkedin": 0,
"email_links_shared_twitter": 0,
"pinterest_comments": 0,
"tumblr_reblogs": 0,
"facebook_likes": 0,
"id": 664,
"impressions": 0,
"pic_url": "https://6ab006d460f7c979f8ca-c72ce3f15f8bad4dcd7ad33c481d4b19.ssl.cf2.rackcdn.com/post-20160404144320_664.jpg",
"email_links_shared_youtube": 0,
"subject": "Odd \u2018Purple Sailors\u2019 Wash Up on Florida Beaches",
"links_shared_myspace": 0,
"impressions_twitter": 0,
"linkedin_comments": 0,
"links_shared_twitter": 0,
"library_mode": "E",
"engagement": 0,
"label": "Odd \u2018Purple Sailors\u2019 Wash Up on Florida Beaches",
"links_shared_facebook": 0,
"email_links_shared_tumblr": 0,
"links_shared_tumblr": 0,
"twitter_favorites": 0,
"links_shared_pinterest": 0,
"impressions_tumblr": 0,
"email_links_shared_linkedin": 0,
"email_links_shared_myspace": 0,
"delivered": 0,
"linkedin_likes": 0,
"pinterest_likes": 0,
"pinterest_repins": 0,
"opened_count": 0,
"open_rate": null,
"email_links_shared_facebook": 0,
"visits_total": 0,
"visitors_total": 0,
"email_links_shared_pinterest": 0,
"date": "2016-04-04 14:43:20",
"tumblr_likes": 0,
"geotarget_zip_code": null,
"geotarget_distance_limit": null,
"url": "https://weather.com/science/nature/news/florida-hallandale-beach-velella-velella-purple-sailors-jellyfish",
"impressions_facebook": 0,
"twitter_retweets": 0,
"links_shared_youtube": 0,
"geotarget_country": "",
"is_sharable_daily": 0,
"links_shared_total": 0,
"expiration": null,
"email_links_shared_total": 0,
"impressions_linkedin": 0
}
]
User List
URL:
https://my.socialtoaster.com/api/v1.0/<CLIENT_KEY>/executive/user-list/
SAMPLE REQUEST DATA:
{
'api_key': '<API_KEY>'
}SAMPLE RESPONSE DATA:
[
{
"id": 12345678,
"first_name": "John",
"last_name": "Doe",
"email": "johndoe@email.com",
"is_active": 1,
"created": "1/1/2022",
"last_activity_date": "2/1/2022",
"state": "MD"
}
]