Metrics & Billing
Read-only performance and account telemetry — workspace/campaign metric trends, credit balance, and billing/subscription status.
Tools (4)
Section titled “Tools (4)”get_workspace_metrics
Section titled “get_workspace_metrics”Full name: campaignstack_get_workspace_metrics
Get workspace-level metrics: latest snapshot plus a time-series for the requested date range. Includes total campaigns, active campaigns, leads added/contacted/converted today, and the top campaign. Call this when the user asks how the workspace is doing overall, not one campaign in particular. It does not break results down by campaign; use campaignstack_get_campaign_metrics for that.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | No | — | Workspace ID. REQUIRED for a user key (csu_), which spans every workspace you belong to; omitted for a workspace key (cs_), which is bound to one and ignores this argument. campaignstack_whoami reports which kind of key you are holding and, for a user key, the workspaces it can reach. |
days | integer | No | 30 | Number of calendar days to include in the range (default 30, max 90) (min: 1, max: 90) |
get_campaign_metrics
Section titled “get_campaign_metrics”Full name: campaignstack_get_campaign_metrics
Get per-campaign metrics: latest snapshot plus a time-series for the requested date range. Includes leads contacted, responded, converted, failed, total leads, and average ICP match score. Call this when the user asks how one named campaign is performing. Use campaignstack_list_campaigns to find valid campaign IDs. The campaign must belong to your API key’s workspace; metrics for campaigns in other workspaces are not returned. It does not summarize every campaign at once, use campaignstack_get_workspace_metrics for that.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
campaignId | string | Yes | — | (min length: 1) |
days | integer | No | 30 | Number of calendar days to include in the range (default 30, max 90) (min: 1, max: 90) |
get_credit_balance
Section titled “get_credit_balance”Full name: campaignstack_get_credit_balance
Get the current AI credit balance for a workspace. Returns monthly usage, included credits, rolled-over credits, pack balance, overage used, total pool size, remaining credits, percent used, and plan type. Call this when the user asks how many credits are left or whether an action would run out. It never changes the balance; use campaignstack_get_workspace_billing for plan and subscription details.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | No | — | Workspace ID. REQUIRED for a user key (csu_), which spans every workspace you belong to; omitted for a workspace key (cs_), which is bound to one and ignores this argument. campaignstack_whoami reports which kind of key you are holding and, for a user key, the workspaces it can reach. |
get_workspace_billing
Section titled “get_workspace_billing”Full name: campaignstack_get_workspace_billing
Get billing information for a workspace: plan (free/paid), billing cycle, workspace status, and Stripe subscription details (period start/end). Call this when the user asks what plan they are on, when it renews, or whether the workspace is locked. It does not show credit usage; use campaignstack_get_credit_balance for that.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | No | — | Workspace ID. REQUIRED for a user key (csu_), which spans every workspace you belong to; omitted for a workspace key (cs_), which is bound to one and ignores this argument. campaignstack_whoami reports which kind of key you are holding and, for a user key, the workspaces it can reach. |