Group Performance Report

Query-related campaign information according to the specified query conditions Campaign name, Active Status, and Date Range.

Resource URL

Newegg.com: https://api.newegg.com/marketplace/sponsoredmgmt/campaign/group/performance?sellerid={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.

Parameters

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
countryCode No String The ISO standard 3-digit codes of the country
extUrl Yes String Performance exact link
Available values

  • group/searchGroupByCampaign
campaignNumber No Integer The campaign identifier Number
type No Integer The campaign type. Available values:

  • 0 – manual targeting for product campaign
  • 1 – auto targeting for product campaign
sponsorType No Integer The type of sponsor of the campaign.
Available values

  • 0 – Sponsored Products
  • 1 – Sponsored Healines
  • 2 – Sponsored Video
  • 3 – Sponsor display
  • 4 – Offiste Ads
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 100 per page) (Default is 20)
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

POST https://api.newegg.com/marketplace/sponsoredmgmt/campaign/group/performance?sellerid={sellerid}
Content-Type: application/json
Accept: application/json
Authorization: 2d9da3949bdffd8594e9fa8a77764ce1
SecretKey: 55F55BC1-5E65-401B-BB1D-E29B0A19B734
 
 {
  "sellerId": "AK9Y",
  "countryCode": "USA",
  "extUrl": "group/searchGroupByCampaign",
  "campaignNumber": "449001",
  "type": null,
  "sponsorType": null,
  "searchKeywordType": null,
  "keyword": null,
  "activeStatus": null,
  "fromDate": "1970-01-01",
  "toDate": "2022-09-09",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 20,
    "sortField": "InDate",
    "sortType": "Desc"
  }
}

Response Body

Attribute
Format
Description
campaignNumber Integer The identifier of the campaign that the ad group is associated with
campaignName String The name of the campaign
groupNumber Integer The identifier of the ad group
groupName String The name of the group
countryCode String country Code
defaultBid Decimal The bid value used when no bid is specified for keywords in the group
offSiteBid Decimal off site bid value
type Integer The campaign Type
Available values:

  • 0 – manual targeting,
  • 1 – auto targeting
  • 2 – brand headlines manual
  • 3  -brand headlines auto
  • 4 – video manual
  • 5 – video auto
  • 6  – Sponsored Display – onsite
  • 7 – Sponsored Display – offsite
  • 8 – Newegg Offsite Ads
suggBid Decimal The bid recommendation
suggBidLowest Decimal The lower bound bid recommendation
suggBidMost Decimal The upper bound bid recommendation
keywordSize Integer The keyword count
keywordList String The keyword text.
productSize Integer The products count
productList String Products collection
sellerID String Your seller ID
sellerName String Your seller Name
activeStatus 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
status Enum The Group Status Description
Available values:

  • Pending
  • Delivering
  • Processing
  • Out of budget
  • Inactive
  • Ended
inDate String The creation date of the ad group
inUser Integer The creator of the ad group
logo String If campaign type for Headlines, value is Logo file’s name
headline String If campaign type for Headlines, value is headline URL
title String If campaign type for Headlines, the Head Lines entered by the UI are displayed below the Seller Logo
landingPageType Integer Available values:

  • 0:  Newegg store
  • 1:  Newegg Landing page input by seller
landingPageUrl String The landing Page Url
declineReason String campaign decline Reason
videoUrl String If campaign type for Video, show Video URL
costModel Integer Available values:

  • 0:  CPM
  • 1:  CPC
productTargetingList String The product Targeting List
liveStreamingProductList String The product list on the Live
spend Decimal spend amount on the campaign ad
sales Decimal Sales revenue on the campaign ad
ACoS Decimal campaign spend / campaign Sales revenue
impressions Integer the number of times the campaign shown
clicks Integer the number of clicks that the campaign receives
ctr Decimal CTR is the number of clicks that the campaign receives divided by the number of times your ad is impressions
orders Integer order count of  the campaign
cr Decimal Conversion rates
cpc Decimal cost-per-click
totalRows Integer Total number of the result

Example: Json, Response

{
  "header": [
    {
      "msg": "search groups success",
      "bizCode": "026"
    }
  ],
  "rows": [
    {
      "campaignNumber": 449001,
      "campaignName": "Cat6A plenum Bare Copper All",
      "groupNumber": 449002,
      "groupName": "Cat6a plenum Bare Copper",
      "countryCode": "USA",
      "defaultBid": null,
      "offSiteBid": null,
      "onSiteBid": null,
      "type": 1,
      "suggBid": null,
      "suggBidLowest": null,
      "suggBidMost": null,
      "keywordSize": 211,
      "keywordList": null,
      "productSize": 10,
      "productList": [
        "9SIAK9YDN88510",
        "9SIAK9YFA62671",
        "9SIAK9YFA62670",
        "9SIAK9YDRS1245",
        "9SIAK9YDRS1244",
        "9SIAK9YGRN6913",
        "9SIAK9YH889909",
        "9SIAK9YJFB3999",
        "9SIAK9YJFG6264",
        "9SIAK9YJFG6339"
      ],
      "sellerID": "AK9Y",
      "sellerName": "",
      "activeStatus": "Active",
      "status": "Delivering",
      "inDate": "Wed Feb 17 23:42:45 PST 2021",
      "inUser": "63722164",
      "logo": null,
      "headline": null,
      "title": null,
      "landingPageType": 0,
      "landingPageUrl": null,
      "declineReason": null,
      "videoUrl": null,
      "costModel": 0,
      "productTargetingList": null,
      "liveStreamingProductList": null,
      "spend": 932.24,
      "sales": 3616.87,
      "acos": 0.2577477210958647,
      "impressions": 27557,
      "clicks": 661,
      "ctr": 0.023986645861305656,
      "orders": 11,
      "cr": 0.01664145234493192,
      "cpc": 1.428174706649283
    }
  ],
  "totalRows": 1
}

Last updated: October 03, 2022