KeywordHistoricalPerformance Data Object - Ad Insight

Defines an object that contains the key performance index data for the specified keyword.

Syntax

XML

<xs:complexType name="KeywordHistoricalPerformance" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:sequence>
    <xs:element minOccurs="0" name="Keyword" nillable="true" type="xs:string" />
    <xs:element minOccurs="0" name="KeywordKPIs" nillable="true" type="tns:ArrayOfKeywordKPI" />
  </xs:sequence>
</xs:complexType>

JSON

{
  "Keyword": "ValueHere",
  "KeywordKPIs": [
    {
      "AdPosition": "ValueHere",
      "AverageBid": DoubleValueHere,
      "AverageCPC": DoubleValueHere,
      "Clicks": IntValueHere,
      "CTR": DoubleValueHere,
      "Device": "ValueHere",
      "Impressions": "LongValueHere",
      "MatchType": "ValueHere",
      "TotalCost": DoubleValueHere
    }
  ]
}

Elements

The KeywordHistoricalPerformance object has the following elements: Keyword, KeywordKPIs.

Element	Description	Data Type
Keyword	The keyword to which the keyword performance data applies.	string
KeywordKPIs	An array of KeywordKPI objects that contains the performance data. For each requested keyword that has no available data, the KeywordKPI element will be nil. If the request specified a specific target position, the array will contain only one item per requested keyword. If the request specified All for the target position, then for each requested keyword the array will contain an item for each possible position in the search results. Sidebar ads no longer serve on Bing owned and operated sites in the United States. If you only request first page data e.g., FirstPage1 for the United States (US), then this element will be nil/empty. If you include additional countries/regions e.g., US and CA in the same request, then any first page results are only attributed to countries/regions outside the United States.	KeywordKPI array

Requirements

Service: AdInsightService.svc v13
Namespace: https://bingads.microsoft.com/AdInsight/v13

Used By

GetHistoricalKeywordPerformance