API Documentation - SEMInsight/GetNaturalKeywordData

Home / SEMInsight / GetNaturalKeywordData

Description

This method retrieves Natural data for a keyword, displayed by domain. This is the equivalent of the SEO Keyword Detail Report in SEM Insight. The landing page, rank, clicks, weekly/monthly change in rank, and maximum rank for each keyword are retrieved.

Info

Version:	2
Quota Point Cost:	20

Parameters

Input	Name	Required	Type	Description
	searchengineid	yes	Int32	Data will be returned only for the search engine input here. Only one search engine ID can be entered. Use the GetSearchEngines method to retrieve a list of search engine IDs.
	regionid	yes	Int32	Data will be returned only for the region input here. Only one region ID can be entered. Use the GetRegions method to retrieve a list of region IDs.
	keywordgroupid	yes	Int32	Data will be returned only for the keyword group input here. Only one keyword group ID can be entered. Use the GetKeywordGroups method to retrieve a list of keyword group IDs.
	keyword	yes	String	Data will be returned only for the keyword input here. Only one keyword can be entered. Use the GetGroups method to retrieve a list of keyword IDs.
	enddate	no	DateTime	The end date for this report. Note: This value must be less than or equal to yesterday. The start date will be 7 days earlier.
	output	no	String	This parameter specifies the output format of the API call. Possible values are XML, CSV or JSON. Default is XML.
	Note: Calling this API method will count against your monthly usage quota

Example Request

http://api.adgooroo.com/v2/SEMInsight/GetNaturalKeywordData.api?searchengineid=1®ionid=1&keywordgroupid=1&keyword=miami+travel+packages&enddate=5%2f5%2f2011

Example Output

// XML Output
<?xml version="1.0"?>
<api_result>
  <api_class>SEMInsight</api_class>
  <api_method>GetNaturalKeywordData</api_method>
  <quota_cost>0</quota_cost>
  <status>SUCCESS</status>
  <message />
  <value>
    <row>
      <keyword>cars</keyword>
      <domain>http://www.adgooroo.com</domain>
      <url>adgooroo.com</url>
      <rank>10</rank>
      <estimated_monthly_clicks>1500</estimated_monthly_clicks>
      <weekly>15</weekly>
      <lastcheck>Oct 11, 2010</lastcheck>
      <maxrank>20</maxrank>
    </row>
  </value>
</api_result>


// JSON Output
{
  "api_class": "SEMInsight",
  "api_method": "GetNaturalKeywordData",
  "quota_cost": 0,
  "status": 0,
  "message": null,
  "value": {
    "row": [
      {
        "keyword": "cars",
        "domain": "http://www.adgooroo.com",
        "url": "adgooroo.com",
        "rank": 10.0,
        "estimated_monthly_clicks": 1500.0,
        "weekly": 15.0,
        "lastcheck": "Oct 11, 2010",
        "maxrank": 20.0
      }
    ]
  }
}


// CSV Output
keyword,domain,url,rank,estimated_monthly_clicks,weekly,lastcheck,maxrank
cars,http://www.adgooroo.com,adgooroo.com,10,1500,15,"Oct 11, 2010",20