Our REST API service uses key-based authorization that can be managed in your Account page. You can find your API key in the form of a 64-character string. But please note that we use this unique key to identify your account, so please do not share it with anyone.
All client requests are authorized using valid API keys via a specific HTTP header or query string. Query strings take priority over the HTTP header, so query strings will be considered if you send both at the same time.
Sending API Key via Query String
In order to authorize requests using the "
api_key" query string, you need to send it as follows:
The draft API supports creating drafts that can be used to publish content on your site.
Creating Drafts
Creates a draft and sets current user as author by default.
POST /api/1.3/drafts
Important
We provide another endpoint for backward compatibility with 1.1 API version, 1.3 is the preferred endpoint.
POST /api/1.1/posts
Parameters
Name
Type
Description
headline
String
Headline - Required
body
String
Body - Optional
manual_basename
String
Slug - Optional - It's automatically generated based on
headline, by default
subheadline
String
Subheadline - Optional
tags
Array of strings
Tags - Optional
primary_tag
String
Primary tag - Optional
sections
Array of strings
Sections - Optional
primary_section
String
Primary section - Optional
og_title
String
Social headline - Optional
og_description
String
Social description - Optional
image_id
Integer
ID of the uploaded image - Optional
photo_credit
String
Photo credit - Optional
manual_image_crops
Object
Crops calculated when uploading image - Optional
video
String
Video URL - Optional
listicle
Object
Listicles, refer to listicles document for more information - Optional
roar_author_ids
Array of integers
Author IDs - Optional
roar_specific_data
Object
Custom fields - Optional
created_ts
Integer
Publishing date - Optional - Defaults to timestamp for publish action
Note
primary_section and sections fields are eligible by title using insensitive case mode. "Home" can be passed if you want to set draft in homepage.
image_id can be found as id in Image API response when uploading or editing images.
manual_image_crops can be also found as manual_image_crops in Image API response when editing images.
In order to control the place where the listicles are going to be rendered inside the body, it's required to introduce a listicle HTML tag.
By default, roar_author_ids is automatically populated with the ID of the user identified with the API key sent in request.
Response
The response can contain several fields, but we would like to highlight some of them that were specially requested:
Name
Type
Description
post_url
String
URL of the draft when it's published
draft_url
String
Composited by
post_url + "?draft=1", which enables users to see the draft page
slug
String
URL path from
post_url
Editing Drafts
Edits a draft.
PUT /api/1.3/drafts/<id>
Parameters and Response
The same specification from creating drafts applies here.
Publishing Drafts
Publishes a draft.
PUT /api/1.3/drafts/<id>
Parameters and Response
In addition to the specification from updating drafts, an "action" parameter with value "publish" can be sent to API in order to publish a draft.
Name
Type
Description
action
String
Action to be performed.Optional.Choices:
"publish"
Note
draft_url is not returned in response payload when publishing a draft.
Stored data from the draft will be published if not received updated data is coming within request payload.
Posts API
The post API supports updating already published content, and unpublishing posts from site.
Editing Posts
Edits a post.
PUT /api/1.3/posts/<id>
Parameters
Name
Type
Description
headline
String
Headline - Required
body
String
Body - Optional
manual_basename
String
Slug - Optional - It's automatically generated based on
headline, by default
subheadline
String
Subheadline - Optional
tags
Array of strings
Tags - Optional
primary_tag
String
Primary tag - Optional
sections
Array of strings
Sections - Optional
primary_section
String
Primary section - Optional
og_title
String
Social headline - Optional
og_description
String
Social description - Optional
image_id
Integer
ID of the uploaded image - Optional
photo_credit
String
Photo credit - Optional
manual_image_crops
Object
Crops calculated when uploading image - Optional
video
String
Video URL - Optional
listicle
Object
Listicles, refer to listicles document for more information - Optional
roar_author_ids
Array of integers
Author IDs - Optional
roar_specific_data
Object
Custom fields - Optional
created_ts
Integer
Publishing date - Optional - Defaults to timestamp for publish action
Note
primary_section and sections fields are eligible by title using insensitive case mode. "Home" can be passed if you want to set draft in homepage.
image_id can be found as id in Image API response when uploading or editing images.
manual_image_crops can be also found as manual_image_crops in Image API response when editing images.
In order to control the place where the listicles are going to be rendered inside the body, it's required to introduce a listicle HTML tag.
By default, roar_author_ids is automatically populated with the ID of the user identified with the API Key sent in request.
Response
The response can contain several fields, but would like to highlight some of them that were specially requested:
Name
Type
Description
post_url
String
URL for the draft when is published.
slug
String
URL path from
post_url.
Note
Unlike drafts API, posts API doesn't return draft_url in response payload unless post was unpublished.
Unpublishing Posts
Unpublishes a post.
PUT /api/1.3/posts/<id>
Parameters and Response
In addition to the specification from updating posts, an "action" parameter with value "unpublish" can be sent to API in order to unpublish a post.
Name
Type
Description
action
String
Action to be performed.Optional.Choices:
"unpublish"
Note
draft_url is returned in response payload when unpublishing a post.
Listicles
Our drafts API and posts API support listicles creation, listicles are a set of particles inside a post and you can control the place where they are going to be rendered inside the body by introducing a listicle HTML tag in post body parameter.
Parameters
Name
Type
Description
items
Array of objects
Items, particles of the listicle - Optional
settings
Object
Settings - Optional
Item Parameters
Name
Type
Description
headline
String
Headline - Optional
media
String
Media, usually a raw shortcode to be rendered above or below body - Optional
is_image
Boolean
For backward compatibility, it must be
true if media is an image - Optional
image_id
Integer
ID of the uploaded image - Optional
caption
String
Caption - Optional
credit
String
Photo credit - Optional
manual_image_crops
Object
Crops calculated when uploading image - Optional
body
String
Body - Optional
Note
image_id can be found as id in Image API response when uploading or editing images.
It's possible to use image shortcodes in media field, you can find them in "shortcode" field inside the payload responsewhen uploading images with Images API.
Setting Parameters
Name
Type
Description
body_text_above
Boolean
Controls body position above or below media.Optional. Defaults to
false.
layout_type
Integer
Layout type.Optional. Defaults to
1.Choices:
1: Regular listicle
2: Slideshow
3: Full screen
Example
The parameters described above should be sent as part of the payload for creating/updating drafts/posts, as the following:
{ "headline": "This is an awesome post!", "body": "<p>foo</p><listicle></listicle><p>bar</p>", "listicle": { "items": [ { "headline": "Listicle 1", "body": "Here is some content" } ], "settings": { "body_text_above": true } } }
Image API
The Image API supports uploading and editing images that could be used as splash post image, teaser, social teaser and even other features than posts such as authors creation.
Ratios
Every site in RebelMouse platform has its own image crops configured, these settings are useful when a image is going to be rezised or cropped. So they are considered in every process related to images, and each resized or cropped image has usually a different purpose depending on page type.
For runner sites, we have the following ratios configured:
Title
Code
Sizes
Super Wide
3x1
1200x400
600x200
Wide
2x1
1200x600
600x300
Medium
3x2
1200x800
600x400
Square
1x1
600x600
300x300
Tall
9x16
700x1245
Widescreen
16x9
1245x700
Uploading Images
Upload a image sending its content as a part of HTTP request body or sending a URL as part of a JSON document.
POST /api/1.3/images
Name
Type
Description
image_url
String
A image URL location - Optional
caption
String
Caption - Optional
photo_credit
String
Photo credit - Optional
alt
String
Alt/Title - Optional
Parameters
Name
Type
Description
image_url
String
A image URL location - Optional
caption
String
Caption - Optional
photo_credit
String
Photo credit - Optional
alt
String
Alt/Title - Optional
Note:
Multiple files can be also sent as part of HTTP request. These parameters are used only if image_url is not used in HTTP request.
For requests with "multipart/form-data" content type, files should be named with "file".
It takes the same schema for each image uploaded but in form of an array.
Editing Images
Editing an image for creating some others with certain dimensions.
PUT /api/1.3/images/<id>
Parameters
Name
Type
Description
image_url
String
A image URL location - Required
manual_image_crops
Object
Crop setting for resizing image - Optional
caption
String
Caption - Optional
photo_credit
String
Photo credit - Optional
Manual Image Cropping
Manual image cropping depends on the ratios that have been configured for the site. It must be an object, whose keys must be the ratio codes. The values should contain the following information:
It takes the same schema from uploading images. Only one image can be edited per request.
Webhooks
Webhooks allow you to receive notification of certain events from the RebelMouse platform. HTTP POST requests are performed for the configured URL you provide to us. These requests are formed with the following headers:
Our platform is a complete digital publishing toolbox that's built for modern-day content creators, and includes game-changing features such as our:
Why RebelMouse?
Unprecedented Scale
RebelMouse sites reach more than 120M people a month, with an always-modern solution that combines cutting-edge technology with decades of media savvy. And due to our massive scale, 1 in 3 Americans have visited a website powered by RebelMouse.
120M+ Users
550M+ Pageviews
17+ Avg. Minutes per User
6+ Avg. Pages per User
Today's Top Websites Use RebelMouse
Thanks to the tremendous scale of our network, we are able to analyze a wealth of traffic data that informs our strategies and allows us to be a true strategic partner instead of just a vendor.
What Clients Say
We’re here to help you weigh and understand every tech and strategic decision that affects
your digital presence. Spend less time managing everything yourself, and more time focused on
creating the quality content your users deserve.
From start to finish,
RebelMouse blasted away our expectations!
Kelley Beaucar Vlahos
Editorial Director
Responsible Statecraft
RebelMouse
brings the strengths of a large publisher (large datasets, expertise, lessons learned from trial and error, close
relationships with search and ad platforms) to smaller publishers. During the build and launch, the team went above
and beyond to ensure we were happy with the new site, and
they flawlessly migrated over 20,000 articles. I can't recommend them highly enough.
Ryan Koo
CEO
No Film School
I love the control panel. Awesome work. I have to say, what an amazing creative team RebelMouse is. I am so grateful!
Terrence O'Hanlon
Founder and Chairman
Reliabilityweb
It’s like we’ve been riding horses to commute all our lives and someone just showed us a Tesla.
Brendan Farley
Vice President, Product Management
Strada Education Network
Thanks to RebelMouse, United doesn’t have to sacrifice great content for speed. You can have both!
Ryan Bujeker
Director, Social Media Strategy & Digital Engagement
United Airlines
We're in a much better position to make it through the current crisis in part due to RebelMouse and their platform.
We've not only saved on overhead costs, we've more easily optimized our traffic with their smart measuring and SEO
tools, as well as their social integrations.
Jill Braff
President/Chief Operating Officer
Brit + Co
THANK YOU for all the good, fast work you put into making our public rollout such a big success. I know we threw a lot
at you very quickly, but you were calm under pressure and pulled it all off perfectly. Very glad to be working with
you all.
Tim Grieve
Executive Editor
Protocol
So inspired and impressed by these results from RebelMouse. Check them out and ask Andrea Breanna how they got there!
Just goes to show that spending millions doesn't necessarily get you to the right destination. It's spending no more
than you need on the right technology with the right platform that does! 🌐💙🏎️
Andrey Lipattsev
Partner Development Manager
Google
It is not often I jump out of my chair and scream in a positive way, but I just did! This is the happiest I have seen
my Managing Editor in 2021! Thank you.
Nick Smith
CEO
Investing News Network
Working with RebelMouse is an actual treat. From the CEO down, every single member of the team has partnered with us
to meet our needs. Everyone willingly (and with endless patience!) shares their expertise and insights to ensure we
optimize search and create a great audience experience. As we have implemented the various search tactics, positive
results are almost instantaneous. Training our content creators has been simple. The system is incredibly user
friendly. As a co-worker commented, "RebelMouse doesn't just sell you something, they partner with you to deliver
exactly what you want." I couldn't agree more!
Emma Schofield
Director of Change Management
Investing News Network
We continue to be huge fans of RebelMouse and envision a very long-term relationship with the platform. The service
has been impeccable.
Douglas Fischer
Executive Director
Environmental Health News
I am a HUGE RebelMouse fan, and basically tell everyone I meet who's looking to overhaul their website to get in touch
right away.
Susan Hassler
Editor Emeritus
IEEE Spectrum
Every member of the RebelMouse team, but especially our project team, are superstars! Our site launch on the platform
met all our expectations and we love the technology. We are positive about the future of our site and look forward to
improving our approaches and processes with RebelMouse's guidance!
Terrence O'Hanlon
Founder and Chairman
Reliabilityweb
RebelMouse's Layout & Design Tool is one of the most comprehensive and flexible tools I have ever used of any CMS.
Their product team is also extremely helpful and constantly supports to make sure your properties are up to date and
use the best industry standards, especially in terms of page speed.
Chuck Lapointe
CEO
Narcity Media
The best thing about RebelMouse is how much they care about their customers. When working with them, I always get a
sense that they go above and beyond for their customers. When working with the RebelMouse team, I very much consider
them to be a partner, rather than just a vendor. Upon migrating to their technology, we have seen tremendous
improvements in many key areas, particularly technical SEO. They have out-of-the-box functionality that is
tremendously helpful to customers. At the same time, their system is flexible enough to allow us to adapt it to any
new business needs that we have.
David Nguyen
Senior Director of Digital Marketing
Investing News Network
RebelMouse has shepherded us through the modernization phase, and has been keen, practical, and nimble throughout the
entire journey. They have helped modernize our website through an infinite scroll setup that allows us more
advertising real estate while creating more time on site to capture reader engagement. Plus, the RebelMouse team has
helped educate our own team on the various aspects of programmatic advertising and worked to best implement them.
Premier Guitar joining forces with RebelMouse in 2020 was one of the best choices we could have made!
Luke Viertel
Digital Strategist
Premier Guitar
RebelMouse has stepped up our content management process by providing a user-friendly interface, robust customization
options, and seamless collaboration tools. The platform's analytics and reporting capabilities have empowered us to
make data-driven decisions, while their exceptional customer support ensures any issues are promptly addressed in a
professional, respectful, and friendly way!
RebelMouse employs a unique, diverse, and decentralized team that consists of 70+ digital traffic experts across more
than 25 different countries. We have no central office, and we cover every time zone to ensure that we’re able
to deliver amazing results and enterprise-grade support around the clock.
Our team is well-versed in all things product, content, traffic, and revenue, and we strategically deploy ourselves to
help with each element across all of our clients. We thrive on solving the complex.