Get all search analytics information
Applies to: Partner Center | Partner Center operated by 21Vianet | Partner Center for Microsoft Cloud for US Government
How to get all the search analytics information for your customers.
Prerequisites
- Credentials as described in Partner Center authentication. This scenario supports authentication with User credentials only.
REST request
Request syntax
| Method | Request URI |
|---|---|
| GET | {baseURL}/partner/v1/analytics/search HTTP/1.1 |
URI parameters
| Parameter | Type | Description |
|---|---|---|
filter |
string | Returns data matching the filter condition. Example: .../search?filter=field eq 'value' |
groupby |
string | Supports both terms and dates. Short circuit logic to limit the number of buckets. Example: .../search?groupby=termField1,dateField1,termField2 |
| aggregationLevel | string | The aggregationLevel parameter requires a groupby. The aggregationLevel parameter applies to all date fields present in the groupby. Example: .../search?groupby=termField1,dateField1,termField2&aggregationLevel=day |
top |
string | The page limit is 10000. Takes any value less than 10000. Example: .../search?top=100 |
skip |
string | Number of rows to skip. Example: .../search?top=100&skip=100 |
Request headers
For more information, see Partner Center REST headers.
Request body
None.
Request example
GET https://api.partnercenter.microsoft.com/partner/v1/analytics/search HTTP/1.1
Authorization: Bearer <token>
Accept: application/json
Content-Type: application/json
Content-Length: 0
REST response
If successful, the response body contains a collection of Search resources.
Response success and error codes
Each response comes with an HTTP status code that indicates success or failure and extra debugging information. Use a network trace tool to read this code, error type, and other parameters. For the full list, see Error Codes.
Response example
{
"companyName": "my company",
"contactButtonClicked": false,
"keywordCountry": null,
"detailsViewed": true,
"keywordIndustryFocus": null,
"mpnId": 2604568,
"partnerMarket": "CN",
"keywordProduct": null,
"referralSubmitted": false,
"searchDate": "2018-05-30",
"keywordSearchText": " my company"
}