Campaigns API

The Campaigns API retrieves a paginated list of marketing campaigns within the Retail Media platform for a specific supplier.

warning

Always ensure that sensitive campaign data is handled securely and in compliance with data protection regulations.

API Endpoint

Method: GET

URL: https://<PA_RM_END_POINT>/retail-media/campaigns/supplier/{supplierId}

info

Please refer to the Supplier API documentation for detailed instructions on how to retrieve the supplierId.

Request Header

Name	Value
Content-Type	application/json
Authorization	Bearer ACCESS_TOKEN

info

Please refer to the Authentication API documentation for bearer token.

Request Query Parameters

Parameter	Type	Description
page	integer	The page number of the user list. Defaults to 1 if not specified.
limit	integer	The number of users to return per page. Defaults to 10 but can be set as needed up to a maximum of 100.

Response Payload

Success Response

• Status Code: 200 OK
• Payload: Returns list of campaings associated with the supplier in JSON format

{
    "payload": {
        "campaigns": [
            {
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "name": "Campaign name",
                "startDate": "2025-02-19",
                "dailyCap": 0.00,
                "totalBudget": 0.00,
                "clicks": 0,
                "impressions": 0,
                "spentCredits": 0.00,
                "isRunning": true
            },
            {
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "name": "name of the campagin",
                "startDate": "2025-01-22",
                "endDate": "2025-02-28",
                "dailyCap": 100.00,
                "totalBudget": 1000.00,
                "clicks": 0,
                "impressions": 0,
                "isRunning": false
            }
        ],
        "totalItems": 104,
        "totalPages": 52,
        "currentPage": 1,
        "pageSize": 2,
        "hasPreviousPage": false,
        "hasNextPage": true
    }
}

Response Parameters

Parameter	Type	Description
campaigns	Array of Object	Array of campaigns.
totalItems	integer	Total number of users available for the given organisation.
totalPages	integer	Total number of pages available for the given organisation.
currentPage	integer	Current page number for the list of users.
pageSize	integer	Number of users returned per page.
hasPreviousPage	boolean	Indicates if previous page is available.
hasNextPage	boolean	Indicates if next page is available.

Campaign Object

Parameter	Type	Description
id	string	Unique identifier for the campaign.
name	string	Name of the campaign.
dailyCap	decimal	Maximum spend allowed per day. If zero(0) no cap has set.
startDate	string(ISO 8601)	Campaign start date.
end date	string(ISO 8601)	Campaign end date.
totalBudget	decimal	Total budget allocated for the campaign.
clicks	integer	The total number of clicked the campaign has received.
impressions	integer	The total number of impressions the campaign has received.
isRunning	integer	Indicates if the campaign is currently running(true) or paused(false).

Error Response

If an error occurs, the API will return an appropriate status code along with an error message.

• Sample Error Response (400 Bad Request):

{
  "errors": [
    "Error message 1",
    "Error message 2"
  ],
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "traceId": "xxxxxxxxxxxxxxxxxxx"
}

Example Usage (JavaScript)

var myHeaders = new Headers();
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Authorization", "BEARER YOUR_ACCESS_TOKEN");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect:'follow'
};

fetch("https://<PA_RM_END_POINT>/retail-media/campaigns/supplier/{supplierId}?page=1&limit=100", requestOptions)
  .then(response => response.json())
  .then(result=> { 
    console.log(result);
  })
  .catch(error => console.log('error', error));