Fetch keyword Analytics
Description
Use this method to allow API users to perform keyword research and analysis for advertisers.
Note: Time period considered for results is last 30 days and 90 days from the same day last year to factor in seasonality.
URL: POST/api/v1/keywordAnalytics
Query Parameters
| Parameter | Notes | Type | Required | Possible Values |
|---|---|---|---|---|
| advertiserId | ID of the advertiser | integer | Y | Unique numeric identifier |
| itemIds | List of item ids that are part of campaign Note: Max limit on number of item ids is 10 | string array | Y | List of the Ids of items |
Sample Request
curl -X POST \
'https://developer.api.stg.walmart.com/api-proxy/service/WPA/Api/v1/api/v1/keywordAnalytics' \
--header 'Authorization: Bearer <auth_token>' \ --header 'accept: application/json' \
--header 'WM_SEC.AUTH_SIGNATURE: ***********' \
--header 'WM_SEC.KEY_VERSION: 1' \ --header 'WM_CONSUMER.ID: adfwe-v23-faasd2r-afs-asdfqeff' \
--header 'WM_CONSUMER.intimestamp: 1565309779' \
--header 'Content-Type: application/json' \
--data '{ "advertiserId" : 600001, "itemIds": ["457690241", "567234678", " 534289123" ] }'
Response
| Element | Description | Type |
|---|---|---|
| itemId | Id of the item belonging to the campaign | string |
| normalizedQuery | A group of similar raw queries normalized into a single term by removing redundant information | string |
| rawQuery | Randomly chosen search keywords for a single item Note: maximum character length is 60 characters | string |
| itemKeywordFrequency | Number of times when keyword led to an item display. Item-keyword frequency is based on item’s appearance in first 5 search result pages or in top 200 results for the respective keywords Possible values are: High, Medium, Low | string |
| trafficKeywordFrequency | Based on number of times when a keyword was searched Possible values are: High, Medium, Low | string |
Sample Response
[ { "itemId": "45769024", "rawQuery": "key1", "normaliizedQuery": "key1 normalized", "itemKeywordFrequency": "Medium", "trafficKeywordFrequency": "High" }
]
Updated about 2 months ago