Campaign 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/search?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 country for your Campaign. Only the ISO standard 3-digit codes are accepted. Like USA
searchKeywordType		No	Enum	Available values CAMPAIGN_NAME CAMPAIGN_NUM
keyword		No	String	If searchKeywordType for CAMPAIGN_NUM, the returned the identifier of the campaign If searchKeywordType for CAMPAIGN_NAME, the returned includes any campaign with the specified name using an fuzzy string match
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
displayType		No	Integer	If sponsorType = 3, Available values 2: On-site Product Targeting 3: Off-site Product Targeting
activeStatus		No	Enum	The returned is filtered to include only campaigns with one of the values Available values Active: Query the data of Processing, Delivering, Out of budget status Inactive: Query the data of Inactive and Ended states
fromDate		No	String	The starting date of the campaign.
toDate		No	String	The end date of the campaign.
pageInfo	pageIndex	No	Integer	Current page index (Default is 1)
	pageSize	No	Integer	How many record(s) in a page (Max 100 per page)
	sortField	No	String	the field name of Sort, the default is InDate.
	sortType	No	String	Default Desc, support Desc, Asc two sorting methods.

Example: Json, Request

POST https://api.newegg.com/marketplace/sponsoredmgmt/campaign/search?sellerid={sellerid}
Content-Type: application/json
Accept: application/json
Authorization: 2d9da3949bdffd8594e9fa8a77764ce1
SecretKey: 55F55BC1-5E65-401B-BB1D-E29B0A19B734
 
 
{
  "sellerId": "A2GS",
  "countryCode": null,
  "searchKeywordType": "CAMPAIGN_NUM",
  "keyword": null,
  "type": null,
  "sponsorType": null ,
  "activeStatus": null,
  "fromDate": "2022-06-01",
  "toDate":"2022-07-01",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 20,
    "sortField": "inDate",
    "sortType": "Desc"
  }
}

Response Body

Attribute	Format	Description
campaignNumber	Integer	The Number of the campaign
campaignName	String	The name of the campaign
countryCode	String	The campaign country code
type	Integer	The type of targeting of the campaign 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
userId	String	The campaign creation user ID
userName	String	The campaign creation user name
activeStatus	String	The campaigns status Active: Query the data of Processing, Delivering, Out of budget status Inactive: Query the data of Inactive and Ended states
status	String	The Campaign Status Description Pending Delivering Processing Out of budget Inactive Ended
startDate	String	The starting date of the campaign.
endDate	String	The ending date of the campaign to stop running
budget	Decimal	The total amount is to spend on this ad
dailyBudget	Decimal	The amount to spend on this ad per day
groupCount	Integer	How many group under this campaign
inDate	String	The campaign creation data
inUser	Integer	The campaign creation user ID
displayType	String	The campaign display type
declineReason	String	The campaign decline reason
costModel	Decimal	Available values: 0: CPM 1: CPC
lastEditDate	String	The Campaign last edit date

Example: Json, Response

{
    "header": [
        {
            "msg": "search campaigns success",
            "bizCode": "025"
        }
    ],
    "rows": [
        {
            "campaignNumber": 1171797,
            "campaignName": "Campaign-2022-05-28 02:18:16testUP",
            "countryCode": "USA",
            "type": 1,
            "userId": "31862132",
            "userName": "",
            "activeStatus": "Inactive",
            "status": "Inactive",
            "startDate": "2022-05-27 00:00:00",
            "endDate": null,
            "budget": null,
            "dailyBudget": 1,
            "groupCount": 1,
            "inDate": "Mon May 23 16:19:10 PDT 2022",
            "inUser": "28740045",
            "displayType": "0",
            "declineReason": null,
            "costModel": 0,
            "lastEditDate": "Fri May 27 18:24:44 PDT 2022"
        },
        {
            "campaignNumber": 1171315,
            "campaignName": "Campaign-2022-05-27 05:04:37视频测试",
            "countryCode": "USA",
            "type": 5,
            "userId": "28740045",
            "userName": "",
            "activeStatus": "Inactive",
            "status": "Pending",
            "startDate": "2022-05-27 00:00:00",
            "endDate": null,
            "budget": null,
            "dailyBudget": 100,
            "groupCount": 1,
            "inDate": "Fri May 20 19:21:01 PDT 2022",
            "inUser": "28740045",
            "displayType": null,
            "declineReason": null,
            "costModel": 0,
            "lastEditDate": "Tue Jun 14 15:20:48 PDT 2022"
        }
    ],
    "totalRows": 2
}

Last updated: October 03, 2022