api documentation (crowdsearch.me)crowdsearch.me/crowdsearchapidocv3.0.pdf · table of contents 1....
TRANSCRIPT
API Documentation
(CrowdSearch.me)
Version 3.0
Created by CrowdSearch Team
Table of Contents
1. Api Url
2. Api Definitions
2.1. List of Search Engine
2.2. List of Campaign Groups
2.3. List of Campaigns
2.4. Create a Campaign
2.5. Create Multiple Campaign
2.6. Create a Direct Traffic Campaign
2.7. Turn On Smart Rank for a campaign
2.8. Turn Off Smart Rank for a campaign
2.9. Activate a campaign
2.10. Deactivate a campaign
2.11. Get the list of activity of a campaign (last 10)
2.12. Delete a campaign
2.13. Get the credit spent data for the user
2.14. Get the credit spent data for a campaign
2.15. Sign Up
2.16. Login
2.17. Login With Facebook
2.18. Delete Campaign Group
2.19. Get All Settings
2.20. List of Geo Countries
2.21. List of Geo States
2.22. List of Geo Cities
2.23. Get All Notifications
2.24. Move Campaign To group
2.25. Create Keyword Finder Campaign
2.26. Create PBN Link Campaign
2.27. Edit Campaign (Single , Multiple and Keyword Finder)
2.28. Edit PBN Link Campaign
2.29. Get Result from Semrush in Keyword Finder Campaign
2.30. Get Result By Keyword Finder ID
1. API URL: http://crowdsearch.me/api/v3/ 2. API Definitions
2.1 List of Search Engine To get the list of supported search engines. URL: http://crowdsearch.me/api/v3/searchengines?api_key=XXXYYYZZZ Method: GET
Url Parameter Description Data type/Values Required/optional
api_key User’s API key string required
type Search Engine Type string (bing/yahoo/google/youtube)
optional
Example Response (success):
status code: 200 response body :
“result”: [ "id": "1", "name": "google.com", "locale": "esus", "url": "https://www.google.com", "database": "us", "description": "United States Spanish", "status": "1", "created_at": "20141013 14:38:46" ]
Example Response (error):
status code : 400 response body:
message: "Invalid api_key", errors: []
2.2 List of Campaign Groups To get the list of campaigns corresponding to the api_key URL : http://crowdsearch.me/api/v3/campaigngroup?api_key=XXXYYYZZZ Method : GET
Url Parameter
Description Data type/Value
Required/optional
api_key User’s API key string required
pagination Set this to 1 when pagination is required (default 1) Integer / (0,1) optional
per_page Number of record per page (default 10) Integer (1n) optional
page Set the current page (default 1) Integer (1n) optional Example Response (success):
status code: 200 response body:
result: [ "name": "Uncategorized", "id": "0", "user_id": "1", "no_of_campaigns": "197", "daily_credits_spent": "4.00", "total_credits_spent": "153.00", "overall_keyword_movement": 621 , "id": "21", "name": "My Group 31", "user_id": "1", "status": "1", "deleted": "0", "created_at": "20151228 12:12:01", "updated_at": "00000000 00:00:00", "no_of_campaigns": 0, "daily_credits_spent": 0, "total_credits_spent": 0, "overall_keyword_movement": 0 ], "metaData":
"total": "1774", "per_page": 10, "current_page": 1
Example Response (error): status code : 400 response body :
message: "Invalid api_key", errors: []
2.3 List of Campaign
To get the list of campaigns corresponding to the api_key URL : http://crowdsearch.me/api/v3/campaign?api_key=XXXYYYZZZ Method : GET
Url Parameter
Description Data type/Value
Required/optional
api_key User’s API key string required
pagination Set this to 1 when pagination is required (default 1) Integer / (0,1) optional
per_page Number of record per page (default 10) Integer (1n) optional
page Set the current page (default 1) Integer (1n) optional Example Response (success):
status code: 200 response body:
result: [ id: "1", “name”: "My Campaign #1", “website_url”: “http://crowdsearch.me”, “smart_rank”: “off”, “daily_credit_cost”: “1”, “daily_credits_spent”: “0” , id: "2", “name”: "My Campign #2 ", “website_url”: 'sahusoft.com', “smart_rank”: 'off', “daily_credit_cost”: “1”, “daily_credits_spent”: “0”
], "metaData":
"total": "1774", "per_page": 10, "current_page": 1
Example Response (error): status code : 400 response body :
message: "Invalid api_key", errors: []
2.4 Create a Campaign To get the list of campaigns corresponding to the api_key URL : http://crowdsearch.me/api/v3/createcampaign?api_key=XYZ Method : POST
Url Parameter Description Data type Required/optional
api_key User’s API key string required Request payload params (JSON)
Description Data Type/Values
Required/optional
name Campaign name String Required
website_url url of the website String Required
keyword Keyword to be searched String Required
direct_traffic Direct browse campaign (1/0) optional
br_search_engine_id Choose a search engine for searching the keyword See api/v1/searchengines
integer optional(required if using google search engine)
br_bing_search_engine_id Choose a Bing search engine for searching the keyword See api/v1/searchengines
String optional(required if using bing search engine)
br_yahoo_search_engine_id Choose a Yahoo search engine for
searching the keyword See api/v1/searchengines
String optional(required if using yahoo search engine)
br_youtube_search_engine_id Choose a Youtube search engine for
searching the keyword See api/v1/searchengines
String optional(required if using youtube search engine)
internal_browsing Set this to ‘on’ to enable/disable randon_browsing
String / (on/off)
Required
is_bounce_back_enabled Percentage of visitor visting the website and bounce (leave the website)
String / (on/off)
Required
random_browsing Set this to ‘on’ to enable random opening any five link from the website. If set to ‘off’ array of internal browsing urls should be provided with maximun of five urls e.g array(“http://abc.com”,
“http://xyz.com”);
String / (on/off)
Required
internal_browsing_urls
Array containing urls for internal_browsing
Array / array( “http://abc.com”, “http://xyz.com”, );
random_browsing_start_point Set this to ‘on/off’ to enable/disable
random_browsing_start_point
String / (on/off) Optional
social_sharing Make this ‘on’ for twitter or facebook features
String / (on/off)
Required
retweets_per_month Number of tweet per month integer optional(required if social_sharing is ‘on’)
tweet_favourites_per_month Number of tweet to be marked as favourite per month
Integer optional ( required if social sharing is ‘on’)
search_boosts_per_day Number of search to run per day will be multiplied by 30 for a month
integer Required
minutes_spent_on_visit Number of minutes to spent on the website
integer Optional (required if search_boosts_per_month_google is empty and using google search engine)
match_exact Set this to 1 to exact match the website_url for searching
Integer/ (0,1)
Optional
post_enable_smart_rank Set this to 1 toEnable smart rank when the current rank is available (default 0)
Integer/ (0,1)
Optional
fb_likes_count Number of Likes required on the post or website per month
integer Optional
fb_shares_count Number of Likes shares on the post or website per month
integer Optional
yt_likes_count Number of Likes required on the post or website per month
integer Optional
yt_shares_count Number of Subscribes required on the post or website per month
integer Optional
yt_comment_status Make this ‘on’ for YouTube comment features
String / (on/off)
optional(required if social_sharing is ‘on’)
yt_comments Comment text for youtube separated by ‘|’
String optional(required if yt_comment_status is
‘on’)
yt_publish_count Number of comments to be published
integer Optional
yt_publish_interval Comment publish interval for YouTube according to yt_publish_count
String / (day / month /
year)
Optional
search_boosts_per_month_google
Number of search to run per month on google or you can send ‘search_boosts_per_day’ it will be multiplied by 30
integer / Minimum: 50
Optional(Required if using google and Not required if =‘search_boosts_per_day’ is provided)
search_boosts_per_month_bing
Number of search to run per month on bing
integer / Minimum: 50
Optional(required if using bing search engine)
search_boosts_per_month_yahoo
Number of search to run per month on yahoo
integer/ Minimum: 50
Optional(required if using yahoo search engine)
search_boosts_per_month_youtube
Number of search to run per month on youtube
integer/ Minimum: 50
Optional(required if using youtube search engine)
search_boosts_per_month_direct_traffic
Number of search to run per month on direct traffic
integer/ Minimum: 50
Optional(required if using direct traffic)
min_minutes_spent_on_visit_google
Min number of minutes to spent on
the website
integer Optional (required if using google search engine)
max_minutes_spent_on_visit_google
Max number of minutes to spent on
the website
integer Optional (required if using google search engine)
min_minutes_spent_on_visit_bing
Min number of minutes to spent on
the website
integer Optional(required if using bing search engine)
max_minutes_spent_on_visit_bing
Max number of minutes to spent on
the website
integer Optional(required if using bing search engine)
min_minutes_spent_on_visit_yahoo
Min number of minutes to spent on
the website
integer Optional(required if using yahoo search engine)
max_minutes_spent_on_visit_yahoo
Max number of minutes to spent on
the website
integer Optional(required if using yahoo search engine)
min_minutes_spent_on_visit_youtube
Min number of minutes to spent on
the website
integer Optional(required if using youtube search engine)
max_minutes_spent_on_visit_youtube
Max number of minutes to spent on
the website
integer Optional(required if using youtube search engine)
advance_map_search Turn on/off advance map search String/ (on/off) optional
geo_location Turn on/off geo location search String/ (on/off) optional
geo_location_array Array of Geo Location Array [[country_iso_co
de, state_iso_code, city name]]
eg, [ [us, fl, orlando],
[us, fl, miami]
]
Optional (required if using geo_location On)
is_play_video_embeds Turn on/off play_video_embeds String/ (on/off) Optional
max_minutes_spent_to_watch_video_embeds
Maximum number of minutes to watch embedded video
integer/ Minimum: 0 Maximum: 7
Required if is_play_video_embeds is on
min_minutes_spent_to_watch_video_embeds
Minimum number of minutes to watch embedded video
integer/ Minimum: 0 Maximum: 7
Required if is_play_video_embeds is on
Example Response (success): status code: 200 response body:
result: id: 2929, name: Bangalore, user_id: 2, br_campaign_group_id: 21, website_url: http://india.com, keyword: indian, keyword_id: 0, bing_keyword_id: null, yahoo_keyword_id: null, youtube_keyword_id: null, br_search_engine_id: 1, br_bing_search_engine_id: , br_yahoo_search_engine_id: , br_youtube_search_engine_id: , smart_rank: on, search_boosts_per_day: 0, search_boosts_per_month_google: 0, search_boosts_per_month_bing: 0, search_boosts_per_month_yahoo: 0, search_boosts_per_month_youtube: 0, minutes_spent_on_visit: 0, minutes_spent_on_visit_google: 0, minutes_spent_on_visit_bing: 0, minutes_spent_on_visit_yahoo: 0,
minutes_spent_on_visit_youtube: 0, daily_credit_cost: 0, keyword_monthy_search_volume: null, starting_rank: 1, current_rank: 1, starting_rank_bing: 1, current_rank_bing: 1, starting_rank_yahoo: 1, current_rank_yahoo: 1, starting_rank_youtube: 1, current_rank_youtube: 1, week_best_rank_google: 1, month_best_rank_google: 1, week_best_rank_bing: 1, month_best_rank_bing: 1, week_best_rank_yahoo: 1, month_best_rank_yahoo: 1, week_best_rank_youtube: 1, month_best_rank_youtube: 1, total_credits_spent: , status: 1, created_at: 20160401:02:04:05, deleted: null, daily_credits_spent: null, internal_browsing: on, random_browsing: off, random_browsing_start_point: off, url_json: [\u0022url\u0022:\u0022off\u0022,\u0022random_browsing_start_point\u0022:false], match_exact: null, social_sharing: off, retweets_per_day: null, retweets_per_month: , tweet_favourites_per_day: null, tweet_favourites_per_month: , c_spent_today: null, c_spent_yesterday: null, c_spent_this_month: null, c_spent_last_month: null, is_bounce_back_enabled: off, api_created: 1, post_enable_smart_rank: 1, fb_likes_count: , fb_shares_count: , fb_comment_status: off, fb_comments: [\u0022comment\u0022:\u0022\u0022], geo_location: off, yt_likes_count: , yt_subscribes_count: , yt_comment_status: off, yt_comments: , yt_publish_count: , yt_publish_interval: month, is_play_video_embeds: on, minutes_spent_to_watch_video_embeds: 0, advance_map_search: off, geo_location_KW_tracking: off, geo_KW_tracking_country_iso_code: , geo_KW_tracking_subdivision_1_iso_code: null, geo_KW_tracking_city_name: null, direct_traffic: 0, minutes_spent_on_visit_direct_traffic: 3, search_boosts_per_month_direct_traffic: 10, starting_local_pack_rank_google: 1, week_best_local_pack_rank_google: 1, month_best_local_pack_rank_google: 1, current_local_pack_rank_google: 1, is_keyword_finder: false, is_pbn_link: false, maximum_visitor_count: null,
minimum_visitor_count: null, auto_keyword_update: on, min_minutes_spent_on_visit_google: 1, max_minutes_spent_on_visit_google: 1, min_minutes_spent_on_visit_bing: null, max_minutes_spent_on_visit_bing: null, min_minutes_spent_on_visit_yahoo: null, max_minutes_spent_on_visit_yahoo: null, min_minutes_spent_on_visit_youtube: null, max_minutes_spent_on_visit_youtube: null, min_minutes_spent_on_visit_direct_traffic: null, max_minutes_spent_on_visit_direct_traffic: null, min_minutes_spent_to_watch_video_embeds: 2, max_minutes_spent_to_watch_video_embeds: 4, keyword_finder_result_id: 0 , metaData: []
Example Response (error):
status code : 400 response body:
message: "Invalid api_key", errors: []
2.5 Create Multiple Campaigns
To get the list of campaigns corresponding to the api_key URL : http://crowdsearch.me/api/v3/createcampaign?api_key=XYZ Method : POST
Url Parameter Description Data type Required/optional
api_key User’s API key string required Request payload params (JSON)
Description Data Type/Values
Required/optional
name Campaign group name String Required
multiple_campaign For Multiple campaign Integer (1)
Required
website_url url of the website String Required
keyword Keyword to be searched ( seperated by ‘\n’ )
String Required
br_search_engine_id Choose a search engine for searching the keyword See api/v1/searchengines
integer optional(required if using google search engine)
br_bing_search_engine_id Choose a Bing search engine for searching the keyword See api/v1/searchengines
String optional(required if using bing search engine)
br_yahoo_search_engine_id Choose a Yahoo search engine for
searching the keyword See api/v1/searchengines
String optional(required if using yahoo search engine)
br_youtube_search_engine_id
Choose a Youtube search engine for
searching the keyword See api/v1/searchengines
String optional(required if using youtube search engine)
internal_browsing Set this to ‘on’ to enable/disable randon_browsing
String / (on/off)
Required
is_bounce_back_enabled Percentage of visitor visting the website and bounce (leave the website)
String / (on/off)
Required
random_browsing Set this to ‘on’ to enable random opening any five link from the website. If set to ‘off’ array of internal browsing urls should be provided with maximun of five urls e.g array(“http://abc.com”,
“http://xyz.com”);
String / (on/off)
Required
internal_browsing_urls
Array containing urls for internal_browsing
Array / array( “http://abc.com”, “http://xyz.com”, );
random_browsing_start_point
Set this to ‘on/off’ to enable/disable
random_browsing_start_point
String / (on/off) Optional
social_sharing Make this ‘on’ for twitter or facebook features
String / (on/off)
Required
retweets_per_month Number of tweet per month integer optional(required if social_sharing is ‘on’)
tweet_favourites_per_month Number of tweet to be marked as favourite per month
Integer optional ( required if social sharing is ‘on’)
search_boosts_per_day Number of search to run per day will be multiplied by 30 for a month
integer Required
minutes_spent_on_visit Number of minutes to spent on the website
integer Optional (required if search_boosts_per_month_google is empty and
using google search engine)
match_exact Set this to 1 to exact match the website_url for searching
Integer/ (0,1)
Optional
post_enable_smart_rank Set this to 1 toEnable smart rank when the current rank is available (default 0)
Integer/ (0,1)
Optional
fb_likes_count Number of Likes required on the post or website per month
integer Optional
fb_shares_count Number of Likes shares on the post or website per month
integer Optional
yt_likes_count Number of Likes required on the post or website per month
integer Optional
yt_shares_count Number of Subscribes required on the post or website per month
integer Optional
yt_comment_status Make this ‘on’ for YouTube comment features
String / (on/off)
optional(required if social_sharing is ‘on’)
yt_comments Comment text for youtube separated by ‘|’
String optional(required if yt_comment_status is ‘on’)
yt_publish_count Number of comments to be published
integer Optional
yt_publish_interval Comment publish interval for YouTube according to yt_publish_count
String / (day / month /
year)
Optional
search_boosts_per_month_google
Number of search to run per month on google or you can send ‘search_boosts_per_day’ it will be multiplied by 30
integer / Minimum: 50
Optional(Required if using google and Not required if =‘search_boosts_per_day’ is provided)
search_boosts_per_month_bing
Number of search to run per month on bing
integer / Minimum: 50
Optional(required if using bing search engine)
search_boosts_per_month_yahoo
Number of search to run per month on yahoo
integer/ Minimum: 50
Optional(required if using yahoo search engine)
search_boosts_per_month_youtube
Number of search to run per month on youtube
integer/ Minimum: 50
Optional(required if using youtube search engine)
min_minutes_spent_on_visit_google
Min number of minutes to spent on
the website
integer Optional (required if using google search engine)
max_minutes_spent_on_visit_google
Max number of minutes to spent on
the website
integer Optional (required if using google search engine)
min_minutes_spent_on_visit_bing
Min number of minutes to spent on
the website
integer Optional(required if using bing search engine)
max_minutes_spent_on_visit_bing
Max number of minutes to spent on
the website
integer Optional(required if using bing search engine)
min_minutes_spent_on_visit_yahoo
Min number of minutes to spent on
the website
integer Optional(required if using yahoo search engine)
max_minutes_spent_on_visit_yahoo
Max number of minutes to spent on
the website
integer Optional(required if using yahoo search engine)
min_minutes_spent_on_visit_youtube
Min number of minutes to spent on
the website
integer Optional(required if using youtube search engine)
max_minutes_spent_on_visit_youtube
Max number of minutes to spent on
the website
integer Optional(required if using youtube search engine)
advance_map_search Turn on/off advance map search String/ (on/off) optional
geo_location Turn on/off geo location search String/ (on/off) optional
geo_location_array Array of Geo Location ISO Code
Array [[country_iso_co
de, state_iso_code, city name]]
eg, [
Optional (required if using geo_location On)
[us, fl, orlando], [us, fl, miami]
]
Example Response (success): status code: 200 response body:
result: id: 2929, name: Bangalore, user_id: 2, br_campaign_group_id: 21, website_url: http://india.com, keyword: indian, keyword_id: 0, bing_keyword_id: null, yahoo_keyword_id: null, youtube_keyword_id: null, br_search_engine_id: 1, br_bing_search_engine_id: , br_yahoo_search_engine_id: , br_youtube_search_engine_id: , smart_rank: on, search_boosts_per_day: 0, search_boosts_per_month_google: 0, search_boosts_per_month_bing: 0, search_boosts_per_month_yahoo: 0, search_boosts_per_month_youtube: 0, minutes_spent_on_visit: 0, minutes_spent_on_visit_google: 0, minutes_spent_on_visit_bing: 0, minutes_spent_on_visit_yahoo: 0, minutes_spent_on_visit_youtube: 0, daily_credit_cost: 0, keyword_monthy_search_volume: null, starting_rank: 1, current_rank: 1, starting_rank_bing: 1, current_rank_bing: 1, starting_rank_yahoo: 1, current_rank_yahoo: 1, starting_rank_youtube: 1, current_rank_youtube: 1, week_best_rank_google: 1, month_best_rank_google: 1, week_best_rank_bing: 1, month_best_rank_bing: 1, week_best_rank_yahoo: 1, month_best_rank_yahoo: 1, week_best_rank_youtube: 1, month_best_rank_youtube: 1, total_credits_spent: , status: 1, created_at: 20160401:02:04:05, deleted: null, daily_credits_spent: null, internal_browsing: on, random_browsing: off, random_browsing_start_point: off, url_json: [\u0022url\u0022:\u0022off\u0022,\u0022random_browsing_start_point\u0022:false], match_exact: null, social_sharing: off, retweets_per_day: null, retweets_per_month: ,
tweet_favourites_per_day: null, tweet_favourites_per_month: , c_spent_today: null, c_spent_yesterday: null, c_spent_this_month: null, c_spent_last_month: null, is_bounce_back_enabled: off, api_created: 1, post_enable_smart_rank: 1, fb_likes_count: , fb_shares_count: , fb_comment_status: off, fb_comments: [\u0022comment\u0022:\u0022\u0022], geo_location: off, yt_likes_count: , yt_subscribes_count: , yt_comment_status: off, yt_comments: , yt_publish_count: , yt_publish_interval: month, is_play_video_embeds: on, minutes_spent_to_watch_video_embeds: 0, advance_map_search: off, geo_location_KW_tracking: off, geo_KW_tracking_country_iso_code: , geo_KW_tracking_subdivision_1_iso_code: null, geo_KW_tracking_city_name: null, direct_traffic: 0, minutes_spent_on_visit_direct_traffic: 3, search_boosts_per_month_direct_traffic: 10, starting_local_pack_rank_google: 1, week_best_local_pack_rank_google: 1, month_best_local_pack_rank_google: 1, current_local_pack_rank_google: 1, is_keyword_finder: false, is_pbn_link: false, maximum_visitor_count: null, minimum_visitor_count: null, auto_keyword_update: on, min_minutes_spent_on_visit_google: 1, max_minutes_spent_on_visit_google: 1, min_minutes_spent_on_visit_bing: null, max_minutes_spent_on_visit_bing: null, min_minutes_spent_on_visit_yahoo: null, max_minutes_spent_on_visit_yahoo: null, min_minutes_spent_on_visit_youtube: null, max_minutes_spent_on_visit_youtube: null, min_minutes_spent_on_visit_direct_traffic: null, max_minutes_spent_on_visit_direct_traffic: null, min_minutes_spent_to_watch_video_embeds: 2, max_minutes_spent_to_watch_video_embeds: 4, keyword_finder_result_id: 0 , metaData: []
Example Response (error):
status code : 400 response body:
message: "Invalid api_key", errors: []
NOTE: You could use all four search engines ,But using at least one search engine is a compulsory :
1. Google “br_search_engine_id”, a. If using this Required fields are: b. br_search_engine_id c. search_boosts_per_month_google (Minimum: 50) OR search_boosts_per_day (Will be
multiplied by 30) d. minutes_spent_on_visit OR minutes_spent_on_visit_google
2. Bing “br_bing_search_engine_id”, a. If using this Required fields are: b. br_bing_search_engine_id c. search_boosts_per_month_bing (Minimum: 50) d. minutes_spent_on_visit_bing
3. Yahoo “br_yahoo_search_engine_id”, a. If using this Required fields are: b. br_yahoo_search_engine_id c. search_boosts_per_month_yahoo (Minimum: 50) d. minutes_spent_on_visit_yahoo
4. Youtube “br_youtube_search_engine_id”, a. If using this Required fields are: b. br_youtube_search_engine_id c. search_boosts_per_month_youtube (Minimum: 50) d. minutes_spent_on_visit_youtube
If search_boost value for any engine is less than 50, it will be automatically saved as 50 i.e, minimum value.
2.6 Create a Direct Traffic Campaign To get the list of campaigns corresponding to the api_key URL : http://crowdsearch.me/api/v3/createcampaign?api_key=XYZ Method : POST
Url Parameter Description Data type Required/optional
api_key User’s API key string required Request payload params (JSON)
Description Data Type/Values
Required/optional
name Campaign name String Required
website_url url of the website String Required
direct_traffic Direct browse campaign Integer (1/0) 1 (For Direct
Traffic)
Required
internal_browsing Set this to ‘on’ to enable/disable randon_browsing
String / (on/off)
Required
random_browsing Set this to ‘on’ to enable random opening any five link from the website. If set to ‘off’
String / (on/off)
Required
array of internal browsing urls should be provided with maximun of five urls e.g array(“http://abc.com”,
“http://xyz.com”);
internal_browsing_urls
Array containing urls for internal_browsing
Array / array( “http://abc.com”, “http://xyz.com”, );
social_sharing Make this ‘on’ for twitter or facebook features
String / (on/off)
Required
retweets_per_month Number of tweet per month integer optional(required if social_sharing is ‘on’)
tweet_favourites_per_month Number of tweet to be marked as favourite per month
Integer optional ( required if social sharing is ‘on’)
fb_likes_count Number of Likes required on the post or website per month
integer Optional
fb_shares_count Number of Likes shares on the post or website per month
integer Optional
search_boosts_per_month_direct_traffic
Number of search to run per month on direct traffic
integer/ Minimum: 50
Optional(required if using direct traffic)
min_minutes_spent_on_visit_direct_traffic
Min number of minutes to spent on
the website
integer Optional(required if using direct traffic)
max_minutes_spent_on_visit_direct_traffic
Max number of minutes to spent on
the website
integer Optional(required if using direct traffic)
geo_location Turn on/off geo location search String/ (on/off) optional
geo_location_array Array of Geo Location Array [[country_iso_co
de, state_iso_code, city name]]
eg, [ [us, fl, orlando],
[us, fl,
Optional (required if using geo_location On)
miami] ]
Example Response (success): status code: 200 response body:
result: id: "1",
name: "My direct traffice Campaign #1", user_id: "1", br_campaign_group_id: “1”, website_url: "http://www.crowdsearch.me", keyword: "", keyword_id: "0", bing_keyword_id: "0", yahoo_keyword_id: "0", youtube_keyword_id: "0", br_search_engine_id: "0", direct_traffic: "1", br_bing_search_engine_id: "0", br_yahoo_search_engine_id: "0", br_youtube_search_engine_id: "0", smart_rank: "off", search_boosts_per_day: "0", search_boosts_per_month_google: 0, search_boosts_per_month_bing: 0, search_boosts_per_month_yahoo: 0, search_boosts_per_month_youtube: 0, search_boosts_per_month_direct_traffic: 50, minutes_spent_on_visit: "0",
minutes_spent_on_visit_google: "0", minutes_spent_on_visit_bing: 0,
minutes_spent_on_visit_yahoo: 0, minutes_spent_on_visit_youtube: 0, minutes_spent_on_visit_direct_traffic: 2, daily_credit_cost: "77", keyword_monthy_search_volume: "40", starting_rank: "1", current_rank: "1", starting_rank_bing: “1”, current_rank_bing: “1”, starting_rank_yahoo: “1”, current_rank_yahoo: “1”, starting_rank_youtube: “1”, current_rank_youtube: “1”, week_best_rank_google: “1”, month_best_rank_google:” 1”, week_best_rank_bing:” 1”, month_best_rank_bing: “1”, week_best_rank_yahoo: “1”, month_best_rank_yahoo: “1”, week_best_rank_youtube: “1”, month_best_rank_youtube: “1”, total_credits_spent: "32", status: "1", created_at: "20150227 19:42:08", deleted: "0", daily_credits_spent: "0", internal_browsing: "on", random_browsing: "on", url_json: "["url":null]", match_exact: "0", social_sharing: "off", retweets_per_day: "0", tweet_favourites_per_day: "0", c_spent_today: "2", c_spent_yesterday: "0",
c_spent_this_month: "2", is_bounce_back_enabled: "on", api_created: "1", post_enable_smart_rank: "1", fb_likes_count:”2”, fb_shares_count:”3”, yt_comment_status: "on" yt_comments: "["comment":"hello"]" yt_likes_count: 2 yt_publish_count: 1 yt_publish_interval: "month" yt_subscribes_count: 2, geo_location: off, advance_map_search: off, geo_location_array: [], direct_traffic: 1
Example Response (error):
status code : 400 response body:
message: "Invalid api_key", errors: []
2.7 Turn On Smart Rank for a campaign
API to turn on campaign smart rank corresponding to the api_key URL : http://crowdsearch.me/api/v3/campaignturnonsmartrank/campaign_id?api_key= XYZ Method : GET
Url Parameter Description Data type Required/optional
api_key User’s API key string required
campaign_id Id of the campaign to turn on smart rank Integer required Example Response (success):
status code: 200 response body:
result: "Smart Rank turned on for campaign #1”, metaData: [ ]
Example Response (error):
status code: 400 response body:
errors: null, message: "Cannot enable smart rank, current rank unavailable"
2.8 Turn Off Smart Rank for a campaign
API to turn on campaign smart rank corresponding to the api_key URL : http://crowdsearch.me/api/v3/campaignturnoffsmartrank/campaign_id?api_key=XYZ
Method : GET
Url Parameter Description Data type Required/optional
api_key User’s API key string required
campaign_id Id of the campaign to turn off smart rank integer required
Example Response (success): status code: 200 response body:
result: "Smart Rank turned off for campaign #1”, metaData: [ ]
Example Response (error):
status code: 400 response body:
message: "campaign does not exists of #5", errors: []
2.9 Activate a campaign
API to activate a campaign. URL : http://crowdsearch.me/api/v3/activatecampaign/campaign_id?api_key=XYZ Method : GET
Url Parameter Description Data type Required/optional
api_key User’s API key string required
campaign_id Id of the campaign to turn off smart rank integer required
Example Response (success):
status code: 200 response body:
result: "Campaign #1 activated successfully", metaData: [ ]
Example Response (error):
status code: 400 response body:
message: "campaign does not exists of #5", errors: []
2.10 Deactivate a campaign
API to deactivate a campaign. URL : http://crowdsearch.me/api/v3/deactivatecampaign/campaign_id?api_key=XYZ Method : GET
Url Parameter Description Data type Required/optional
api_key User’s API key string required campaign_id Id of the campaign to disable (inactive) Integer required
Example Response (success):
status code: 200 response body:
result: "Campaign #1 deactivated successfully", metaData: [ ]
Example Response (error):
status code: 400 response body:
message: "Invalid campaign #5", errors: []
2.11 Get the list of activity of a campaign (last 10)
API to get the activity of a campaign URL : http://crowdsearch.me/api/v3/campaignactivity/campaign_id?api_key=XYZ Method : GET
Url Parameter Description Data type Required/optional
api_key User’s API key string required
campaign_id Id of the campaign to disable (inactive) Integer required Example Response (success):
status code: 200 response body:
result: [ campaign_id : 1, website: "http://www.crowdsearch.me ", date: "3rd Mar 2015 ", time_spent: "3 mins ", time_spent_seconds: 180, text: "Trying to open: https://www.google.com \n Search for keyword sahusoft \n Google page 1 (38 seconds) \n Result found \n Visited website http://www.sahusoft.com (142 seconds) \n Completed All Process"
], metaData: [ ]
Example Response (error):
status code: 400 response body:
message: "Invalid campaign #5", errors: []
2.12 Delete a campaign
API to delete a campaign. URL : http://crowdsearch.me/api/v3/deletecampaign/campaign_id?api_key=XYZ Method : DELETE
Url Parameter Description Data type Required/optional
api_key User’s API key string required campaign_id Id of the campaign to disable (inactive) Integer required Example Response (success):
status code: 200 response body:
result: "Campaign #1 deleted successfully", metaData: [ ]
Example Response (error):
status code: 200 response body:
message: " Invalid campaign #5", errors: []
2.13 Get the credit spent data for the user
API to get credit data information. URL : http://crowdsearch.me/api/v3/getcreditdata?api_key=XYZ Method : GET
Url Parameter Description Data type Required/optional
api_key User’s API key string required Example Response (success):
status code: 200 response body:
result: user_credits:
balance: "393998", today_credits_spent: "2", yesterday_credits_spent: "0", monthly_credits_spent: "2"
, metaData: [ ]
Example Response (error):
status code: 400 response body:
message: "Invalid campaign #5", errors: []
2.14 Get the credit spent data for a campaign
API to get campaign credit data of a campaign. URL : http://crowdsearch.me/api/v3/getcampaigncreditdata/campaign_id?api_key=XYZ Method : GET
Url Parameter Description Data type Required/optional
api_key User’s API key string required
campaign_id Id of the campaign to disable (inactive) Integer required Example Response (success):
status code: 200 response body:
result: campaign_id: 5, total_credits_spent: 2, credits_spent_today: 0, credits_spent_yesterday: 0, credits_spent_in_current_month: 0, credits_spent_in_last_month: 0
, metaData: [ ]
Example Response (error):
status code: 400 response body:
message: "Invalid campaign #5", errors: []
2.15. Sign Up
API to get campaign credit data of a campaign. URL : http://crowdsearch.me/api/v3/auth/register Method : POST
Request payload params (JSON)
Description Data type Required/optional
email User’s Email Id string required
password User’s password string required
confirm_password User’s confirm password string required Example Response (success):
status code: 200 response body:
"result": "api_key": "46a6499cffebbc9844ed0ca1c97eabcb", "id": 5234, "display_name": "[email protected]", "email": "[email protected]", "is_limited": "1", "subscription_level_id": "1" , "metaData": []
Example Response (error):
status code: 400 response body:
"errors":"Sorry, that username already exists!","message":null
2.16. Login
API to get campaign credit data of a campaign. URL : http://crowdsearch.me/api/v3/auth/login Method : POST
Request payload params (JSON)
Description Data type Required/optional
email User’s Email Id string required
password User’s password string required Example Response (success):
status code: 200 response body:
"result": "api_key": "46a6499cffebbc9844ed0ca1c97eabcb", "id": 5234, "display_name": "[email protected]", "email": "[email protected]", "is_limited": "1", "subscription_level_id": "1" , "metaData": []
Example Response (error):
status code: 400 response body:
"errors":null, "message":"<strong>ERROR<\/strong>: The password you entered for the username
<strong>antondb<\/strong> is incorrect. <a href=\"http:\/\/crowdsearch.me\/wplogin.php?action=lostpassword\">Lost your password<\/a>?"
2.17. Login With Facebook
API to get campaign credit data of a campaign. URL : http://crowdsearch.me/api/v3/login/facebook Method : POST
Request payload params (JSON)
Description Data type Required/optional
email User’s Email Id string required
id ID from facebook string required Example Response (success):
status code: 200 response body:
"result": "api_key": "46a6499cffebbc9844ed0ca1c97eabcb", "id": 5234, "display_name": "[email protected]", "email": "[email protected]", "is_limited": "1", "subscription_level_id": "1" , "metaData": []
Example Response (error):
status code: 400 response body:
"errors":"Sorry, that username already exists!", "message":null
2.18 Delete Campaign Group
API to delete a campaign group. URL : http://crowdsearch.me/api/v3/deletecampaigngroup/campaign_group_id?api_key=XYZ Method : DELETE
Url Parameter Description Data type Required/optional
api_key User’s API key string required campaign_group_id
Id of the campaign group to disable (inactive)
Integer required
Example Response (success):
status code: 200 response body:
result: "Campaign Group deleted successfully", metaData: [ ]
Example Response (error):
status code: 200 response body:
message: " Invalid campaign group #5", errors: []
2.19. Get All Settings
API to get all settings URL: http://crowdsearch.me/api/v3/getsettings Method: GET Example Response (success):
status code: 200 response body :
"result": "video_image_url": "video_url": "http://crowdsearch.me/wpcontent/uploads/2015/07/videothumbnail.png", "embedded_code": "<iframe width=\u0022700\u0022 height=\u0022500\u0022 src=\u0022https://player.vimeo.com/video/134805984\u0022 frameborder=\u00220\u0022 allowfullscreen></iframe>" , "add_campaign_waiting_message": "Please wait.. We are collecting information..", "smart_rank_info": "SmartRank (recommended on) This Setting Optimizes Your Daily Search Boosts & Time On Site in relation to your Keyword Rank and Search Volume.", "keyword_search_volume_text": "Keyword Monthly Search Volume", "smart_rank_enable_message": "(Recommended On)", "smart_rank_disabled_message": "(Disabled due to nonavailability of current rank and/or low monthly search volume Please Use Manual Mode. We recommend 23 searches per day for low search volume keywords)", "email_subject_new_signup": "CrowdSearch.me Important Account Information", "email_body_new_signup": "<p>Your account has been created succesfully. <br /><br />\nAccount detail: <br />\nUsername: %%USER_NAME%%<br />\nEmail: %%USER_EMAIL%%<br />\nPassword: %%USER_PASSWORD%%<br />\n<br />Follow the link below to access your account.\n<br />http://CrowdSearch.me/dashboard</p>", "email_subject_add_credit": "CrowdSearch.me Credit Notice Your account has new credits.", "email_body_add_credit": "<p>Your account has been succesfully credited!<br /><br />\n%%CREDIT_AMOUNT%% credit(s) added to your account (%%USER_EMAIL%%) <br /><br />\n<br />Follow the link below to access your account.\n<br />%%SIGNUP_URL%%</p>", "email_header_new_user": "CrowdSearch.me Support <[email protected]>", "email_header_add_credit": "CrowdSearch.me Billing <no[email protected]>", "login_url": "http://crowdsearch.me/wplogin.php", "credit_to_usd_ratio": "0.01", "smart_rank_popup_text": "<p>SmartRank optimizes your daily CTR and Dwell Time according to your current keyword position relative to the monthly search volume of your keyword. SmartRank then adjusts automatically to optimize your campaign when your keyword rank changes.</p>\n<p>Based on your current rank position of <strong class=\u0022textsuccess\u0022>%%CURRENT_POSITION%%</strong> we have optimized your URL to receive approximately <strong class=\u0022textdanger\u0022>%%SEARCH_PER_DAY%%</strong> searches per day with an average time on site of approximately <strong class=\u0022textdanger\u0022>%%AVERAGE_SITE_TIME%%</strong> minutes\n<p>Approximate Daily Credit Consumption: <strong class=\u0022textdanger\u0022>%%DAILY_CERDIT%%</strong></p>\n<p class=\u0022textdanger\u0022><strong>NOTE*: Daily credit consumption is only an approximation as our algorithm randomizes daily searches and time on site to be natural.</strong></p>", "max_search_boosts_per_day_value": "250", "max_minutes_spent_on_visit_value": "15", "min_minute_on_site": "2", "max_minute_on_site": "15", "min_credit_limit_value": "50", "email_subject_credit_limit": "CrowdSearch.me: Credit Limit Alert", "email_body_credit_limit": "Hi,<br />\n<p>Your account with email %%USER_EMAIL%% is running on low credit(s) (crowdsearch.me). \n<br />\nPlease refill your account immediately to continue running your campaigns.<br />\n<br />\nYour current available credit is %%CURRENT_AVAILABLE_CREDIT%% credit(s) <br /><br />\n\nThanks!<br />\nCrowdsearch Support", "email_header_credit_limit": "CrowdSearch.me Billing <no[email protected]>", "search_result_timeout_text": "Note: its taking longer than expected to find the url for your keyword. Please create your campaign, we will update your keyword rank soon.", "retweet_credit_value": "5", "tweet_favourite_credit_value": "5", "social_sharing_info": "Receive Drip Fed Twitter and Facebook Social Signals to strengthen your campaign", "campaign_exact_url_text": "Selecting the \u201cExact\u201d checkbox will force CrowdSearch to only report back your inputted URL. (CrowdSearch will report back the first ranking URL for the entire domain by default).", "bounce_back_percentage": "50", "bounce_back_info_text": "This simply means that our searcher visited one of your competitors sites and then quickly returned to Google thereby demonstrating that their site did not provide the content they expected based on the search phrase. Your site will be visited after this with high Dwell Time which further shows Google your site is exactly what the searcher wanted. Cost Per Instance is 5 Credits", "facebook_like_credit_value": "10", "facebook_share_credit_value": "20", "facebook_comment_credit_value": "20", "facebook_comment_info": "Enter a unique comment per entry. (No links allowed).", "max_search_boosts_per_month_value": "15000", "search_volume_bing_factor": "25", "search_volume_yahoo_factor": "15",
"search_boost_min_factor": "40", "search_boost_max_factor": "160", "search_volume_youtube_factor": "35", "default_search_boosts_per_month": "5", "youtube_comment_info": "Enter YouTube Comments You Want Your URL to receive.", "youtube_like_credit_value": "10", "youtube_subscribe_credit_value": "50", "youtube_comment_credit_value": "50", "bounce_back_credit_value": "5", "geo_location_info": "Set the Geo Location(s) you want searches to originate", "geo_location_country_credit_value": "5", "geo_location_city_credit_value": "50", "geo_location_country_info": "You Can select multiple countries", "geo_location_city_info": "You can select multiple cities", "geo_location_state_info": "You can select multiple states", "geo_location_state_credit_value": "25", "mobile_tutorial_url": "https://www.youtube.com/e35595a821b24f5aacc4920e64a5fb06", "mobile_proxy_count_factor": "50", "mobile_proxy_max_count": "25", "mobile_terms_and_conditions": "Terms And Conditions", "mobile_upgrade_url": "http://crowdsearch.me", "mobile_app_install_bonus_credits": "200", "play_video_embeds_info": "Plays Embedded Video on Website", "mobile_add_credits_link": "http://crowdsearch.me", "geo_location_KW_tracking_info": "GEO Location Keyword Tracking", "advance_local_map_search_info": "Advance Local Map Search", "default_keyword_search_volume": "25" , "metaData": []
Example Response (error):
status code : 400 response body:
message: "", errors: []
2.20. List of Geo Countries To get the list of supported geo countries. URL: http://crowdsearch.me/api/v3/country?api_key=XXXYYYZZZ Method: GET
Url Parameter Description Data type/Values Required/optional
api_key User’s API key string required
Example Response (success): status code: 200 response body :
"result": [ "id": "4268", "geoname_id": "1128553", "locale_code": "en", "continent_code": "AS", "continent_name": "Asia", "country_iso_code": "AF", "country_name": "Afghanistan", "subdivision_1_iso_code": "ZAB",
"subdivision_1_name": "Zabul", "subdivision_2_iso_code": "", "subdivision_2_name": "", "city_name": "Rana", "metro_code": "", "time_zone": "Asia/Kabul" , "id": "854", "geoname_id": "363243", "locale_code": "en", "continent_code": "EU", "continent_name": "Europe", "country_iso_code": "AL", "country_name": "Albania", "subdivision_1_iso_code": "12", "subdivision_1_name": "Qarku i Vlores", "subdivision_2_iso_code": "SR", "subdivision_2_name": "Sarand\u00c3\u00ab District", "city_name": "Sarand\u00c3\u00ab", "metro_code": "", "time_zone": "Europe/Tirane" ]
Example Response (error):
status code : 400 response body:
message: "Invalid api_key", errors: []
2.21. List of Geo states
To get the list of supported geo states. URL: http://crowdsearch.me/api/v3/state?api_key=XXXYYYZZZ Method: GET
Url Parameter Description Data type/Values Required/optional
api_key User’s API key string required
country_iso_code Country ISO code string required
Example Response (success): status code: 200 response body :
"result": [ "id": "55434", "geoname_id": "4046255", "locale_code": "en", "continent_code": "NA", "continent_name": "North America", "country_iso_code": "US", "country_name": "United States", "subdivision_1_iso_code": "AL", "subdivision_1_name": "Alabama", "subdivision_2_iso_code": "", "subdivision_2_name": "", "city_name": "Bay Minette", "metro_code": "686", "time_zone": "America/Chicago"
, "id": "73988", "geoname_id": "5554072", "locale_code": "en", "continent_code": "NA", "continent_name": "North America", "country_iso_code": "US", "country_name": "United States", "subdivision_1_iso_code": "AK", "subdivision_1_name": "Alaska", "subdivision_2_iso_code": "", "subdivision_2_name": "", "city_name": "Juneau", "metro_code": "747", "time_zone": "America/Juneau" , "id": "72297", "geoname_id": "5284560", "locale_code": "en", "continent_code": "NA", "continent_name": "North America", "country_iso_code": "US", "country_name": "United States", "subdivision_1_iso_code": "AZ", "subdivision_1_name": "Arizona", "subdivision_2_iso_code": "", "subdivision_2_name": "", "city_name": "Dewey", "metro_code": "753", "time_zone": "America/Phoenix" ]
Example Response (error):
status code : 400 response body:
message: "Invalid api_key", errors: []
2.22. List of Geo Cities
To get the list of supported geo states. URL: http://crowdsearch.me/api/v3/city?api_key=XXXYYYZZZ Method: GET
Url Parameter Description Data type/Values Required/optional
api_key User’s API key string required
country_iso_code Country ISO code string required
state_iso_code State ISO Code string required
Example Response (success): status code: 200 response body :
"result": [ "ALL", "id": "55840",
"geoname_id": "4099116", "locale_code": "en", "continent_code": "NA", "continent_name": "North America", "country_iso_code": "US", "country_name": "United States", "subdivision_1_iso_code": "AR", "subdivision_1_name": "Arkansas", "subdivision_2_iso_code": "", "subdivision_2_name": "", "city_name": "Adona", "metro_code": "693", "time_zone": "America/Chicago" , "id": "55841", "geoname_id": "4099194", "locale_code": "en", "continent_code": "NA", "continent_name": "North America", "country_iso_code": "US", "country_name": "United States", "subdivision_1_iso_code": "AR", "subdivision_1_name": "Arkansas", "subdivision_2_iso_code": "", "subdivision_2_name": "", "city_name": "Alexander", "metro_code": "693", "time_zone": "America/Chicago" ]
Example Response (error):
status code : 400 response body:
message: "Invalid api_key", errors: []
2.23. Get All Notification To get the list of campaigns corresponding to the api_key URL : http://crowdsearch.me/api/v3/getnotification?api_key=XXXYYYZZZ Method : GET
Url Parameter
Description Data type/Value
Required/optional
api_key User’s API key string required
pagination Set this to 1 when pagination is required (default 1) Integer / (0,1) optional
per_page Number of record per page (default 10) Integer (1n) optional
page Set the current page (default 1) Integer (1n) optional Example Response (success):
status code: 200
response body: "result": [ "subscription_level_id": "0", "message": "Please ensure you are running the latest version so you can earn credits each day automatically.", "status": "completed", "created_at": "20151030 16:09:25" ], "metaData": "current_page": 1, "per_page": "1", "total": 1
Example Response (error): status code : 400 response body :
message: "Invalid api_key", errors: []
2.24. Move Campaign To group
API to move a campaign to group. URL : http://crowdsearch.me/api/v3/movecampaigntogroup/campaign_id?api_key=XYZ Method : GET
Url Parameter Description Data type Required/optional
api_key User’s API key string required campaign_id Id of the campaign to move(inactive) Integer required campaign_group_id
Id of the campaign group where to move(inactive)
Integer required
Example Response (success):
status code: 200 response body:
result: "Campaign Group deleted successfully", metaData: [ ]
Example Response (error):
status code: 200 response body:
message: " Invalid campaign group #5", errors: []
2.25. Create Keyword Finder Campaign
API to create a keyword finder campaign. URL : http://crowdsearch.me/api/v3/createkeywordfindercampaign?api_key=XYZ METHOD : POST
Url Parameter Description Data type Required/optional
api_key User’s API key string required Request payload params (JSON)
Description Data Type/Values
Required/optional
br_search_engine_id Choose a search engine for searching the keyword See api/v1/searchengines
integer optional(required if using google search engine)
br_bing_search_engine_id Choose a Bing search engine for searching the keyword See api/v1/searchengines
String optional(required if using bing search engine)
br_yahoo_search_engine_id Choose a Yahoo search engine for
searching the keyword See api/v1/searchengines
String optional(required if using yahoo search engine)
br_youtube_search_engine_id
Choose a Youtube search engine for
searching the keyword See api/v1/searchengines
String optional(required if using youtube search engine)
internal_browsing Set this to ‘on’ to enable/disable randon_browsing
String / (on/off)
Required
is_bounce_back_enabled Percentage of visitor visting the website and bounce (leave the website)
String / (on/off)
Required
random_browsing Set this to ‘on’ to enable random opening any five link from the website. If set to ‘off’ array of internal browsing urls should be provided with maximun of five urls e.g array(“http://abc.com”,
“http://xyz.com”);
String / (on/off)
Required
internal_browsing_urls Array containing urls for internal_browsing
Array / array( “http://abc.com”, “http://xyz.com”, );
random_browsing_start_point
Set this to ‘on/off’ to enable/disable
random_browsing_start_point
String / (on/off) Optional
social_sharing Make this ‘on’ for twitter or facebook features
String / (on/off)
Required
retweets_per_month Number of tweet per month integer optional(required if social_sharing is ‘on’)
tweet_favourites_per_month Number of tweet to be marked as favourite per month
Integer optional ( required if social sharing is ‘on’)
search_boosts_per_day Number of search to run per day will be multiplied by 30 for a month
integer Required
minutes_spent_on_visit Number of minutes to spent on the website
integer Optional (required if search_boosts_per_month_google is empty and using google search engine)
post_enable_smart_rank Set this to 1 toEnable smart rank when the current rank is available (default 0)
Integer/ (0,1)
Optional
fb_likes_count Number of Likes required on the post or website per month
integer Optional
fb_shares_count Number of Likes shares on the post or website per month
integer Optional
yt_likes_count Number of Likes required on the post or website per month
integer Optional
yt_shares_count Number of Subscribes required on the post or website per month
integer Optional
yt_comment_status Make this ‘on’ for YouTube comment features
String / (on/off)
optional(required if social_sharing is ‘on’)
yt_comments Comment text for youtube String optional(required if
separated by ‘|’ yt_comment_status is ‘on’)
yt_publish_count Number of comments to be published
integer Optional
yt_publish_interval Comment publish interval for YouTube according to yt_publish_count
String / (day / month /
year)
Optional
search_boosts_per_month_google
Number of search to run per month on google or you can send ‘search_boosts_per_day’ it will be multiplied by 30
integer / Minimum: 50
Optional(Required if using google and Not required if =‘search_boosts_per_day’ is provided)
search_boosts_per_month_bing
Number of search to run per month on bing
integer / Minimum: 50
Optional(required if using bing search engine)
search_boosts_per_month_yahoo
Number of search to run per month on yahoo
integer/ Minimum: 50
Optional(required if using yahoo search engine)
search_boosts_per_month_youtube
Number of search to run per month on youtube
integer/ Minimum: 50
Optional(required if using youtube search engine)
search_boosts_per_month_direct_traffic
Number of search to run per month on direct traffic
integer/ Minimum: 50
Optional(required if using direct traffic)
min_minutes_spent_on_visit_google
Min number of minutes to spent on
the website
integer Optional (required if using google search engine)
max_minutes_spent_on_visit_google
Max number of minutes to spent on
the website
integer Optional (required if using google search engine)
min_minutes_spent_on_visit_bing
Min number of minutes to spent on
the website
integer Optional(required if using bing search engine)
max_minutes_spent_on_visit_bing
Max number of minutes to spent on
the website
integer Optional(required if using bing search engine)
min_minutes_spent_on_visit_yahoo
Min number of minutes to spent on
integer Optional(required if using yahoo
the website search engine)
max_minutes_spent_on_visit_yahoo
Max number of minutes to spent on
the website
integer Optional(required if using yahoo search engine)
min_minutes_spent_on_visit_youtube
Min number of minutes to spent on
the website
integer Optional(required if using youtube search engine)
max_minutes_spent_on_visit_youtube
Max number of minutes to spent on
the website
integer Optional(required if using youtube search engine)
min_minutes_spent_on_visit_direct_traffic
Min number of minutes to spent on
the website
integer Optional(required if using direct traffic)
max_minutes_spent_on_visit_direct_traffic
Max number of minutes to spent on
the website
integer Optional(required if using direct traffic)
advance_map_search Turn on/off advance map search String/ (on/off) optional
geo_location Turn on/off geo location search String/ (on/off) optional
geo_location_array Array of Geo Location Array [[country_iso_co
de, state_iso_code, city name]]
eg, [ [us, fl, orlando],
[us, fl, miami]
]
Optional (required if using geo_location On)
selectedkeywordFinderId Array of Ids that has been selected
[2110, 2112, 2115]
Required
is_play_video_embeds Turn on/off play_video_embeds String/ (on/off) Optional
max_minutes_spent_to_watch_video_embeds
Maximum number of minutes to watch embedded video
integer/ Minimum: 0 Maximum: 7
Required if Is_play_video_embeds is on
min_minutes_spent_to_watch_video_embeds
Minimum number of minutes to watch embedded video
integer/ Minimum: 0 Maximum: 7
Required if Is_play_video_embeds is on
Example Response (success): status code: 200 response body:
result: id: "1",
user_id: "1", br_campaign_group_id: “0”, keyword_id: "1", bing_keyword_id: "1", yahoo_keyword_id: "1", youtube_keyword_id: "1", br_search_engine_id: "1", direct_traffic: "0", br_bing_search_engine_id: "1", br_yahoo_search_engine_id: "1", br_youtube_search_engine_id: "1", smart_rank: "off", search_boosts_per_day: "2", search_boosts_per_month_google: 60, search_boosts_per_month_bing: 50, search_boosts_per_month_yahoo: 50, search_boosts_per_month_youtube: 50, minutes_spent_on_visit: "7",
minutes_spent_on_visit_google: "7", minutes_spent_on_visit_bing: 7,
minutes_spent_on_visit_yahoo: 7, minutes_spent_on_visit_youtube: 7, daily_credit_cost: "77", keyword_monthy_search_volume: "40", starting_rank: "70", current_rank: "1", starting_rank_bing: “1”, current_rank_bing: “1”, starting_rank_yahoo: “1”, current_rank_yahoo: “1”, starting_rank_youtube: “1”, current_rank_youtube: “1”, week_best_rank_google: “1”, month_best_rank_google:” 1”, week_best_rank_bing:” 1”, month_best_rank_bing: “1”, week_best_rank_yahoo: “1”, month_best_rank_yahoo: “1”, week_best_rank_youtube: “1”, month_best_rank_youtube: “1”, total_credits_spent: "32", status: "1", created_at: "20150227 19:42:08", deleted: "0", daily_credits_spent: "0", internal_browsing: "on", random_browsing: "on", url_json: "["url":null]", match_exact: "0", social_sharing: "off", retweets_per_day: "0", tweet_favourites_per_day: "0", c_spent_today: "2", c_spent_yesterday: "0", c_spent_this_month: "2", is_bounce_back_enabled: "on", api_created: "1", post_enable_smart_rank: "1", fb_likes_count:”2”, fb_shares_count:”3”, yt_comment_status: "on"
yt_comments: "["comment":"hello"]" yt_likes_count: 2 yt_publish_count: 1 yt_publish_interval: "month" yt_subscribes_count: 2, geo_location: off, advance_map_search: off, geo_location_array: [], direct_traffic: 0, is_play_video_embeds : on, min_minutes_spent_on_visit_google: null, max_minutes_spent_on_visit_google: null, min_minutes_spent_on_visit_bing: null, max_minutes_spent_on_visit_bing: null, min_minutes_spent_on_visit_yahoo: null, max_minutes_spent_on_visit_yahoo: null, min_minutes_spent_on_visit_youtube: null, max_minutes_spent_on_visit_youtube: null, min_minutes_spent_on_visit_direct_traffic: 2, max_minutes_spent_on_visit_direct_traffic: 4, max_minutes_spent_to_watch_video_embeds : 1, max_minutes_spent_to_watch_video_embeds : 3, "seletedkeywordFinderId" :
"0" : "23269", "1" : "23270", "2" : "23271",
Example Response (error):
status code : 400 response body:
message: "Invalid api_key", errors: []
2.26. Create PBN Link Campaign
API to create a pbn campaign. URL : http://crowdsearch.me/api/v3/createpbnlinkcampaign?api_key=XYZ METHOD : POST
Url Parameter Description Data type Required/optional
api_key User’s API key string required Request payload params (JSON)
Description Data Type/Values
Required/optional
name Campaign name String Required
geo_location Turn on/off geo location search String/ (on/off) optional
geo_location_array Array of Geo Location Array [[country_iso_co
de, state_iso_code, city name]]
eg, [ [us, fl, orlando],
[us, fl, miami]
]
Optional (required if using geo_location On)
is_play_video_embeds Turn on/off play_video_embeds String/ (on/off) Optional
max_minutes_spent_to_watch_video_embeds
Maximum number of minutes to watch embedded video
integer/ Minimum: 0 Maximum: 7
Required if Is_play_video_embeds is on
min_minutes_spent_to_watch_video_embeds
Minimum number of minutes to watch embedded video
integer/ Minimum: 0 Maximum: 7
Required if Is_play_video_embeds is on
minimum_visitor_count Minimum number of visitor to visit the page
integer/ Minimum: 50 Maximum: 100
Required
maximum_visitor_count Maximum number of visitor to visit the page.
integer/ Minimum: 50 Maximum: 100
Required
urls List of xml url that need to be parsed.
[urls] => Array ( [0] =>
http://10thingstodo.com/sitemap_index.xml
)
Required
Example Response (success): status code: 200 response body:
"result": "id": 2922, "name": "Something", "user_id": "2", "br_campaign_group_id": "21",
"website_url": "", "keyword": null, "keyword_id": null, "bing_keyword_id": null, "yahoo_keyword_id": null, "youtube_keyword_id": null, "br_search_engine_id": "", "br_bing_search_engine_id": "", "br_yahoo_search_engine_id": "", "br_youtube_search_engine_id": "", "smart_rank": "", "search_boosts_per_day": 0, "search_boosts_per_month_google": 0, "search_boosts_per_month_bing": 0, "search_boosts_per_month_yahoo": 0, "search_boosts_per_month_youtube": 0, "minutes_spent_on_visit": 0, "minutes_spent_on_visit_google": 0, "minutes_spent_on_visit_bing": 0, "minutes_spent_on_visit_yahoo": 0, "minutes_spent_on_visit_youtube": 0, "daily_credit_cost": 0, "keyword_monthy_search_volume": null, "starting_rank": 1, "current_rank": 1, "starting_rank_bing": 1, "current_rank_bing": 1, "starting_rank_yahoo": 1, "current_rank_yahoo": 1, "starting_rank_youtube": 1, "current_rank_youtube": 1, "week_best_rank_google": 1, "month_best_rank_google": 1, "week_best_rank_bing": 1, "month_best_rank_bing": 1, "week_best_rank_yahoo": 1, "month_best_rank_yahoo": 1, "week_best_rank_youtube": 1, "month_best_rank_youtube": 1, "total_credits_spent": "", "status": "", "created_at": "20160401:02:04:06", "deleted": null, "daily_credits_spent": null, "internal_browsing": "off", "random_browsing": "on", "random_browsing_start_point": "off", "url_json": "[\"url\":\"\"]", "match_exact": null, "social_sharing": "off", "retweets_per_day": null, "retweets_per_month": "", "tweet_favourites_per_day": null, "tweet_favourites_per_month": "", "c_spent_today": null, "c_spent_yesterday": null, "c_spent_this_month": null, "c_spent_last_month": null, "is_bounce_back_enabled": "on", "api_created": 0, "post_enable_smart_rank": 0, "fb_likes_count": "", "fb_shares_count": "", "fb_comment_status": "off", "fb_comments": "[\"comment\":\"\"]", "geo_location": "off", "yt_likes_count": "", "yt_subscribes_count": "", "yt_comment_status": "off",
"yt_comments": "", "yt_publish_count": "", "yt_publish_interval": "month", "is_play_video_embeds": "on", "minutes_spent_to_watch_video_embeds": 0, "advance_map_search": "off", "geo_location_KW_tracking": "off", "geo_KW_tracking_country_iso_code": "", "geo_KW_tracking_subdivision_1_iso_code": null, "geo_KW_tracking_city_name": null, "direct_traffic": 0, "minutes_spent_on_visit_direct_traffic": 0, "search_boosts_per_month_direct_traffic": 0, "starting_local_pack_rank_google": 1, "week_best_local_pack_rank_google": 1, "month_best_local_pack_rank_google": 1, "current_local_pack_rank_google": 1, "is_keyword_finder": false, "is_pbn_link": true, "maximum_visitor_count": "65", "minimum_visitor_count": "65", "auto_keyword_update": "off", "min_minutes_spent_on_visit_google": null, "max_minutes_spent_on_visit_google": null, "min_minutes_spent_on_visit_bing": null, "max_minutes_spent_on_visit_bing": null, "min_minutes_spent_on_visit_yahoo": null, "max_minutes_spent_on_visit_yahoo": null, "min_minutes_spent_on_visit_youtube": null, "max_minutes_spent_on_visit_youtube": null, "min_minutes_spent_on_visit_direct_traffic": null, "max_minutes_spent_on_visit_direct_traffic": null, "min_minutes_spent_to_watch_video_embeds": "2", "max_minutes_spent_to_watch_video_embeds": "4", "keyword_finder_result_id": 0 , "metaData": []
Example Response (error):
status code : 400 response body:
message: "Invalid api_key", errors: []
2.27. Edit Campaign (Single, Multiple & Keyword Finder Campaign)
API to edit campaign. URL : http://crowdsearch.me/api/v3/editcampaign/campaign_id?api_key=XYZ METHOD : POST
Url Parameter Description Data type Required/optional
api_key User’s API key string required
campaign_id Id of the campaign to Integer required
update Request payload params (JSON)
Description Data Type/Values
Required/optional
name Campaign name String Required
internal_browsing Set this to ‘on’ to enable/disable randon_browsing
String / (on/off)
Required
is_bounce_back_enabled Percentage of visitor visting the website and bounce (leave the website)
String / (on/off)
Required
random_browsing Set this to ‘on’ to enable random opening any five link from the website. If set to ‘off’ array of internal browsing urls should be provided with maximun of five urls e.g array(“http://abc.com”,
“http://xyz.com”);
String / (on/off)
Required
internal_browsing_urls
Array containing urls for internal_browsing
Array / array( “http://abc.com”, “http://xyz.com”, );
social_sharing Make this ‘on’ for twitter or facebook features
String / (on/off)
Required
retweets_per_month Number of tweet per month integer optional(required if social_sharing is ‘on’)
tweet_favourites_per_month Number of tweet to be marked as favourite per month
Integer optional ( required if social sharing is ‘on’)
search_boosts_per_day Number of search to run per day will be multiplied by 30 for a month
integer Required
minutes_spent_on_visit Number of minutes to spent on the website
integer Optional (required if search_boosts_per_month_google is empty and using google search engine)
match_exact Set this to 1 to exact match the website_url for searching
Integer/ (0,1)
Optional
post_enable_smart_rank Set this to 1 toEnable smart rank when the current rank is available (default 0)
Integer/ (0,1)
Optional
fb_likes_count Number of Likes required on the post or website per month
integer Optional
fb_shares_count Number of Likes shares on the post or website per month
integer Optional
yt_likes_count Number of Likes required on the post or website per month
integer Optional
yt_shares_count Number of Subscribes required on the post or website per month
integer Optional
yt_comment_status Make this ‘on’ for YouTube comment features
String / (on/off)
optional(required if social_sharing is ‘on’)
yt_comments Comment text for youtube separated by ‘|’
String optional(required if yt_comment_status is ‘on’)
yt_publish_count Number of comments to be published
integer Optional
yt_publish_interval Comment publish interval for YouTube according to yt_publish_count
String / (day / month /
year)
Optional
search_boosts_per_month_google
Number of search to run per month on google or you can send ‘search_boosts_per_day’ it will be multiplied by 30
integer / Minimum: 50
Optional(Required if using google and Not required if =‘search_boosts_per_day’ is provided)
search_boosts_per_month_bing
Number of search to run per month on bing
integer / Minimum: 50
Optional(required if using bing search engine)
search_boosts_per_month_yahoo
Number of search to run per month on yahoo
integer/ Minimum: 50
Optional(required if using yahoo search engine)
search_boosts_per_month_youtube
Number of search to run per month on youtube
integer/ Minimum: 50
Optional(required if using youtube search
engine)
search_boosts_per_month_direct_traffic
Number of search to run per month on direct traffic
integer/ Minimum: 50
Optional(required if using direct traffic)
min_minutes_spent_on_visit_google
Min number of minutes to spent on
the website
integer Optional (required if using google search engine)
max_minutes_spent_on_visit_google
Max number of minutes to spent on
the website
integer Optional (required if using google search engine)
min_minutes_spent_on_visit_bing
Min number of minutes to spent on
the website
integer Optional(required if using bing search engine)
max_minutes_spent_on_visit_bing
Max number of minutes to spent on
the website
integer Optional(required if using bing search engine)
min_minutes_spent_on_visit_yahoo
Min number of minutes to spent on
the website
integer Optional(required if using yahoo search engine)
max_minutes_spent_on_visit_yahoo
Max number of minutes to spent on
the website
integer Optional(required if using yahoo search engine)
min_minutes_spent_on_visit_youtube
Min number of minutes to spent on
the website
integer Optional(required if using youtube search engine)
max_minutes_spent_on_visit_youtube
Max number of minutes to spent on
the website
integer Optional(required if using youtube search engine)
min_minutes_spent_on_visit_direct_traffic
Min number of minutes to spent on
the website
integer Optional(required if using direct traffic)
max_minutes_spent_on_visit_direct_traffic
Max number of minutes to spent on
the website
integer Optional(required if using direct traffic)
advance_map_search Turn on/off advance map search String/ (on/off) optional
geo_location Turn on/off geo location search String/ (on/off) optional
geo_location_array Array of Geo Location Array [[country_iso_co
Optional (required if using
de, state_iso_code, city name]]
eg, [ [us, fl, orlando],
[us, fl, miami]
]
geo_location On)
is_play_video_embeds Turn on/off play_video_embeds String/ (on/off) Optional
max_minutes_spent_to_watch_video_embeds
Maximum number of minutes to watch embedded video
integer/ Minimum: 0 Maximum: 7
Required if is_play_video_embeds is on
min_minutes_spent_to_watch_video_embeds
Minimum number of minutes to watch embedded video
integer/ Minimum: 0 Maximum: 7
Required if is_play_video_embeds is on
Example Response (success): status code: 200 response body:
"result": "id": 2922, "name": "Something", "user_id": "2", "br_campaign_group_id": "21", "website_url": "", "keyword": null, "keyword_id": null, "bing_keyword_id": null, "yahoo_keyword_id": null, "youtube_keyword_id": null, "br_search_engine_id": "", "br_bing_search_engine_id": "", "br_yahoo_search_engine_id": "", "br_youtube_search_engine_id": "", "smart_rank": "", "search_boosts_per_day": 0, "search_boosts_per_month_google": 0, "search_boosts_per_month_bing": 0, "search_boosts_per_month_yahoo": 0, "search_boosts_per_month_youtube": 0, "minutes_spent_on_visit": 0, "minutes_spent_on_visit_google": 0, "minutes_spent_on_visit_bing": 0, "minutes_spent_on_visit_yahoo": 0, "minutes_spent_on_visit_youtube": 0, "daily_credit_cost": 0, "keyword_monthy_search_volume": null, "starting_rank": 1, "current_rank": 1, "starting_rank_bing": 1, "current_rank_bing": 1, "starting_rank_yahoo": 1, "current_rank_yahoo": 1, "starting_rank_youtube": 1, "current_rank_youtube": 1, "week_best_rank_google": 1,
"month_best_rank_google": 1, "week_best_rank_bing": 1, "month_best_rank_bing": 1, "week_best_rank_yahoo": 1, "month_best_rank_yahoo": 1, "week_best_rank_youtube": 1, "month_best_rank_youtube": 1, "total_credits_spent": "", "status": "", "created_at": "20160401:02:04:06", "deleted": null, "daily_credits_spent": null, "internal_browsing": "off", "random_browsing": "on", "random_browsing_start_point": "off", "url_json": "[\"url\":\"\"]", "match_exact": null, "social_sharing": "off", "retweets_per_day": null, "retweets_per_month": "", "tweet_favourites_per_day": null, "tweet_favourites_per_month": "", "c_spent_today": null, "c_spent_yesterday": null, "c_spent_this_month": null, "c_spent_last_month": null, "is_bounce_back_enabled": "on", "api_created": 0, "post_enable_smart_rank": 0, "fb_likes_count": "", "fb_shares_count": "", "fb_comment_status": "off", "fb_comments": "[\"comment\":\"\"]", "geo_location": "off", "yt_likes_count": "", "yt_subscribes_count": "", "yt_comment_status": "off", "yt_comments": "", "yt_publish_count": "", "yt_publish_interval": "month", "is_play_video_embeds": "on", "minutes_spent_to_watch_video_embeds": 0, "advance_map_search": "off", "geo_location_KW_tracking": "off", "geo_KW_tracking_country_iso_code": "", "geo_KW_tracking_subdivision_1_iso_code": null, "geo_KW_tracking_city_name": null, "direct_traffic": 0, "minutes_spent_on_visit_direct_traffic": 0, "search_boosts_per_month_direct_traffic": 0, "starting_local_pack_rank_google": 1, "week_best_local_pack_rank_google": 1, "month_best_local_pack_rank_google": 1, "current_local_pack_rank_google": 1, "is_keyword_finder": false, "is_pbn_link": false, "maximum_visitor_count": "0", "minimum_visitor_count": "0", "auto_keyword_update": "off", "min_minutes_spent_on_visit_google": null, "max_minutes_spent_on_visit_google": null, "min_minutes_spent_on_visit_bing": null, "max_minutes_spent_on_visit_bing": null, "min_minutes_spent_on_visit_yahoo": null, "max_minutes_spent_on_visit_yahoo": null, "min_minutes_spent_on_visit_youtube": null, "max_minutes_spent_on_visit_youtube": null, "min_minutes_spent_on_visit_direct_traffic": null, "max_minutes_spent_on_visit_direct_traffic": null,
"min_minutes_spent_to_watch_video_embeds": "2", "max_minutes_spent_to_watch_video_embeds": "4", "keyword_finder_result_id": 0 , "metaData": []
Example Response (error):
status code : 400 response body:
message: "Invalid api_key", errors: []
2.28. Edit PBN Link Campaign
API to edit campaign. URL : http://crowdsearch.me/api/v3/editpbnlinkcampaign/campaign_id?api_key=XYZ METHOD : POST
Url Parameter Description Data type Required/optional
api_key User’s API key string required
campaign_id Id of the campaign to update
Integer required
Request payload params (JSON)
Description Data Type/Values
Required/optional
geo_location Turn on/off geo location search String/ (on/off) optional
geo_location_array Array of Geo Location Array [[country_iso_co
de, state_iso_code, city name]]
eg, [ [us, fl, orlando],
[us, fl, miami]
]
Optional (required if using geo_location On)
is_play_video_embeds Turn on/off play_video_embeds String/ (on/off) Optional
max_minutes_spent_to_watch_video_embeds
Maximum number of minutes to watch embedded video
integer/ Minimum: 0 Maximum: 7
Required if Is_play_video_embeds is on
min_minutes_spent_to_watch_video_embeds
Minimum number of minutes to watch embedded video
integer/ Minimum: 0 Maximum: 7
Required if Is_play_video_embeds is on
minimum_visitor_count Minimum number of visitor to visit the page
integer/ Minimum: 50 Maximum: 100
Required
maximum_visitor_count Maximum number of visitor to visit the page.
integer/ Minimum: 50 Maximum: 100
Required
Example Response (success): status code: 200 response body:
"result": "id": 2922, "name": "Something", "user_id": "2", "br_campaign_group_id": "21", "website_url": "", "keyword": null, "keyword_id": null, "bing_keyword_id": null, "yahoo_keyword_id": null, "youtube_keyword_id": null, "br_search_engine_id": "", "br_bing_search_engine_id": "", "br_yahoo_search_engine_id": "", "br_youtube_search_engine_id": "", "smart_rank": "", "search_boosts_per_day": 0, "search_boosts_per_month_google": 0, "search_boosts_per_month_bing": 0, "search_boosts_per_month_yahoo": 0, "search_boosts_per_month_youtube": 0, "minutes_spent_on_visit": 0, "minutes_spent_on_visit_google": 0, "minutes_spent_on_visit_bing": 0, "minutes_spent_on_visit_yahoo": 0, "minutes_spent_on_visit_youtube": 0, "daily_credit_cost": 0, "keyword_monthy_search_volume": null, "starting_rank": 1, "current_rank": 1, "starting_rank_bing": 1, "current_rank_bing": 1, "starting_rank_yahoo": 1, "current_rank_yahoo": 1, "starting_rank_youtube": 1, "current_rank_youtube": 1, "week_best_rank_google": 1, "month_best_rank_google": 1, "week_best_rank_bing": 1, "month_best_rank_bing": 1, "week_best_rank_yahoo": 1, "month_best_rank_yahoo": 1, "week_best_rank_youtube": 1, "month_best_rank_youtube": 1, "total_credits_spent": "",
"status": "", "created_at": "20160401:02:04:06", "deleted": null, "daily_credits_spent": null, "internal_browsing": "off", "random_browsing": "on", "random_browsing_start_point": "off", "url_json": "[\"url\":\"\"]", "match_exact": null, "social_sharing": "off", "retweets_per_day": null, "retweets_per_month": "", "tweet_favourites_per_day": null, "tweet_favourites_per_month": "", "c_spent_today": null, "c_spent_yesterday": null, "c_spent_this_month": null, "c_spent_last_month": null, "is_bounce_back_enabled": "on", "api_created": 0, "post_enable_smart_rank": 0, "fb_likes_count": "", "fb_shares_count": "", "fb_comment_status": "off", "fb_comments": "[\"comment\":\"\"]", "geo_location": "off", "yt_likes_count": "", "yt_subscribes_count": "", "yt_comment_status": "off", "yt_comments": "", "yt_publish_count": "", "yt_publish_interval": "month", "is_play_video_embeds": "on", "minutes_spent_to_watch_video_embeds": 0, "advance_map_search": "off", "geo_location_KW_tracking": "off", "geo_KW_tracking_country_iso_code": "", "geo_KW_tracking_subdivision_1_iso_code": null, "geo_KW_tracking_city_name": null, "direct_traffic": 0, "minutes_spent_on_visit_direct_traffic": 0, "search_boosts_per_month_direct_traffic": 0, "starting_local_pack_rank_google": 1, "week_best_local_pack_rank_google": 1, "month_best_local_pack_rank_google": 1, "current_local_pack_rank_google": 1, "is_keyword_finder": false, "is_pbn_link": true, "maximum_visitor_count": "65", "minimum_visitor_count": "65", "auto_keyword_update": "off", "min_minutes_spent_on_visit_google": null, "max_minutes_spent_on_visit_google": null, "min_minutes_spent_on_visit_bing": null, "max_minutes_spent_on_visit_bing": null, "min_minutes_spent_on_visit_yahoo": null, "max_minutes_spent_on_visit_yahoo": null, "min_minutes_spent_on_visit_youtube": null, "max_minutes_spent_on_visit_youtube": null, "min_minutes_spent_on_visit_direct_traffic": null, "max_minutes_spent_on_visit_direct_traffic": null, "min_minutes_spent_to_watch_video_embeds": "2", "max_minutes_spent_to_watch_video_embeds": "4", "keyword_finder_result_id": 0 , "metaData": []
Example Response (error):
status code : 400 response body:
message: "Invalid api_key", errors: []
2.28. Get Result From Semrush API
API to get result from Semrush in Keyword Finder Campaign. URL : http://crowdsearch.me/api/v3/keywordfinder?api_key=XYZ METHOD : POST
Url Parameter Description Data type Required/optional
api_key User’s API key string required Request payload params (JSON)
Description Data Type/Values
Required/optional
url Url whose keyword and ranking is needed
String Required
br_search_engine_id Choose a search engine for searching the keyword See api/v1/searchengines
integer optional(required if using google search engine)
br_bing_search_engine_id Choose a Bing search engine for searching the keyword See api/v1/searchengines
String optional(required if using bing search engine)
br_yahoo_search_engine_id Choose a Yahoo search engine for
searching the keyword See api/v1/searchengines
String optional(required if using yahoo search engine)
br_youtube_search_engine_id
Choose a Youtube search engine for
searching the keyword See api/v1/searchengines
String optional(required if using youtube search engine)
Example Response (success): status code: 200 response body :
"result":
"br_keyword_finder_id": 84 , "metaData": []
Example Response (error): status code : 400 response body:
message: "Invalid api_key", errors: []
2.30. Get Result By Keyword Finder ID
API to get Keyword Finder Result By Keyword Finder ID URL : http://crowdsearch.me/api/v3/getkeywordfinderresult?api_key=XYZ METHOD : GET
Url Parameter Description Data type Required/optional
api_key User’s API key string required
keyword_finder_id Id of keyword finder campaign whose result is required
integer required
Example Response (success): status code: 200 response body : "result": [ "id": "23995", "br_keyword_finder_id": "84", "user_id": "2", "url": "http://utoo.strapui.com/", "position": "12", "previous_position": "15", "keyword": "utoo", "search_volume": "480", "cpc": "0.35", "traffic": "85.71", "traffic_cost": "10.52", "competition": "0.08", "number_of_results": "516000", "trends": "1.00,1.00,0.81,0.81,0.81,0.81,0.81,0.66,0.81,0.66,0.66,0.66\r", "created_at": "20160404 00:24:19" , "id": "23996", "br_keyword_finder_id": "84", "user_id": "2", "url": "http://www.strapui.com/", "position": "15", "previous_position": "16",
"keyword": "dashboard themes", "search_volume": "210", "cpc": "11.51", "traffic": "14.28", "traffic_cost": "63.15", "competition": "0.11", "number_of_results": "105000000", "trends": "0.66,1.00,0.81,0.66,0.81,0.66,0.66,0.53,0.66,0.66,0.44,0.44\r", "created_at": "20160404 00:24:19" , "id": "23997", "br_keyword_finder_id": "84", "user_id": "2", "url": "http://www.strapui.com/", "position": "37", "previous_position": "40", "keyword": "admin bootstrap theme", "search_volume": "10", "cpc": "0", "traffic": "0", "traffic_cost": "0", "competition": "0.1", "number_of_results": "1160000", "trends": "0.50,0.50,1.00,1.00,0.50,1.00,0.50,1.00,1.00,0.50,1.00,0.50\r", "created_at": "20160404 00:24:19" , "id": "23998", "br_keyword_finder_id": "84", "user_id": "2", "url": "http://www.strapui.com/", "position": "14", "previous_position": "0", "keyword": "angularjs themes", "search_volume": "140", "cpc": "1.32", "traffic": "0", "traffic_cost": "5.26", "competition": "0.19", "number_of_results": "428000", "trends": "0.82,0.82,0.82,0.53,1.00,0.65,0.53,0.82,1.00,0.65,0.65,0.82\r", "created_at": "20160404 00:24:19" , "id": "23999", "br_keyword_finder_id": "84", "user_id": "2", "url": "http://www.strapui.com/", "position": "24", "previous_position": "21", "keyword": "bootstrap dashboard themes", "search_volume": "90", "cpc": "1.92", "traffic": "0", "traffic_cost": "0", "competition": "0.02", "number_of_results": "300000", "trends": "0.36,0.50,0.50,0.36,0.50,0.50,0.79,1.00,0.64,1.00,0.50,0.50\r", "created_at": "20160404 00:24:19" , "id": "24000", "br_keyword_finder_id": "84", "user_id": "2", "url": "http://www.strapui.com/", "position": "50", "previous_position": "85", "keyword": "bootstrap admin theme",
"search_volume": "320", "cpc": "1.49", "traffic": "0", "traffic_cost": "0", "competition": "0.08", "number_of_results": "942000", "trends": "0.67,0.82,0.67,0.67,0.82,0.82,1.00,0.82,0.67,0.82,0.82,0.82\r", "created_at": "20160404 00:24:19" , "id": "24001", "br_keyword_finder_id": "84", "user_id": "2", "url": "http://www.strapui.com/", "position": "70", "previous_position": "0", "keyword": "admin theme bootstrap free", "search_volume": "10", "cpc": "0", "traffic": "0", "traffic_cost": "0", "competition": "0", "number_of_results": "709000", "trends": "1.00,1.00,1.00,1.00,1.00,1.00,1.00,1.00,1.00,1.00,1.00,1.00\r", "created_at": "20160404 00:24:19" , "id": "24002", "br_keyword_finder_id": "84", "user_id": "2", "url": "http://www.strapui.com/", "position": "68", "previous_position": "0", "keyword": "bootstrap free admin theme", "search_volume": "10", "cpc": "0", "traffic": "0", "traffic_cost": "0", "competition": "0.05", "number_of_results": "683000", "trends": "1.00,1.00,1.00,1.00,1.00,1.00,1.00,1.00,1.00,1.00,1.00,1.00\r", "created_at": "20160404 00:24:19" , "id": "24003", "br_keyword_finder_id": "84", "user_id": "2", "url": "http://www.strapui.com/", "position": "75", "previous_position": "0", "keyword": "bootstrap ui theme", "search_volume": "10", "cpc": "0", "traffic": "0", "traffic_cost": "0", "competition": "0", "number_of_results": "804000", "trends": "0.50,0.50,0.50,0.50,1.00,0.50,0.50,0.50,0.50,0.50,0.50,0.50\r", "created_at": "20160404 00:24:19" , "id": "24004", "br_keyword_finder_id": "84", "user_id": "2", "url": "http://www.strapui.com/", "position": "25", "previous_position": "24", "keyword": "bootstrap themes admin", "search_volume": "30",
"cpc": "0", "traffic": "0", "traffic_cost": "0", "competition": "0.07", "number_of_results": "486000", "trends": "0.75,0.50,0.75,0.75,0.50,0.50,0.50,0.75,0.75,0.75,0.50,1.00\r", "created_at": "20160404 00:24:19" ], "metaData": "current_page": 1, "per_page": 10, "total": 10
Example Response (error):
status code : 400 response body:
message: "Invalid api_key", errors: []