Subscribe to Our Newsletter

x

Public API v1.1 - Roar/Runner

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

The new API improvements include:

  • New Authors API
  • New Insights API
  • New response format
  • Various endpoints' updates

FRONTPAGE POSTS

Returns frontpage posts.

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

Argument    Required    Default    Description                  Examplelimit       no          10         number of posts to return    1offset      no          0          number of posts to skip      10

POSTS BY SECTION

Returns section’s posts.

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

Argument        Required    Default    Description                  Examplelimit           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 author’s posts.

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

Argument       Required    Default    Description                  Examplelimit          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.1/posts/tag?tag={tag}&exclude_tags={exclude_tags}&limit={limit}&offset={offset}

Argument        Required    Default    Description                               Examplelimit           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.1/posts?ids={ids}

Argument    Required    Default    Description     Exampleids         yes         -          ids of posts    1,2,3

SITES’ DETAILS

Return sites' details.

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

Argument    Required    Default    Description    Examplesite_id     yes         -          site’s id      1

AUTHORS’ DETAILS

Return authors' details.

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

Argument        Required    Default    Description     Exampleids             yes         -          authors' ids    19access_token    yes         -          access token    bdQ0XiTDyR2eOsQHkCooS6CeBwgD4vAd81ux4UmTFx2qXfzeEphrCFGZuK8S5Fk6

AUTHORS’ DETAILS BY NAME

Return authors' details by name.

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

Argument        Required    Default    Description       Exampleauthor_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.1/authors/facebook?fb_ids={fb_ids}&access_token={access_token}

Argument        Required    Default    Description     Examplefb_ids          yes         -          facebook ids    19323283access_token    yes         -          access token    bdQ0XiTDyR2eOsQHkCooS6CeBwgD4vAd81ux4UmTFx2qXfzeEphrCFGZuK8S5Fk6

OVERALL POSTS STATS

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

Argument        Required    Description                               Restrictions                                                                       Exampleorder           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

Respons:

{    "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.1/insights/posts/details?period={period}&ids={ids}&access_token={access_token}

Argument        Required    Description                  Restrictions                                                                       Exampleperiod          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

Respons:

{    "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.1/insights/posts/wins/facebook?period={period}&ids={ids}&access_token={access_token}

Argument        Required    Description                  Restrictions                                                               Exampleperiod          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

Respons:

{    "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.1/insights/posts/wins/twitter?period={period}&ids={ids}&access_token={access_token}

Argument        Required    Description                  Restrictions                                                               Exampleperiod          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

Respons:

{    "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"            },            ...            ]        }    }}

How to Include Interactive Elements in Posts

Enhance your articles with rich and creative media

Every article is a fresh chance to grab new readers and nurture loyal followers. This is why we give creators every opportunity to build content rich with media elements that enhance every reader's experience.

Add More Layers to Your Content

You can easily add interactive elements, like charts, to posts on our platform. For example, if you need to embed iframe code into a post, this can be done via our Add Media Bar. To do so, click the code icon (< >):

A text box will appear so you can insert your code:

Embedded Code Across Platforms

One important thing to keep in mind is that Google AMP, AppleNews, and Facebook Instant Articles will not always support embedded code. So if you use an iframe, it's best to turn off distribution to those channels for that particular post. If you have a lot of posts that require embedded code, this could be problematic for growth across those important platforms.

If you do want to use an iframe on a post destined for Google AMP distribution, it can be possible if the iframe is not at the top of the page or within the first 75% of the viewport when the page is scrolled to the top (whichever is smaller). AMP is a fast technology designed for mobile users and iframes are loaded using arbitrary timing that AMP's technology cannot ensure. For this reason, it's suggested that iframes be included in places that are not visible by users upon load.

If you have an article that needs to include an iframe at the top of the page, or within the first 75% of the viewport, AMP can be turned off for that individual article within Entry Editor.

If you don't need an interactive chart to be interactive in nature, can turn it into an image and upload it directly to your post. This way it will work on all platforms, including Google AMP, Apple News, and Facebook Instant Articles. This option, when possible, is ideal to ensure you're optimized for page speed.

Take Advantage of Shortcodes

Another great way to embed media is through our shortcodes functionality. Click here to learn more about shortcodes. Shortcodes can also inserted using the Add Media Bar. Click the brackets icon ([ ]) to choose the shortcode you want to use.

Here's an example of a chart on an article page that's been inserted using a shortcode:

If you have any questions about how to add interactive elements to your content, please email support@rebelmouse.com or talk to your account manager today.

Shortcodes Dashboard: Dynamic Media in Just a Few Clicks

Create multidimensional content with easy-to-find shortcodes

We believe static media is dead, and that every piece of content should be multidimensional and engaging. This is why our platform enables creators so they can add dynamic media to their content in easy and efficient ways.

One simple way to add interactive content to any post is through the use of shortcodes. Shortcodes are small snippets of code that are easier to remember than longer sequences. They typically will activate a feature or embed media into an article.

Keep reading... Show less
Subscribe to Our Newsletter