Social Posts
Contents
VR allows users to create and manage email campaigns and social posts. Similar to the email API, there are social post APIs. APIs to create, update and manage social posts are in development, and are not available yet. However, API's to list all the social posts in a user's account and summary stats on a published social post are available.
By adding a filter to the GET Messages API, all social posts created , scheduled and posted can be listed. This API like the other GET API's will accept a type parameter. This parameter accepts values "basic","standard" or "all". The API also accepts a parameter called message_type. message_type can be set to social_posts to list all social posts in a user's account.The sample below lists all social posts for a given user account and has the type parameter set to "all"
URL
https://vrapi.verticaresponse.com/api/v1/messages
Method
GET
Sample Request
Sample Response
This API will return summary stats for a social post. Following stats will be returned for every social post
| Stat | Description |
|---|---|
| reach | Reach of the social networks the social post was shared in. |
| twitter_link_clicks | Number of clicks on links in the post from twitter |
| retweets | Number of retweets of the tweet posted |
| fb_link_clicks | Number of clicks on the links in the post from facebook |
| fb_shares | Number of shares of the facebook post |
| fb_comments | Number of comments on the facebook post |
| fb_likes | Number of likes on the facebook post |
Depending on which social network the social post is shared, only those stats are returned. For example, if a post shared only in facebook, only the facebook related statistics are returned. If a post is shared in both the supported social networks (facebook and twitter), all the stats will be returned.
URL
https://vrapi.verticalresponse.com/api/v1/messages/social_posts/11/stats
Method
GET
Sample Request
Sample Response
