Adgooroo API v1.0
Client Login
Home / PPCKeywordService / GetData
Description
Retrieves PPC data (broken out by individual advertisers) for a specified keyword.

Info
Version:1
Quota Point Cost:20

Parameters
InputNameRequiredTypeDescription
searchengineidyesInt32A valid AdGooroo Search Engine ID. Use Utilities.GetSearchEngines to retrieve a list of supported search engines.
regionidyesInt32A valid AdGooroo Region ID. Use Utilities.GetRegions to retrieve a list of supported regions.
keywordgroupidyesInt32A valid AdGooroo Keyword Group ID. Use Utilities.GetKeywordGroups to retrieve a list of the keyword groups for the current account.
keywordyesStringThe search term for which you would like to see data
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/v1/PPCKeywordService/GetData.api?searchengineid=1®ionid=1&keywordgroupid=1&keyword=miami+travel+packages&startdate=5%2f5%2f2009&enddate=5%2f5%2f2009

Example Output
// XML Output
<?xml version="1.0"?>
<api_result>
  <api_class>PPCKeywordService</api_class>
  <api_method>GetData</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": "PPCKeywordService",
  "api_method": "GetData",
  "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