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.

                Default results include both switched-on and switched-off groups. Omit status for
                inventory and spreadsheet updates; use status=true or status=false only when the user
                requests that switch state. Reading a switched-off group does not switch it on.
                Paginate through totalPages before declaring a named group missing.

                A MONTHLY_RESET or CUSTOM_RESET group starts over every period and keeps funding its campaigns
                until it is switched off; its currentPeriodStart, currentPeriodEnd and remaining days only measure
                the current period, so never present them as the group ending or offer to extend it. Only a
                FIXED_BUDGET group's endDate ends it.

                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 a paginated list of groups (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
status boolean Optional switch-state filter: true for switched-on groups, false for switched-off groups. Omit to include both.
page integer Page number for pagination (0-based). Default: 0
size integer Number of results per page. Default: 10

Request

Request template, not a complete runnable example. Replace placeholders, empty objects, arrays, and zero values with valid account-specific inputs. Read required fields and nested constraints in the full schema. Confirm the account, connected channels, and referenced assets before calling a write tool.

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

No recorded response. This tool needs arguments that only exist inside an account, so no response is recorded here. The request is an illustrative template. Fill required fields and check the current schema before calling it. No response is fabricated.

Other campaigns tools:

Browse the tool catalog · machine-readable index