Adgooroo API v2.0
Client Login
Home / SEMInsight / GetHistoricalCoverageAndRank
Description
This method retrieves an advertiser's coverage and rank for a keyword, displayed by day.

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.
keywordyesStringThe keyword for which data will be displayed. Only one keyword can be input.
advertisersyesStringA list of advertisers for which data will be displayed. Up to 20 advertisers can be input if their names are seperated by commas. Example: ford.com,chevrolet.com
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/GetHistoricalCoverageAndRank.api?searchengineid=1®ionid=1&keywordgroupid=15000&keyword=cars&advertisers=cars.com%2ctrucks.com%2ctrains.com&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>GetHistoricalCoverageAndRank</api_method>
  <quota_cost>0</quota_cost>
  <status>SUCCESS</status>
  <message />
  <value>
    <row>
      <keyword>car</keyword>
      <regionId>1</regionId>
      <searchEngineId>1</searchEngineId>
      <observationtime>5/1/2010</observationtime>
      <website>cars.com</website>
      <avgrank>0.1</avgrank>
    </row>
  </value>
</api_result>


// JSON Output
{
  "api_class": "SEMInsight",
  "api_method": "GetHistoricalCoverageAndRank",
  "quota_cost": 0,
  "status": 0,
  "message": null,
  "value": {
    "row": [
      {
        "keyword": "car",
        "regionId": 1.0,
        "searchEngineId": 1.0,
        "observationtime": "5/1/2010",
        "website": "cars.com",
        "avgrank": 0.1
      }
    ]
  }
}


// CSV Output
keyword,regionId,searchEngineId,observationtime,website,avgrank
car,1,1,5/1/2010,cars.com,0.1