MMetadata /docs
⌘K
Docs/Tools/get_budget_group

get_budget_group

Get configuration and settings for a budget group (NOT performance data).

Read campaigns

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

What it does

Get configuration and settings for a budget group (NOT performance data).

                KEYWORDS: budget, group, settings, configuration, details, allocation, campaigns

                WHEN TO USE:
                - "Show me the [group name] budget group settings/configuration"
                - "What campaigns are in the [group name] budget group?"
                - "What's the budget allocation for [group name]?"
                - Getting budget group metadata without performance metrics

                WHEN NOT TO USE:
                - Performance questions (spend, CPL, leads, conversions) → use budget_group_performance instead
                - Questions like "how did X perform" or "total spend for X" → use budget_group_performance instead

                NOTE: If the user is asking about performance metrics (spend, leads, CPL, etc.),
                use budget_group_performance directly - it accepts the name and handles ID lookup internally.

                Matches the full stored name across search pages, ignoring letter case and outer whitespace, whether switched on or off. Refuses ambiguous names instead of selecting a different group. Returns complete budget group information including campaigns, budget allocation, and settings, plus the account's auto pause rule sets (accountAutoPauseRuleSets: id, name, default) a rule set switch can choose from. A MONTHLY_RESET or CUSTOM_RESET group starts over every period and runs until switched off; its currentPeriodStart and currentPeriodEnd only bound the current period, so never present them as the group ending or offer to extend it.

Arguments

ArgumentTypeNotes
name string required The full stored name of the budget group, ignoring letter case and outer whitespace. Example: 'Brand'

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

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