Product Performance Report

Get Performance Report according to the specified item Title, Active Status, and Date Range.

Resource URL{sellerid}

Note: Please make sure your request URL is all in lower case (except for Seller ID) and cannot contain any blank spaces or line breaks.


Name Required? Description
sellerid Yes Your seller ID on Newegg Marketplace

Resource Information

HTTP Method Authentication? Request Formats Response Formats Rate Limited?
POST Required Json Json 1000 request per hour

Request Body

Attribute Required? Format Description
sellerId Yes String Your seller ID on Newegg Marketplace
extUrl Yes String Performance exact link
Available values

  • product/searchItems
countryCode No String The ISO standard 3-digit codes of the country
campaignNumber Yes Integer The campaign identifier Number
groupNumber Yes Integer The ad group identifier
searchKeywordType No Enum Available values:

  • GROUP_NAME — fuzzy matching, keyword only supports a single
  • GROUP_NUM  — exact match, keyword input groupNumber is separated by commas to support batch query
keyword No String Restricts results to campaigns with the specified name.
activeStatus No Enum Restricts results to resources with state within the specified
Available values:

  • Active: Query the data of Processing, Delivering, Out of budget status
  • Inactive: Query the data of Inactive and Ended states
fromDate Yes String The starting date of the campaign
toDate Yes String The end date of the campaign
pageInfo pageIndex Yes Integer Current page index (Default is 1)
pageSize Yes Integer How many record(s) in a page (Max 9999999 per page)
sortField Yes String the field name of Sort, the default is InDate
sortType Yes String Default Desc, support Desc, Asc two sorting methods

Example: Json, Request

Content-Type: application/json
Accept: application/json
Authorization: 2d9da3949bdffd8594e9fa8a77764ce1
SecretKey: 55F55BC1-5E65-401B-BB1D-E29B0A19B734  
  "sellerId": "A2GS",
  "extUrl": "product/searchItems",
  "countryCode": "USA"
  "campaignNumber": "1295077",
  "groupNumber": "1295078",
  "searchKeywordType": null,
  "keyword": null,
  "activeStatus": null,
  "fromDate": "2022-09-09",
  "toDate": "2022-09-09",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 9999999,
    "sortField": "InDate",
    "sortType": "Desc"

Response Body

campaignNumber Integer The campaign identifier
campaignName String The campaign Name
groupNumber Integer The ad group identifier
groupName String The ad group Name
itemNumber String Newegg number of item
itemTitle String Web title of item
countryCode String The ISO standard 3-digit codes of the country
sellingPrice Decimal The actual selling price
primaryImgUrl String Primary Image URL
itemStatus Enum Available values:

itemLink String item PDP page link
sellerPartNumber String Seller Part#
sellerName String Seller Name
activeStatus Enum Available values:

  • Active
  • Inactive
status Enum The Product Status Description
Available values:

  • Pending
  • Delivering
  • Processing
  • Out of budget
  • Inactive
  • Ended
declineReason String The campaign decline reason
userId String The campaign  creation user ID
userName String The campaign creation user name
inDate String The keyword creation Date
inUser String The keyword creation user ID
liveStreamingPrice Decimal The price for live Streaming
liveStreamingNote String The note of live Streaming
spend Decimal spend amount on the product
sales Decimal Sales revenue on the product
ACoS Decimal product spend / campaign Sales revenue
impressions Integer the number of times the product shown
clicks Integer the number of clicks that the product receives
ctr Decimal CTR is the number of clicks that the product receives divided by the number of times your ad is impressions
orders Integer order count of  the product
cr Decimal Conversion rates
cpc Decimal cost-per-click
totalRows Integer Total number of the result

Example: Json, Response

  "header": [
      "msg": "search item success",
      "bizCode": "031"
  "rows": [
      "campaignNumber": 1295077,
      "campaignName": "SellerAPITest",
      "groupNumber": 1295078,
      "groupName": "1",
      "itemNumber": "9SIA2GSCXT9656",
      "itemTitle": "testXML",
      "countryCode": "USA",
      "sellingPrice": null,
      "primaryImgUrl": null,
      "itemStatus": "ENABLED",
      "itemLink": null,
      "sellerPartNumber": null,
      "sellerID": null,
      "sellerName": null,
      "activeStatus": "Active",
      "status": "Delivering",
      "declineReason": null,
      "userId": "A2GS",
      "userName": null,
      "inDate": "2022-07-19 02:47:08.920-0700",
      "inUser": "A2GS",
      "liveStreamingPrice": null,
      "liveStreamingNote": null,
      "costModel": null,
      "spend": 0,
      "sales": 0,
      "acos": 0,
      "impressions": 0,
      "clicks": 0,
      "ctr": 0,
      "orders": 0,
      "cr": 0,
      "cpc": 0
  "totalRows": 1

Last updated: October 03, 2022