Schedule SERP
Last updated
Last updated
Below you will find a detailed description of the fields you can use for setting a task. All POST data should be sent in the JSON format (UTF-8 encoding). The task setting is done using the POST method when the array of tasks is sent into json format. We recommend to set up to 100 tasks at a time. Such limits were set due to the variations of task setting methods that you may use.
Requires authentication
POST https://api.serphouse.com/serp/schedule
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
Authorization*
String
Bearer <YOUR_API_KEY>
Content-Type*
String
application/json
q*
string
Search phrase that you want to search
domain*
string
Choose google ,bing or yahoo domain.
You can get the list of available search engines by making a separate request to the List of Search Engines
lang*
string
You can set language for e.g. en for english fr for french.
Get the list of available languages by making a separate request to the List of Language
device*
string
Device can be
desktop To extract desktop result
tablet To extract tablet result
mobile To extract mobile result
serp_type*
string
Serp type can be
web get structured json result search engines web result
news Get news result from search engines
image Search image over searchengines and get json result
loc*
string
Optional field if you specify loc_id
when choose yahoo domain then field is optional
You must choose one of the fields: loc_id or loc
You can receive the list of available locations of search engines with their loc_id by making a separate request to the List of Locations
loc_id*
integer
Optional field if you specify loc
you must choose one of the fields: loc_id or loc
You can receive the list of available locations of search engines with their loc_id by making a separate request to the
List of Locations
verbatim
integer
Set Google Verbatim search, Parameter value can be 0 or 1
gfilter
integer
Parameter defines if the filters for 'Similar Results' and 'Omitted Results' are on or off. It can be set to 1 (default) to enable these filters, or 0 to disable these filters.
page
integer
Define google/bing serp result page number
num_result
integer
Define number of result you want to get per page.
postback_url
url
return URL for sending task results
If you specify the Postback URL there will be no need to use Get SERP Tasks Results for obtaining results. We will send the result of a completed task by a POST request to the URL as soon as the task is completed. You can change your webhook setting from Webhook Settings Page.
pingback_url
url
Pingback URL is Notification URL of a completed task, When a task is completed we will notify you by GET request sent to the URL you have specified. You can change your webhook setting from Webhook Settings Page.
date_range
String
Sometimes you may want to only find information published during a specific time frame. To limit Google results by date
Parameter values can be comma seprated date range YYYY-MM-DD,YYYY-MM-DD OR
h Past hour
d Past 24 hours
w Past week
m Past month
y Past year