Services

ProjectOrganicGetListRankingsFilter

Keyword rankings for a project or benchmark domain in organic search results with various filter options



Cost per row: 50.00

This call returns the rankings for the monitored keywords for a domain (either a project or a benchmark domain) in the organic search results in a given country, based on a given date.

The results contain a lot of additional information (please check result description), are orderd by estimated traffic in descending order and can be filtered by various options.

Please note: The API key for this call must be from the account that owns the queried project. API keys from invited users do not work.

Please note that a certain subscription level may be needed to use this call.



Parameter description

GET

ParameterDescription
project_id (required)ID of the project that should be queried.
The ID can be found in the URL when viewing the project in the Searchmetrics Suite

Format: integer
se_id (required)ID of the search engine that should be queried. A complete list of IDs can be found http://api.searchmetrics.com/api-calls/searchengines.
Please make sure your project includes the se_id.

Format: integer
url (required)Domains within the project that should be queried. Several domains must be separated with a comma without blank.
Please use the exact name that is used within the project. E.g "www.searchmetrics.com" instead of "searchmetrics.com".

Format: domain1.tld,domain2.tld
cpc_from (optional)Filter: Lowest estimated CPC for returned keywords.
E.g. if you want all keywords with a minimum estimated CPC of 1€ visitors this parameter has to be set to "1".

Format: integer
cpc_to (optional)Filter: Highest estimated CPC for returned keywords.
E.g. if you want all keywords with a maximum estimated CPC of 2 this parameter has to be set to "2".

Format: integer
date (optional)Date for which the rankings should be queried

Format: YYYYMMDD
limit (optional)Limit for the number of result rows
Permitted values are 10, 25, 50, 100, 250
Default is 10

Format: integer
offset (optional)Offset for result set
Must be a multiple of allowed values for the parameter "limit"
Default is 0

Format: integer
only_best_current (optional)Show only the best rankings

Format: integer
position_from (optional)Filter: Lowest ranking of keywords that should be returned.
E.g. if you want all keywords starting from the position 4 (meaning 4,5,6 etc.) this parameter has to be set to "4".

Format: integer
position_to (optional)Filter: Highest ranking of keywords that should be returned.
E.g. if you want all keywords up to position 3 ( resulting in all keywords with a SERP of 1, 2 or 3) this parameter has to be set to "3".

Format: integer
searchvolume_from (optional)Filter: Lowest monthly search volume in Google for returned keywords.
E.g. if you want all keywords with a minimum estimated search volume of 300 this parameter has to be set to "300".

Format: integer
searchvolume_to (optional)Filter: Highest estimated monthly search volume for returned keywords.
E.g. if you want all keywords with a maximum estimated monthly search volume of 1000 this parameter has to be set to "1000".

Format: integer
tags (optional)Comma separated list of tags. Please note: When using more than one tag only keywords with both tags will be included.

Format: tag1,tag2
traffic_from (optional)Filter: Lowest estimated traffic for returned keywords.
E.g. if you want all keywords with a minimum estimated traffic of 300 visitors this parameter has to be set to "300".

Format: integer
traffic_to (optional)Filter: Highest estimated monthly search volume for returned keywords.
E.g. if you want all keywords with a maximum estimated monthly search volume of 1000 this parameter has to be set to "1000".

Format: integer
trend_interval (optional)Set the time range for the trend comparisons. To compare the actual results with the last results use "last" (default). Other possible values are "weekly" (last week) and monthly (last month).

Format: string
type (optional)Universal search type. Possible values are universal, news, maps, video, images and shopping.

Format: string


Example

HTTP Request:
http://api.searchmetrics.com/v3/ProjectOrganicGetListRankingsFilter.json?project_id=1000&url=domain.tld&se_id=1&date=20130327&access_token=xxxxx

Response:
[
    {
        "keyword_id" : 559983,
        "pos" : [
                  {
                     "position" : 3,
                     "page" : 1,
                     "type_id" : 1,
                     "domain_id" : 38342582,
                     "host_id" :  26268024,
                     "directory" : "",
                     "url" : "www.homeaway.co.uk/",
                     "visibility" : 50,
                     "traffic" : 128,
                     "ad_budget" : 10.24,
                     "title" : "HomeAway: Holiday Rentals, Villas, Holiday Apartments & Cottages",
                     "usi" : 0,
                     "kd" : 61,
                     "traffic_volume" : 6675,
                     "cpc" : 0.08,
                     "delta_traffic" : -12,
                     "trend" : {
                                 "trend" : 0,
                                 "abs" : 0,
                                 "per" : 0
                               }

                 }

               ]

        "keyword" : "homeaway",
        "tags" : [],
        "delete_date" : 0,
        "date" : 20130320,
        "trend_date" : "20130313
    }

]


Result Description

KeyDescription
keywordKeyword
tagsTags that were given to this in keyword in the belonging project
delete_dateDate on which the keyword was deleted (if deleted)
dateActual date
trend_dateDate that is used for trend calculation / comparison (see parameter description)
positionRanking position of the keyword in the organic search
pageRanking page of the keyword in the organic search
directoryLast directory in the URL path of the entry in the organic ranking
urlURL of the entry in the organic ranking
trafficEstimation of traffic based on search volume and position
ad_budgetAdWords budget spent on the keyword in the last month in our database.
titleTitle of the entry in the search engine's organic ranking.
kdThe keyword difficulty is an indicator how easy it will be to optimize the specific keyword. 0 means very easy and 100 means very difficult.
traffic_volumeEstimated traffic volume per month.
cpcEstimated CPC for the keyword in EUR.
delta_trafficDifference in traffic in comparison to trend interval
trendThe element 'trend' can be interpreted as follows
* 0: no change
* 1: pointing up
* -1: going down

perthe relative/percentual change in the visibility in comparison to the parameter [trend_date]
absthe absolute change in the visibility in comparison to the to the parameter [trend_date]