AdSet Details Metrics

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

Overview

AdSet Details Metrics provide insights into the performance of individual ad sets within your campaigns. These metrics help you track and analyze the effectiveness of your advertising sets across various placements and products.

API Endpoint

Method: GET

URL: https://<PA_RM_END_POINT>/retail-media/supplier/{supplierId}/retailers/{retailerId}/campaign/{campaignId}/adset-details-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

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",
    "errorCode": "",
    "data": {
        "adSets": [
            {
                "name": "ADSET 111",
                "version": "1",
                "placements": [
                    {
                        "name": "ADSET 111 > PLACEMENT 111",
                        "products": [
                            {
                                "name": "PRODUCT NAME > 1",
                                "link": "https://www.xxx-xxx.com.au/PRODUCT_NAME_1",
                                "impressions": "2",
                                "roas": "0.00x",
                                "clicks": 0,
                                "amountSpent": 0,
                                "avgCPC": 0,
                                "sponsoredUnitsSold": 0,
                                "attributedRevenue": 0
                            }
                        ]
                    }
                ]
            }
        ]
    },
    "metadata": {
        "requestId": "2c96811e-af4c-410e-9b31-6d3025973805",
        "timestamp": "2025-04-07T04:54:59.7896246Z"
    }
}

Available Metrics

The AdSet Details 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
version	Version of the ad set	string
placements	Array of placements within the ad set	array
products	Array of products within each placement	array
impressions	Number of times the product was displayed	string
roas	Return on ad spend (ROAS) for the product	string
clicks	Number of clicks received	integer
amountSpent	Total amount spent on the product	decimal
avgCPC	Average cost per click	decimal
sponsoredUnitsSold	Number of units sold through sponsored ads	integer
attributedRevenue	Revenue attributed to the sponsored product	decimal

Understanding the Metrics

The AdSet Details Metrics provide insights into various aspects of your ad set performance:

Performance Metrics

• Impressions: Total number of times your products were displayed
• Clicks: Total number of clicks received
• CPC (Cost per Click): Average cost for each click
• ROAS (Return on Ad Spend): Return on investment for the product

Sales Metrics

• Sponsored Units Sold: Number of units sold through sponsored ads
• Attributed Revenue: Total revenue attributed to the sponsored product

Financial Metrics

• Amount Spent: Total amount spent on the product
• Average CPC: Average cost per click for the product

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-details-metrics", 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 impressions and clicks to optimize product visibility
3. ROAS Tracking: Monitor ROAS to ensure product-level profitability
4. Budget Management: Track amount spent against performance metrics
5. Product Performance: Analyze which products perform best in different placements
6. Placement Optimization: Use placement data to optimize product positioning