Get item-level performance report

Use the Items Performance Report API to retrieve a paginated and sorted item-level performance summary for the SEM campaign with a specified Campaign ID. You can specify the maximum number of items to return, the sorting order, and the filtering criteria, such as the field by which to filter the results. You'll get a detailed summary based on the specified filtering and sorting criteria.

Throttling

Request limits: 10 calls per minute per seller. You may receive an HTTP 429 error if you exceed this limit.

Endpoint

POST /v3/advertising/sem/campaigns/{campaignId}/item-level-summary

Sample request

curl --location 'https://marketplace.walmartapis.com/v3/advertising/sem/campaigns/123456789/item-level-summary' \
--header 'WM_SVC.NAME: Search Engine Marketing' \
--header 'WM_QOS.CORRELATION_ID: 7e9c771e-090e-4a0e-b484-b235cece77b0' \
--header 'WM_SEC.ACCESS_TOKEN: **********' \
--header 'Content-Type: application/json' \
--data '{ "page": { "offset": 0, "limit": 10 }, "sort": { "field": "adspend", "order": "DESC" }
}'

import requests url = 'https://marketplace.walmartapis.com/v3/advertising/sem/campaigns/123456789/item-level-summary'
headers = { 'WM_SVC.NAME': 'Search Engine Marketing', 'WM_QOS.CORRELATION_ID': '7e9c771e-090e-4a0e-b484-b235cece77b0', 'WM_SEC.ACCESS_TOKEN': '**********', 'Content-Type': 'application/json'
}
data = { "page": { "offset": 0, "limit": 10 }, "sort": { "field": "adspend", "order": "DESC" }
} response = requests.post(url, headers=headers, json=data) print(response.text)

Modify your code

Replace 123456789 in the URL with the actual campaign ID you want to use
Use your unique WM_QOS.CORRELATION_ID for each request.
Use your unique WM_SEC.ACCESS_TOKEN obtained from the Token API.
Optionally, you can update these parameters:
- offset- Replace 0 with a positive number to specify the starting point for fetching the records.
- limit - Replace 10 with a positive number to specify the maximum number of records to display per page. This value cannot exceed 200.
- field - Replace adspend with a field by which to sort the data.
  - You can sort fields by: [impressions, clicks, adspend, gmv, roas, cpc, ctr].
  - You can filter values by: [product name, duration, category name].
- order - Replace DESC with an order of sorting. For example, DESC for descending order and ASC for ascending order.

Sample response

{ "pagination": { "pageNo": 0, "pageSize": 10, "totalCount": 3, "totalPages": 1 }, "data": [ { "itemId": "5014488974", "sku": "sku_07144442400738_test", "productId": "1A2B3C4D5E", "productName": "Wireless Bluetooth Headphones", "categoryName": "Electronics", "productUrl": "/ip/Headphones/5014488974", "productImageUrl": "https://i5-qa.walmartimages.com/asr/dffe200d-117d-4804-a4de-aebbdbe7a616.ccd4b68eb51087086daf6c75197b214b.avif", "status": "OPTIMIZING", "olqScore": 95.0, "offerPrice": 150.0, "competitorPrice": 145.0, "googlePrice": 145.0, "traffic": { "impressions": 5000, "clicks": 250, "ctr": 0.05, "adspend": 150.0, "cpc": 0.6, "gmv": 600.0, "roas": 4.0 } }, { "itemId": "5014389813", "sku": "sku_00993001888299_test", "productId": "1YO2HKFIAB1E", "productName": "Womens Square Neck Ribbed Sweater Dress", "categoryName": "Clothing", "productUrl": "/ip/Sweater/5014389813", "productImageUrl": "https://i5-qa.walmartimages.com/asr/cc211564-bf4c-4810-8474-3b192a1c8631.e87331cdd32950f6f83a239743ea9816.jpeg", "status": "OPTIMIZING", "olqScore": 90.0, "offerPrice": 140.0, "competitorPrice": 135.0, "googlePrice": 140.0, "traffic": { "impressions": 4000, "clicks": 200, "ctr": 0.05, "adspend": 120.0, "cpc": 0.6, "gmv": 420.0, "roas": 3.5 } }, { "itemId": "5014389838", "sku": "sku_07148487515983_test", "productId": "2CZOV9ZBND06", "productName": "Low-Fat Milk", "categoryName": "Food & Beverage", "productUrl": "/ip/Milk/5014389838", "productImageUrl": "https://i5-qa.walmartimages.com/asr/030d9eed-3b2c-4d5f-baa3-55c82fa36e0a.5b1cc2147571bae5b3c62016c6220309.jpeg", "status": "LEARNING", "olqScore": 80.0, "offerPrice": 100.0, "competitorPrice": 95.0, "googlePrice": 105.0, "traffic": { "impressions": 3000, "clicks": 150, "ctr": 0.05, "adspend": 90.0, "cpc": 0.6, "gmv": 270.0, "roas": 3.0 } } ]
}

Result

You'll get a detailed performance report for all the items in a Campaign.