post http://staging-apigateway.snapdeal.com/seller-api/campaigns/v2/list
This returns the list of campaigns along with the corresponding reporting data.
Campaigns are filtered according to the statuses, supc and product name passed in the request.
Report data is returned for the date range sent in the request.
Request
| Parameter Name | Data Type | Parameter Type | Requirement | Description |
|---|---|---|---|---|
| accountId | Integer | body | mandatory | Account ID of the seller for which campaign list needs to be fetched. |
| statusList | Array of Strings | body | mandatory | List of status for which campaigns needs to fetched. ALL/all: for all campaigns. active/inactive/deleted/draft: for corresponding statuses |
| startDate | Long | body | mandatory | Start date from which report data is needed. In milliseconds EPOCH |
| endDate | Long | body | mandatory | End date from which report data is needed. In milliseconds EPOCH |
| supc | String | body | optional | supc on which to filter the campaign list. |
| productName | String | body | optional | Product name search to filter the campaign list. |
| timeOut | Integer | body | optional | Time in milliseconds for report timeout. |
Response
| Field Name | Data Type | Description |
|---|---|---|
| code | Integer | Response code. Contains an error code in case of any error. |
| data | Array of objects | Array of JSON objects representing the campaigns. |
| data.0.id | Integer | Campaign ID |
| data.0.campaignName | String | Campaign Name |
| data.0.status | String | Campaign status |
| data.0.impressions | Integer | Number of ad impressions for the campaign between start and end date sent in the request. |
| data.0.clicks | Integer | Number of ad clicks for the campaign between start and end date sent in the request. |
| data.0.conversions | Integer | Number of conversions for the campaign between start and end date sent in the request. |
| data.0.costOfInventory | Float | Cost of inventory for the campaign between start and end date sent in the request. |
| data.0.numberOfOrders | Integer | Number of orders for the campaign between start and end date sent in the request. |
| data.0.gmv | Integer | GMV for the campaign between start and end date sent in the request. |
| data.0.cpa | Integer | Cost per aquisition for the campaign between start and end date sent in the request. |
| data.0.roi | Float | Roi for the campaign between start and end date sent in the request. |
| data.0.budget | Integer | Total budget for the campaign. |
| data.0.amountSpent | Integer | Amount spend for the campaign between start and end date sent in the request. |
| data.0.cpc | Float | Average CPC for the campaign between start and end date sent in the request. |
| data.0.hidden | Boolean | Campaign should be hidden from the view or not. Valid for basic campaigns. |
| data.0.productInfos | Array of objects | List of products advertised in the campaign. |
| status | String | Message, error message in case of errors. OK in case of success. |