get_performance_report
Retrieve detailed advertising campaign performance data including impressions, clicks, conversions, spend, and ROI metrics for analysis and optimization.
Instructions
Get detailed performance statistics with metrics like impressions, clicks, conversions, spend, CTR, CVR, CPC, CPA, and ROI.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| date_from | No | Start date (YYYY-MM-DD). Defaults to 7 days ago. | |
| date_to | No | End date (YYYY-MM-DD). Defaults to today. | |
| group_by | No | Group results by: date, campaign, zone, country, creative, device_type, browser, os | |
| campaign_id | No | Filter by specific campaign ID |
Implementation Reference
- src/propellerads_mcp/server.py:548-563 (handler)The handler for the 'get_performance_report' tool, which calls the client's get_statistics method and processes the results.
elif name == "get_performance_report": stats = client.get_statistics( date_from=args.get("date_from"), date_to=args.get("date_to"), group_by=args.get("group_by"), campaign_id=args.get("campaign_id"), ) if not stats: return "No statistics found for the specified period." # Calculate metrics for each entry enriched = [calculate_metrics(s) for s in stats] if isinstance(stats, list) else [calculate_metrics(stats)] lines = ["# Performance Report\n"] for s in enriched: - src/propellerads_mcp/server.py:214-244 (registration)The registration of the 'get_performance_report' tool in the server configuration.
Tool( name="get_performance_report", description="Get detailed performance statistics with metrics like impressions, clicks, conversions, spend, CTR, CVR, CPC, CPA, and ROI.", inputSchema={ "type": "object", "properties": { "date_from": { "type": "string", "description": "Start date (YYYY-MM-DD). Defaults to 7 days ago.", }, "date_to": { "type": "string", "description": "End date (YYYY-MM-DD). Defaults to today.", }, "group_by": { "type": "array", "items": {"type": "string"}, "description": "Group results by: date, campaign, zone, country, creative, device_type, browser, os", }, "campaign_id": { "type": "integer", "description": "Filter by specific campaign ID", }, }, }, ), Tool( name="get_campaign_performance", description="Get performance summary for a specific campaign with calculated metrics and insights.", inputSchema={ "type": "object",