Adgooroo API v2.0
Client Login
Home / SEMInsight / GetKeywordData
Description
This method retrieves PPC data for a keyword, displayed by advertiser. This is the equivalent of the PPC Keyword Detail Report/Show Advertisers Tab in SEM Insight. Coverage, average position, ranking, captured impressions, clicks, CTR, spend and missed impressions for the keyword are retrieved. The currency used in calculate Cost and CPC is set by the user in the website.

Info
Version:2
Quota Point Cost:20

Parameters
InputNameRequiredTypeDescription
searchengineidyesInt32Data 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.
regionidyesInt32Data 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.
keywordgroupidyesInt32Data 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.
keywordyesStringData 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.
startdatenoDateTimeThe start date for this report. Note: This value must be a within a maximum of 30 days of the end date.
enddatenoDateTimeThe end date for this report. Note: This value must be less than or equal to yesterday.
outputnoStringThis 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/GetKeywordData.api?searchengineid=1®ionid=1&keywordgroupid=1&keyword=miami+travel+packages&startdate=5%2f5%2f2011&enddate=5%2f5%2f2011

Example Output
// XML Output
<?xml version="1.0"?>
<api_result>
  <api_class>SEMInsight</api_class>
  <api_method>GetKeywordData</api_method>
  <quota_cost>0</quota_cost>
  <status>SUCCESS</status>
  <message />
  <value>
    <row>
      <url>adgooroo.com</url>
      <coverage>100</coverage>
      <avg_position>1.4</avg_position>
      <ranking>1</ranking>
      <captured_imps>102</captured_imps>
      <clicks>0.78</clicks>
      <ctr>0.034</ctr>
      <cpc>0.379</cpc>
      <cost>0.262</cost>
      <missed_imps>87</missed_imps>
      <est_spend>24.2</est_spend>
    </row>
  </value>
</api_result>


// JSON Output
{
  "api_class": "SEMInsight",
  "api_method": "GetKeywordData",
  "quota_cost": 0,
  "status": 0,
  "message": null,
  "value": {
    "row": [
      {
        "url": "adgooroo.com",
        "coverage": 100.0,
        "avg_position": 1.4,
        "ranking": 1.0,
        "captured_imps": 102.0,
        "clicks": 0.78,
        "ctr": 0.034,
        "cpc": 0.379,
        "cost": 0.262,
        "missed_imps": 87.0,
        "est_spend": 24.2
      }
    ]
  }
}


// CSV Output
url,coverage,avg_position,ranking,captured_imps,clicks,ctr,cpc,cost,missed_imps,est_spend
adgooroo.com,100,1.4,1,102,0.78,0.034,0.379,0.262,87,24.2