MMetadata /docs
Docs/Tools/list_budget_groups

list_budget_groups

Browse and list all available budget groups in the Metadata platform with customizable sorting.

Read campaigns

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

What it does

Browse and list all available budget groups in the Metadata platform with customizable sorting.

                KEYWORDS: budget, group, list, all, browse, spending, allocation, optimization, overview

                **DIFFERENCE FROM get_budget_group:**
                - get_budget_group: Searches for ONE specific group BY NAME (requires group name input)
                - list_budget_groups: Returns ALL groups at once (supports flexible sorting)

                USE THIS TOOL WHEN THE USER ASKS:
                - "Show me all budget groups" or "List all budget groups"
                - "What budget groups do we have?"
                - "Display all available groups"
                - "Show groups sorted by [metric]"
                - "Which groups have the highest budget?"
                - "Show groups by leads generated"
                - "List groups sorted by CPL"
                - "Order groups by spending"

                DO NOT USE if the user:
                - Asks for details about a SPECIFIC group by name → use get_budget_group instead
                - Wants to find a group by name → use get_budget_group instead
                - Says "Find the [specific name] group" → use get_budget_group instead

                SORTING OPTIONS:
                You can sort by any of these fields (default: totalActiveExperiments descending):
                - totalActiveExperiments, monthlyCap, averageDailyBudgetPerExperiment
                - spent, totalBudget, endDate, startDate, leads, cpl

                SORT ORDER:
                - asc: Ascending order (lowest to highest, oldest to newest)
                - desc: Descending order (highest to lowest, newest to oldest) [DEFAULT]

Arguments

ArgumentTypeNotes
sort_by string Field to sort budget groups by. Default: totalActiveExperiments
one of: totalActiveExperiments, monthlyCap, averageDailyBudgetPerExperiment, spent, totalBudget, endDate, startDate, leads, cpl
sort_order string Sort order - 'asc' (ascending) or 'desc' (descending). Default: desc
one of: asc, desc
page integer Page number for pagination (0-based). Default: 0
size integer Number of results per page. Default: 10

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":"list_budget_groups","arguments":{}}}'

Response

Real, from the production server, in 206 ms. The full response was 31,099 bytes; this is the first part of it. Values that identify a customer or disclose money are replaced with typed placeholders; keys, types and nesting are exactly as returned.

recorded response
{
 "data": [
  {
   "id": "[number redacted]",
   "name": "[name redacted]",
   "accountId": "[number redacted]",
   "status": true,
   "totalCampaigns": "[number redacted]",
   "totalExperiments": "[number redacted]",
   "totalActiveExperiments": 21,
   "totalActiveExperimentsWithoutSpend": 1,
   "totalSpent": "[number redacted]",
   "spent": "[number redacted]",
   "impressions": "[number redacted]",
   "clicks": "[number redacted]",
   "opens": "[number redacted]",
   "sends": "[number redacted]",
   "actionClicks": 1,
   "follows": 0,
   "companyPageClicks": 5,
   "costPerOpen": "[number redacted]",
   "costPerSend": "[number redacted]",
   "costPerFollow": 0,
   "costPerCompanyPageClick": "[number redacted]",
   "leads": "[number redacted]",
   "clickThroughLeads": 0,
   "mqls": "[number redacted]",
   "triggeredOpps": 63,
   "influencedOpps": "[number redacted]",
   "triggeredOppsAmount": "[number redacted]",
   "influencedOppsAmount": "[number redacted]",
   "monthToDateSpent": "[number redacted]",
   "linkedinSpent": "[number redacted]",
   "linkedinMonthToDateSpent": "[number redacted]",
   "facebookSpent": "[number redacted]",
   "facebookMonthToDateSpent": "[number redacted]",
   "suggestedDailyBudget": "[number redacted]",
   "noClicksDailyBudget": "[number redacted]",
   "noLeadsDailyBudget": "[number redacted]",
   "suggestedDailyBudgetExpWithLeads": "[number redacted]",
   "costMqls": "[number redacted]",
   "linkedinPacing": 0,
   "facebookPacing": 0,
   "linkedinRemaining": "[number redacted]",
   "facebookRemaining": "[number redacted]",
   "totalDailyBudget": "[number redacted]",
   "accountName": "[accountName redacted]",
   "csm": null,
   "adOps": null,
   "startDate": "2026-09-01T00:00:00.000Z",
   "endDate": "2026-09-30T00:00:00.000Z",
   "goal": "CPL",
   "optimizerFormula": "TRIGGERED_OPP",
   "autoApplyBudget": true,
   "scheduleFrequency": 48,
   "autopauseMonthlyCap": true,
   "autorestartMonthlyCap": true,
   "monthlyCap": "[number redacted]",
   "monthlyCapFacebook": 0,
   "monthlyCapLinkedin": 0,
   "cplLinkedin": 0,
   "cplFacebook": 0,
   "totalBudget": "[number redacted]",
   "budgetType": "MONTHLY_RESET",
   "optimizeBudget": null,
   "lowerLimit": 10,
   "overspentMultiplier": "[number redacted]",
   "remaining": "[number redacted]",
   "pacing": "[number redacted]",
   "totalPacing": "[number redacted]",
   "cpl": "[number redacted]",
   "ctr": "[number redacted]",
   "cpc": "[number redacted]",
   "remainingDays": 26,
   "actualDays": 4,
   "totalDays": 30,
   "remainingBudget": "[number redacted]",
   "averageDailyBudget": "[number redacted]",
   "averageDailyBudgetExpWithLeads": "[number redacted]",
   "percentageBudgetSpent": "[number redacted]",
   "percentageExpectedPacing": "[number redacted]",
   "groupMetric": "CPL",
   "benchmark": "[number redacted]",
   "targetProgress": "[number redacted]",
   "tier": null,
   "budgetRedistributionStrategy": "PERFORMANCE",
   "baseBudget": 25,
   "minimumBudget": 10,
   "influenceParameter": 3,
   "state": "OPTIMAL",
   "averageDailyBudgetPerExperiment": "[number redacted]",
   "customFieldId": null,
   "customFieldName": null,
   "customFieldPerDayWeight": "[number redacted]",
   "customFieldPerDollarWeight": "[number redacted]",
   "leadsPerDayWeight": "[number redacted]",
   "leadsPerDollarWeight": "[number redacted]",
   "impressionsPerDayWeight": "[number redacted]",
   "impressionsPerDollarWeight": "[number redacted]",
   "clicksPerDayWeight": "[number redacted]",
   "clicksPerDollarWeight": "[number redacted]",
   "conversionsPerDayWeight": "[number redacted]",
   "conversionsPerDollarWeight": "[number redacted]"
  },
  {
   "id": "[number redacted]",
   "name": "[name redacted]",
   "accountId": "[number redacted]",
   "status": true,
   "totalCampaigns": 1,
   "totalExperiments": 6,
   "totalActiveExperiments": 6,
   "totalActiveExperimentsWithoutSpend": 0,
   "totalSpent": "[number redacted]",
   "spent": "[number redacted]"
  … truncated

Other campaigns tools:

All 160 tools · machine-readable index