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. Use campaignstack_get_campaign_metrics for per-campaign detail.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | No | — | Defaults to the API key’s workspace |
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. 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. Use campaignstack_get_workspace_metrics for a workspace-level summary.
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.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | No | — | Defaults to the API key’s workspace |
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). Use campaignstack_get_credit_balance to see credit usage.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
workspaceId | string | No | — | Defaults to the API key’s workspace |