MMetadata /docs
⌘K
Docs/Tools/budget_group_performance

budget_group_performance

Performance statistics for a specific budget group by name.

Read analytics

Returns data. Calling it changes nothing, so it is safe in an unattended loop.

What it does

Performance statistics for a specific budget group by name.
IMPORTANT: Accepts budget group NAME directly - no need to look up ID first. Do NOT call get_budget_group before this tool.

USE FOR: Budget group CPL/ROI/Pipeline/MQL analysis, spending and conversion metrics, experiment performance within budget group, efficiency analysis.
NOT FOR: Comparing ALL budget groups (use list_budget_groups), individual experiments without budget group context (use experiment_performance_stats), account-level aggregates (use account_level_stats), budget group config WITHOUT performance (use get_budget_group).

HOW IT WORKS: Takes name → looks up ID → fetches experiments tagged with budget group → returns detailed performance.

METRICS RETURNED: spent, impressions, clicks | leads, mqls, conversions | ctr, cpl, cpc, cpm, conversionRate, mqlRate | oppsAmount, triggeredAmount, totalOpps, totalTriggered | name, status, channel, dates

DATE HANDLING: No dates = all-time data. Supports ISO 8601 date ranges.

Arguments

ArgumentTypeNotes
budget_group_name string required Name of the budget group to analyze (required). The tool will automatically look up the budget group ID. Example: 'Brand Awareness', 'ToFu', 'Lead Gen Q4'
startDate string Start date for analysis in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ, e.g., '2025-01-01T00:00:00.000Z'). Optional - if not provided, no start date filter is applied.
endDate string End date for analysis in ISO 8601 format (YYYY-MM-DDTHH:mm:ss.SSSZ, e.g., '2025-12-15T23:59:59.999Z'). Optional - if not provided, no end date filter is applied.
excludeExperimentName string Experiment name to exclude from results. Useful for filtering out specific experiments from the analysis.
page integer Page number for pagination (0-based). Use for paginating through large result sets.
size integer Number of experiments per page. Default is 10. Use larger values (up to 10000) for comprehensive analysis — pull the whole set rather than a sample.
sort string Sort criteria for experiments. Format: field,field,direction. Examples: 'experimentId,name,asc', 'spent,desc', 'cpl,asc'

Request

curl
curl -s -X POST https://mcp-server.metadata.io/mcp \
  -H "Authorization: $METADATA_PAT" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -H "MCP-Protocol-Version: 2025-11-25" \
  -d '{"jsonrpc":"2.0","id":1,"method":"tools/call","params":{"name":"budget_group_performance","arguments":{"budget_group_name":"<budget_group_name>"}}}'

Response

Recorded with these arguments. Enum values are the first the tool's own schema declares; ids were fetched live from a list_ call immediately before.

arguments used
{
 "budget_group_name": "[budget_group_name redacted]"
}

Real, from the production server, in 2968 ms. Values that identify a customer or disclose money are replaced with typed placeholders; keys, types and nesting are exactly as returned.

recorded response
"[value redacted]"

Other analytics tools:

All 160 tools · machine-readable index