Social Media Monitoring API

The Rankur API is a RESTful web service. There are many tutorial on the web about REST (Representational State Transfer) abstraction on how to implement a client for particular service. If you are not familiar with the topic you might want to take a look at the following tutorial: www.restapitutorial.com

All calls to the interface require an API key, provided on your profile settings page. Currently the API covers the social media and web monitoring services and it is being expanded to all our modules like social media management, reporting, business dashboards, team workflow and team management.

 

Rate Limits

The maximum number of calls per 24h is set by default to 10 000 calls for all services except the ‘New Saved Search’ endpoint for which the limitation is set to 100 calls per 24h.

 

Echo Service

Echo service to test your account.

Parameters:

key
Required. Contains your API key.
echo
Required. Contains text to be echoed back.

Sample url request:

https://api.rankur.com/echo?key=[your API key]&echo=test

 

Get Saved Searches

Gets list of all saved searches with IDs that can later be used to retrieve results.

Parameters:

key
Required. Contains your API key.

Sample url request:

https://api.rankur.com/searches?key=[your API key]

 

Get Search Results

Gets list of recent search results.

Parameters:

key
Required. Contains your API key.
search_id
Required. The ID of saved search or folder, obtained through ‘Get Saved Searches’ service.
start_date
Optional. Filter results by providing start_date and end_date parameters. Date format is YYYY-MM-DD.
end_date
Optional. Filter results by providing start_date and end_date parameters. Date format is YYYY-MM-DD.

Sample url request:

https://api.rankur.com/results?key=[your API key]&search_id=[your saved search ID]

 

New Saved Search

Creates and executes new saved search of type ‘Keyword search’.

Parameters:

key
Required. Contains your API key.
name
Required. Contains the name of the saved search.
query
Required. Contains the search expression (value should be URL encoded).
sources
Optional. Contains list of available search source. Values are one of news, images, web, forums, videos, reviews, facebook, twitter, gplus.
Sample value: [news, web, facebook]
languages
Optional. Contains a list of language codes defining a language filter.
Sample value: [en, es, fr]
countries
Optional. Contains a list of country codes defining a geographic filter.
Sample value: [us, ca]
excluded_domains
Optional. Contains a list of excluded domain names.
Sample value: [spam.com, nonsense.com]
excluded_twitter_profiles
Optional. Contains a list of excluded twitter profiles.
Sample value: [spammer_profile1, unimportant_profile1, unimportant_profile2]

Sample url request:

https://api.rankur.com/add_search?key=[your API key]&name=big%20brand&query=%22Big%20Brand%22

Delete Saved Search

Removes saved search - available to While Label (Unlimited plan) subscribers.

Parameters:

key
Required. Contains your API key.
search_id
Required. The ID of saved search or folder, obtained through ‘Get Saved Searches’ service.

Sample url request:

https://api.rankur.com/delete_search?key=[your API key]&search_id=[your saved search ID]

Get Influencer Info

Gets list of influencers with mentions - available to While Label (Unlimited plan) subscribers.

Parameters:

key
Required. Contains your API key.
search_id
Required. The ID of saved search or folder, obtained through ‘Get Saved Searches’ service.
source
Optional. Contains one of available influence sources. Values are one of newsblogs, video, twitter.

Sample url request:

https://api.rankur.com/influencers?key=[your API key]&search_id=[your saved search ID]&source=twitter

Get Sentiment Widget Data

Provides the data of the sentiment dashboard widget and makes it available for further processing.

Parameters:

key
Required. Contains your API key.
search_id
Required. The ID of saved search or folder, obtained through ‘Get Saved Searches’ service.
start_date
Required. Filter results by providing start_date and end_date parameters. Date format is YYYY-MM-DD.
end_date
Required. Filter results by providing start_date and end_date parameters. Date format is YYYY-MM-DD.
timezone_minutes
Optional. Offset of your current time zone in minutes.

Sample url request:

https://api.rankur.com/sentiment_data?key=[your API key]&search_id=[your saved search ID]&start_date=[YYYY-MM-DD]&end_date=[YYYY-MM-DD]

Get Timeline Widget Data

Provides the data of the 'timeline' dashboard widget and makes it available for further processing.

Parameters:

key
Required. Contains your API key.
search_id
Required. The ID of saved search or folder, obtained through ‘Get Saved Searches’ service.
start_date
Required. Filter results by providing start_date and end_date parameters. Date format is YYYY-MM-DD.
end_date
Required. Filter results by providing start_date and end_date parameters. Date format is YYYY-MM-DD.
timezone_minutes
Optional. Offset of your current time zone in minutes.

Sample url request:

https://api.rankur.com/timeline_data?key=[your API key]&search_id=[your saved search ID]&start_date=[YYYY-MM-DD]&end_date=[YYYY-MM-DD]

Get Users - White Label plans

Gets list of all account users - available to While Label (Unlimited plan) subscribers.

Parameters:

key
Required. Contains your API key.

Sample url request:

https://api.rankur.com/wl_users?key=[your API key]

Add new user

Creates new user (client) for white labelled accounts - available to While Label (Unlimited plan) subscribers.

Parameters:

key
Required. Contains your API key.
email
Required. The email address of your user (must be unique)
username
Required. The username of your new user (must be unique)
password
Required. The password of your new user
search_limit
Optional. The maximum number of owned saved searches the user could create for monitoring social media and the Web.
folders_limit
Optional. The number of owned search folders the user could create to organize its saved searches.
dashboards_limit
Optional. The maximum number of owned social dashboards the user could create to visualize the data analysis.

Sample url request:

https://api.rankur.com/wl_user_aadd?key=[your API key]&email=test%40rankur.com&username=clientXYZ&password=ABCD

Activate suspended user

Activates suspended user (client) on white label plans - available to While Label (Unlimited plan) subscribers.

Parameters:

key
Required. Contains your API key.
username
Required. The username of your user

Sample url request:

https://api.rankur.com/wl_user_activate?key=[your API key]&username=clientXYZ

Suspend an active user

Suspended (client) user on white label plans - available to While Label (Unlimited plan) subscribers.

Parameters:

key
Required. Contains your API key.
username
Required. The username of your user

Sample url request:

https://api.rankur.com/wl_user_suspend?key=[your API key]&username=clientXYZ

Data Import

Import your own data - available to While Label (Unlimited plan) subscribers.

Parameters:

key
Required. Contains your API key.
data
Required. JSON array of data documents. Please contact support for details.

Sample url request:

https://api.rankur.com/data_import?key=[your API key]&data=json