AdSet Summary Metrics

This section provides detailed information about AdSet Summary Metrics report in Retail Media.

Overview

AdSet Summary Metrics provide insights into the performance of your retail media ad sets. These metrics help you track and analyze the effectiveness of your advertising sets across various dimensions.

API Endpoint

Method: GET

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

info

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

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
campaignId	string	Get the campaign ID from the Campaign API

Request Query Parameters

Parameter	Type	Description
page	integer	The page number of the ad set list. Defaults to 1 if not specified.
limit	integer	The number of ad sets 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 ad sets with their metrics in JSON format

{
    "status": "Success",
    "message": "Data retrieved successfully",
    "data": [
        {
            "name": "ADSET 1",
            "type": "Banner",
            "strategy": "Bid",
            "sponsoredRevenue": 0.0,
            "roas": 0,
            "impressions": 10,
            "clicks": 1,
            "sponsoredUnit": 0,
            "ctr": 10.0,
            "cpc": 0.0,
            "cos": 0,
            "cpm": 0.0,
            "spend": 0.0,
            "attributedClicks": 0
            
        }
    ],
    "pagination": {
        "totalItems": 12,
        "totalPages": 2,
        "currentPage": 1,
        "pageSize": 10,
        "hasPreviousPage": false,
        "hasNextPage": true
    },
    "metadata": {
        "requestId": "992198d9-1e22-4034-9cbc-878a2ced5b49",
        "timestamp": "2025-04-07T05:58:30.9025656Z"
    },
    "errorCode": ""
}

Available Metrics

The AdSet Summary Metrics API provides comprehensive data about your ad sets, including performance indicators and financial metrics. Here's a detailed breakdown of the available metrics:

Metric	Description	Type
name	Name of the ad set	string
type	The format of the ad (e.g., Banner, Carousel)	string
strategy	The bidding strategy used	string
sponsoredRevenue	Total revenue generated from sponsored sales	decimal
roas	Return on ad spend (ROAS) measures how much revenue an ad set generates relative to the cost. ROAS = Sponsored Revenue / Advertising Spend	decimal
impressions	Total number of times the ad was displayed	integer
clicks	Total number of clicks received	integer
sponsoredUnit	Number of sponsored units sold	integer
ctr	Click-through rate (CTR) is the ratio of clicks to impressions. CTR = Number of clicks / Number of impressions	decimal
cpc	Cost-per-click (CPC) refers to how much each click on an ad costs	decimal
cos	Cost of Sales (COS) measures the performance and success of pay-per-click (PPC) advertising campaigns. COS = Total Advertising Spend / Sponsored Revenue	decimal
cpm	Cost Per Mille (CPM) measures the cost per 1,000 impressions	decimal
spend	Total amount spent on the ad set	decimal
attributedClicks	Number of clicks attributed to the ad set	integer

Understanding the Metrics

The AdSet Summary Metrics provide insights into various aspects of your ad set 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

• Spend: Total amount spent on the ad set
• ROAS (Return on Ad Spend): Return on investment for the ad set

Sales Metrics

• COS (Cost of Sale): Cost per sale
• Sponsored Units: Number of units sold through sponsored ads

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/{campaignId}/adset-summary-metrics?page=1&limit=100", requestOptions)
  .then(response => response.json())
  .then(result => { 
    console.log(result);
  })
  .catch(error => console.log('error', error));

Best Practices

1. Regular Monitoring: Check ad set metrics daily to ensure optimal performance
2. Performance Analysis: Use CTR and CPC metrics to optimize ad performance
3. ROAS Tracking: Monitor ROAS to ensure ad set profitability
4. Budget Management: Track spend against performance metrics
5. Ad Type Analysis: Compare performance across different ad types (Banner, Carousel)
6. Credit Monitoring: Keep track of account credit usage