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                  Example
limit       no          10         number of posts to return    1
offset      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                  Example
limit           no          10         number of posts to return    1
offset          no          0          number of posts to skip      10
section_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                  Example
limit          no          10         number of posts to return    1
offset         no          0          number of posts to skip      10
author_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                               Example
limit           no          10         number of posts to return                 1
offset          no          0          number of posts to skip                   10
roar_domain     yes         -          roar domain                               positivemouse
tag             yes         -          tag                                       python
exclude_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     Example
ids         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    Example
site_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     Example
ids             yes         -          authors' ids    19
access_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       Example
author_names    yes         -          authors' names    positivemouse
access_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     Example
fb_ids          yes         -          facebook ids    19323283
access_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                                                                       Example
order           yes         The field for results to be ordered by    Only "total_views" value is valid for now                                          total_views
period          yes         Period which ends now                     Only "1h", "6h", "12h", "24h", "7d", "30d", "lifetime" values are valid for now    7d
limit           yes         Number of records to return               Positive integer, Max value = 30                                                   10
offset          yes         Number of records to skip                 Non-negative integer                                                               5
access_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                                                                       Example
period          yes         Period which ends now        Only "1h", "6h", "12h", "24h", "7d", "30d", "lifetime" values are valid for now    7d
ids             yes         List of post IDs             Positive long numbers separated by comma, Max number = 30                          12312321,4859674589
access_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                                                               Example
period          yes         Period which ends now        Only "1h", "6h", "12h", "24h", "7d", "30d", "lifetime" values are valid    7d
ids             yes         List of post IDs             Positive long numbers separated by comma, Max number = 30                  12312321,4859674589
access_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                                                               Example
period          yes         Period which ends now        Only "1h", "6h", "12h", "24h", "7d", "30d", "lifetime" values are valid    7d
ids             yes         List of post IDs             Positive long numbers separated by comma, Max number = 30                  12312321,4859674589
access_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"
            },
            ...
            ]
        }
    }
}
Reply Oldest first
  • Oldest first
  • Newest first
  • Active threads
  • Popular
Like Follow
  • 3 yrs agoLast active
  • 297Views
  • 1 Following