Campaign Metrics

This section provides detailed information about campaign metrics report in Retail Media.

Overview

Campaign metrics provide insights into the performance of your retail media campaigns. These metrics help you track and analyze the effectiveness of your advertising campaigns across various dimensions.

API Endpoint

Method: GET

URL: https://<PA_RM_END_POINT>/retail-media/supplier/{supplierId}/retailers/{retailerId}/campaign-metrics

info

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

Request Header

Name	Value
`Content-Type`	`application/json`
`Authorization`	`Bearer ACCESS_TOKEN`

info

Please refer to the Authentication API documentation for bearer token.

Request Parameters

Parameter	Type	Description
`retailerId`	`string`	Get the retailer ID from the Retailer API
`supplierId`	`string`	Get the supplier ID from the Supplier API

Request Query Parameters

Parameter	Type	Description
`fromDate`	`string`	Start date for the report (YYYY-MM-DD).
`toDate`	`string`	End date for the report (YYYY-MM-DD).
`page`	`integer`	The page number of the campaign list. Defaults to `1` if not specified.
`limit`	`integer`	The number of campaigns 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 campaigns with the metrics in JSON format

{
    "status": "Success",
    "message": "Data retrieved successfully",
    "errorCode": "",
    "data": [
        {
            "id": "96fe9637-6704-f011-acff-06be30a1c1a7",
            "name": "Fixed HERO",
            "startDate": "2025-03-19T02:09:32",
            "totalBudget": 0.00,
            "dailyCap": 0.00,
            "spentCredits": 0.00,
            "sponsoredUnit": 0,
            "sponsoredRevenue": 0,
            "dailySpentCredits": 0.00,
            "isRunning": true,
            "hasActiveAdSet": false,
            "campaignStatus": "Paused",
            "remainingBudget": 0.00,
            "attributedClicks": 0,
            "clicks": 0,
            "impressions": 0,
            "salesCount": 0,
            "salesValue": 0,
            "spent": 0,
            "roas": 0,
            "avgCTR": 0,
            "avgCPC": 0,
            "avgCOS": 0,
            "avgCPM": 0
        }
    ],
    "pagination": {
        "totalItems": 56,
        "totalPages": 1,
        "currentPage": 1,
        "pageSize": 100,
        "hasPreviousPage": false,
        "hasNextPage": false
    },
    "metadata": {
        "requestId": "3815d57c-f68e-4ba4-a370-279b52c7ddf5",
        "timestamp": "2025-04-04T03:33:47.7496744Z"
    }
}

Available Metrics

The campaign metrics API provides comprehensive data about your campaigns, including performance indicators and financial metrics. Here's a detailed breakdown of the available metrics:

Metric	Description	Type
`id`	Unique identifier for the campaign	string
`name`	Name of the campaign	string
`startDate`	Campaign start date and time	datetime
`totalBudget`	Total budget allocated for the campaign	decimal
`dailyCap`	Daily spending limit for the campaign	decimal
`spentCredits`	Total credits spent on the campaign	decimal
`sponsoredUnit`	Unit sales attributed to retail media ad sets.	integer
`sponsoredRevenue`	Retailer revenue attributed to sponsored ad campaigns.	decimal
`dailySpentCredits`	Credits spent on the current day	decimal
`isRunning`	Current running status of the campaign	boolean
`hasActiveAdSet`	Whether campaign has active ad sets	boolean
`campaignStatus`	Human-readable campaign status	string
`remainingBudget`	Remaining budget for the campaign	decimal
`attributedClicks`	Number of attributed clicks	integer
`clicks`	Clicks refer to the number of times sponsored product/content is clicked on by a viewer.	integer
`impressions`	Impressions refer to the number of times your sponsored product/content is displayed to a viewer.	integer
`salesCount`	Number of sales attributed to the campaign	integer
`salesValue`	Total value of sales	decimal
`spent`	Total Advertising Spend. This represents total spend across all CPC and CPM campaigns.	decimal
`roas`	Return on ad spend (ROAS) measures how much revenue an ad campaign generates relative to the cost of the campaign. Use ROAS to determine which campaigns generate the best return and which are less successful. ROAS = Sponsored Revenue / Advertising Spend	decimal
`avgCTR`	Click-through rate (CTR) is the ratio of clicks to impressions for an ad. CTR = Number of clicks / Number of impressions	decimal
`avgCPC`	Cost-per-click (CPC) refers to how much each click on an ad costs.	decimal
`avgCOS`	Cost of Sales (COS) measures the performance and success of pay-per-click (PPC) advertising campaigns related to Sponsored Products. COS employs the same metrics as ROAS, but it is represented differently. COS = Total Advertising Spend / Sponsored Revenue	decimal
`avgCPM`	Cost Per Mille (CPM) measures the cost per 1,000 impressions when any content/ad is displayed to a viewer.	decimal

Understanding the Metrics

The campaign metrics provide insights into various aspects of your campaign performance:

Performance Metrics

Impressions: Total number of times your ads were displayed
Clicks: Total number of clicks received
CTR (Click-Through Rate): Ratio of clicks to impressions
CPC (Cost per Click): Average cost for each click
CPM (Cost per Mille): Cost per thousand impressions

Financial Metrics

Total Budget: Total allocated budget for the campaign
Spent: Total amount spent on the campaign
Remaining Budget: Available budget remaining
ROAS (Return on Ad Spend): Return on investment for the campaign

Sales Metrics

Sales Count: Number of sales attributed to the campaign
Sales Value: Total value of sales generated
COS (Cost of Sale): Cost per sale

Example Usage (JavaScript)

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

var urlencoded = new URLSearchParams();

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

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

Best Practices

Regular Monitoring: Check campaign metrics daily to ensure optimal performance
Budget Management: Monitor spent credits and remaining budget to prevent overspending
Performance Analysis: Use CTR and CPC metrics to optimize ad performance
ROAS Tracking: Monitor ROAS to ensure campaign profitability
Daily Cap Monitoring: Keep track of daily spent credits against daily caps
Status Tracking: Regularly check campaign status to ensure active campaigns are running as expected

Overview​

API Endpoint​

Request Header​

Request Parameters​

Request Query Parameters​

Response Payload​

Success Response​

Available Metrics​

Understanding the Metrics​

Performance Metrics​

Financial Metrics​

Sales Metrics​

Example Usage (JavaScript)​

Best Practices​