Developer Central - API
About the API
The RetailMeNot.com Community Ideas API provides methods for obtaining data from this site for using in mashups and other consumable formats. Anyone can use the API -- all it takes is a 10 second signup process to obtain a key -- so we can keep track of how many people are using the API and a way to get in touch with you if there are changes to the API itself.
Getting Started
Basic Usage
Once you have an API Key all requests must have the apiKey parameter. Currently the output format is limited to JSON. We'll probably add HTML and XML as output formats in the future.
There are two modes you can use the JSON Output - if the parameter callback=jsonIdeaScaleAPI is passed, then the function will be called with the response as the parameter:
jsonIdeaScaleAPI(obj);
All you have to do is to define the jsonIdeaScaleAPI(obj) method in your JavaScript. The obj variable is the result of the method call. The best way to get started is to look at the Examples below:
If the parameter callback=true IS NOT PASSED, then the output will be a JSON Object - that you can parse with any JSON parser
{"response":
{"ideas":[{"author":"kevin.battey",
"text":"Welcome to your new IdeaScale portal!",
"title":"Your First Idea!",
"voteCount":0,
"url":"http://mycompany.ideascale.com/a/dtd/501-231"}]}}
Feedback
If you have questions/feedback and comments on the API, please join our IdeaScale API Discussion.
Bulk Data Download
If you would prefer to download all the data, for offline processing - you can request that below:
API Documentation
| ideascale.ideas.getTopIdeas | ideascale.ideas.getRecentIdeas | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Parameters |
categoryID (Optional)
If a campaign ID is supplied, then the data is filtered for that campaign. To view/list the campaigns for this site:
|
||||||||||
| Output | A JSON Array of "Idea" Objects - Each with the following properties | ||||||||||
| title | Idea Title | ||||||||||
| text | Idea Text Contents | ||||||||||
| author | Idea Author - If the author has updated the profile with his First and Last name it will be returned, or else the username part of the author's email address will be returned | ||||||||||
| URL | Link to the Idea | ||||||||||
| voteCount | Net votes count for the idea | ||||||||||
| Examples | |||||||||||
http://api.ideascale.com/a/api/ideascale.ideas.getTopIdeas?apiKey=
This will return a list of All Ideas - Sorted by Ratings (Votes) <script>
function jsonIdeaScaleAPI(obj) {
// obj is an Array of Idea Objects
for (int i = 0; i < obj.length; ++i) {
var idea = obj[i];
// Do Something here with each idea
}
}
</script>
|
|||||||||||
http://api.ideascale.com/a/api/ideascale.ideas.getRecentIdeas?apiKey=
This will return a list of All Ideas - Sorted by time (recent first) |
|||||||||||
| ideascale.tags.getTopTags | |||||||||||
| Output | A JSON Array of "Tag" Objects - Each with the following properties | ||||||||||
| name | The Tag Name | ||||||||||
| tagCount | The # of times this tag was used | ||||||||||
http://api.ideascale.com/a/api/ideascale.tags.getTopTags?apiKey=YOUR_API_KEY
This will return a list of the tags sorted by the frequency of use. |
|||||||||||
| ideascale.users.getTopUsers | |||||||||||
http://api.ideascale.com/a/api/ideascale.users.getTopUsers?apiKey=
This will return a list of All users (sorted by # of ideas they've contributed) |
|||||||||||
| Output | A JSON Array of "User" Objects - Each with the following properties | ||||||||||
| name | User Name - If the user has updated his profile with the First/Last name then this will be returned | ||||||||||
| ideaCount | The # of ideas user submitted | ||||||||||
| voteCount | The # of votes user submitted | ||||||||||
| url | The Profile URL for the user | ||||||||||
Social Web