list_campaigns
Retrieve and filter advertising campaigns by status, ad format, or name to monitor performance and manage campaign data.
Instructions
List all campaigns with optional filters. Returns campaign ID, name, status, ad format, and basic metrics.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| status | No | Filter by status: active, paused, pending, rejected | |
| ad_format | No | Filter by ad format: push, onclick, interstitial, in-page-push | |
| name | No | Filter by campaign name (partial match) |
Implementation Reference
- src/propellerads_mcp/client.py:85-101 (handler)The implementation of the list_campaigns method in the client class that performs the API call.
def list_campaigns( self, status: str | None = None, ad_format: str | None = None, name: str | None = None, ) -> list[dict[str, Any]]: """List all campaigns with optional filters.""" params = {} if status: params["status"] = status if ad_format: params["ad_format"] = ad_format if name: params["name"] = name result = self._request("GET", "/adv/campaigns", params=params or None) return result.get("data", result) if isinstance(result, dict) else result - src/propellerads_mcp/server.py:75-96 (registration)The MCP tool registration for list_campaigns.
Tool( name="list_campaigns", description="List all campaigns with optional filters. Returns campaign ID, name, status, ad format, and basic metrics.", inputSchema={ "type": "object", "properties": { "status": { "type": "string", "description": "Filter by status: active, paused, pending, rejected", "enum": ["active", "paused", "pending", "rejected"], }, "ad_format": { "type": "string", "description": "Filter by ad format: push, onclick, interstitial, in-page-push", }, "name": { "type": "string", "description": "Filter by campaign name (partial match)", }, }, }, ),