RebelMouse Public API v1.2

RebelMouse Public API version 1.2 is available as of August 16, 2016. The older version of the API (Public API version 1.1) will be deprecated on December 1, 2016. Please make sure to switch over any and all calls to the new API by that time.


READ REQUESTS:

FRONT PAGE POSTS

Returns front page posts.

https://{roar_domain}/api/1.2/posts/frontpage?limit={limit}&offset={offset}

<strong>Argument Required Default Description Example</strong>limit no 10 number of posts to return 1offset no 0 number of posts to skip 10 

POSTS BY SECTION

Returns a section's posts.

https://{roar_domain}/api/1.2/posts/section?section_name={section}&limit={limit}&offset={offset}

<strong>Argument Required Default Description Example</strong>limit no 10 number of posts to return 1offset no 0 number of posts to skip 10section_name yes - section's url apps 

POSTS BY AUTHOR

Returns an author's posts.

https://{roar_domain}/api/1.2/posts/author?author_name={author_name}&limit={limit}&offset={offset}

<strong>Argument Required Default Description Example</strong>limit no 10 number of posts to return 1offset no 0 number of posts to skip 10author_name yes - author's name luladog 

POSTS BY TAG

Returns posts by tag.

https://{roar_domain}/api/1.2/posts/tag?tag={tag}&exclude_tags={exclude_tags}&limit={limit}&offset={offset}

<strong>Argument Required Default Description Example</strong>limit no 10 number of posts to return 1offset no 0 number of posts to skip 10roar_domain yes - roar domain positivemousetag yes - tag pythonexclude_tags no - tags to exclude (comma separated list) mouse 

POSTS' DETAILS

Returns posts details.

https://{roar_domain}/api/1.2/posts?ids={ids}

<strong>Argument Required Default Description Example</strong>ids yes - ids of posts 1,2,3 

SITES' DETAILS

Returns sites' details.

https://{roar_domain}/api/1.2/site/details?site_id={site_id}

<strong>Argument Required Default Description Example</strong>site_id yes - site's id 1 

AUTHORS' DETAILS

Return authors' details.

https://{roar_domain}/api/1.2/authors?ids={ids}&access_token={access_token}

<strong>Argument Required Default Description Example</strong>ids yes - authors' ids 19access_token yes - access token bdQ0XiTDyR2eOsQHkCooS6CeBwgD4vAd81ux4UmTFx2qXfzeEphrCFGZuK8S5Fk6 

AUTHORS' DETAILS BY NAME

Return authors' details by name.

https://{roar_domain}/api/1.2/authors/name?author_names={author_names}&access_token={access_token}

<strong>Argument Required Default Description Example</strong>author_names yes - authors' names positivemouseaccess_token yes - access token bdQ0XiTDyR2eOsQHkCooS6CeBwgD4vAd81ux4UmTFx2qXfzeEphrCFGZuK8S5Fk6 

AUTHORS' DETAILS BY FACEBOOK ID

Return authors' details by Facebook IDs.

https://{roar_domain}/api/1.2/authors/facebook?fb_ids={fb_ids}&access_token={access_token}

<strong>Argument Required Default Description Example</strong>fb_ids yes - facebook ids 19323283access_token yes - access token bdQ0XiTDyR2eOsQHkCooS6CeBwgD4vAd81ux4UmTFx2qXfzeEphrCFGZuK8S5Fk6 

OVERALL POSTS STATS

GET https://{roar_domain}/api/1.2/insights/posts/ordered?order={order}&period={period}&limit={limit}&offset={offset}&access_token={access_token}

<strong>Argument Required Description Restrictions Example</strong>order yes The field for results to be ordered by Only "total_views" value is valid for now total_viewsperiod yes Period which ends now Only "1h", "6h", "12h", "24h", "7d", "30d", "lifetime" values are valid for now 7dlimit yes Number of records to return Positive integer, Max value = 30 10offset yes Number of records to skip Non-negative integer 5access_token yes Access token for the roar String bdQ0XiTDyR2eOsQHkCooS6CeBwgD4vAd81ux4UmTFx2qXfzeEphrCFGZuK8S5Fk6 

Response:

{ "status": { "code": 0, "messages": [] }, "data": { "report": { "records": [{ "post_id": 12312321, "total_views": 1234 }, { "post_id": 4859674589, "total_views": 4321 }, ... ] } }} 

INDIVIDUAL POSTS STATS

GET https://{roar_domain}/api/1.2/insights/posts/details?period={period}&ids={ids}&access_token={access_token}

<strong>Argument Required Description Restrictions Example</strong>period yes Period which ends now Only "1h", "6h", "12h", "24h", "7d", "30d", "lifetime" values are valid for now 7dids yes List of post IDs Positive long numbers separated by comma, Max number = 30 12312321,4859674589access_token yes Access token for the roar String bdQ0XiTDyR2eOsQHkCooS6CeBwgD4vAd81ux4UmTFx2qXfzeEphrCFGZuK8S5Fk6 

Response:

{ "status": { "code": 0, "messages": [] }, "data": { "report": { "records": [{ "post_id": 12312321, "total_views": 1234 }, { "post_id": 4859674589, "total_views": 4321 }, ... ] } }} 

FACEBOOK WINS

GET https://{roar_domain}/api/1.2/insights/posts/wins/facebook?period={period}&ids={ids}&access_token={access_token}

<strong>Argument Required Description Restrictions Example</strong>period yes Period which ends now Only "1h", "6h", "12h", "24h", "7d", "30d", "lifetime" values are valid 7dids yes List of post IDs Positive long numbers separated by comma, Max number = 30 12312321,4859674589access_token yes Access token for the roar String bdQ0XiTDyR2eOsQHkCooS6CeBwgD4vAd81ux4UmTFx2qXfzeEphrCFGZuK8S5Fk6 

Response:

{ "status": { "code": 0, "messages": [] }, "data": { "report": { "records": [{ "post_id": 567, "page_fans": 84872, "page_name": "HOT 107.9", "page_logo": "https://scontent.xx.fbcdn.net/hprofile-xpt1/v/t1.0-1/p50x50/1509847_10152819708755859_1441502743297395555_n.png?oh=909b90499656ccd816f5d9202526d5ff&oe=57549D5A", "page_url": "https://www.facebook.com/56194705858", "post_created_at": 1456822800, "post_likes": 5, "post_shares": 0, "post_comments": 0, "post_url": "https://www.facebook.com/Hot107.9/posts/10153962058115859" }, ... ] } }} 

TWITTER WINS

GET https://{roar_domain}/api/1.2/insights/posts/wins/twitter?period={period}&ids={ids}&access_token={access_token}

<strong>Argument Required Description Restrictions Example</strong>period yes Period which ends now Only "1h", "6h", "12h", "24h", "7d", "30d", "lifetime" values are valid 7dids yes List of post IDs Positive long numbers separated by comma, Max number = 30 12312321,4859674589access_token yes Access token for the roar String bdQ0XiTDyR2eOsQHkCooS6CeBwgD4vAd81ux4UmTFx2qXfzeEphrCFGZuK8S5Fk6 

Response:

{ "status": { "code": 0, "messages": [] }, "data": { "report": { "records": [{ "post_id": 234, "account_fans": 63500, "account_logo": "https://pbs.twimg.com/profile_images/706968590717681664/MfcERn0d_normal.jpg", "account_name": "The Dodo", "account_url: "https://www.twitter.com/statuses/708080524666007552", "tweet_created_at" :1457654527, "tweet_likes": 328, "tweet_retweets": 328, "tweet_url": "https://twitter.com/dodo/status/708080524666007552" }, ... ] } }}