Skip to main content
Glama
growsurf

GrowSurf MCP Server

Official
by growsurf

growsurf_get_campaign_analytics

Read-onlyIdempotent

Retrieve GrowSurf campaign analytics: participants, referrals, impressions, shares, and affiliate revenue. Use interval, include, and date parameters to get totals or per-period series.

Instructions

Fetch analytics for your GrowSurf program: participants, referrals, impressions, per-channel shares, and affiliate revenue, commission, and payout metrics when applicable. Pass interval (day, week, or month) for a per-period series. Pass comma-separated include values for previousPeriod, statusCounts, rates, or email. The email data reports sent, delivered, opened, clicked, bounced, and spam-complaint counts, rates, and per-email-type metrics. Scope the timeframe with days (default 365, max 1825) or an explicit startDate/endDate window (Unix ms). Targets campaignId if passed, otherwise GROWSURF_CAMPAIGN_ID.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
daysNo
endDateNoEnd of the timeframe, Unix timestamp in ms.
includeNoComma-separated optional data: `previousPeriod`, `statusCounts`, `rates`, and `email`. Combine `email` with `previousPeriod` or a non-total `interval` to receive matching email metrics for those windows.
intervalNoday/week/month adds a per-period `series`; total (default) returns totals only.
startDateNoStart of the timeframe, Unix timestamp in ms. Use with endDate instead of days.
campaignIdNoTarget program (campaign) id for this call. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Pass the `id` returned by growsurf_create_campaign to configure or operate a program you just created, without restarting the server.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
emailNoSent, delivered, opened, clicked, bounced, and spam complaint metrics for program emails in the requested window.
ratesNoDerived referral rates, each a ratio from 0 to 1. Present only when `include` contains `rates`.
seriesNoPer-period totals in ascending order. Present only when `interval` is `day`, `week`, or `month`.
endDateNoEnd of the analytics timeframe, as a Unix timestamp in milliseconds.
analyticsNoAnalytics totals: `invites`, `impressions`, `uniqueImpressions`, `participants`, `referrals`, `referralCreditPendings`, `referralCreditExpireds`, per-channel share counts (`emailShares`, `twitterShares`, `copyRefLinkShares`, ...), and for affiliate programs `totalRevenue` and `totalCommissions` (in minor currency units (e.g. cents)) plus `totalCommissionCount` and `uniqueCommissionReferrals`.
startDateNoStart of the analytics timeframe, as a Unix timestamp in milliseconds.
statusCountsNoStatus-count breakdowns: dashboard-aligned reward counts, and for affiliate programs `affiliateStatus`, `commissionStatus`, and `payoutStatus` (counts and amounts in minor currency units (e.g. cents)). Present only when `include` contains `statusCounts`.
previousPeriodNoTotals for the equal-length window immediately before the requested one (`analytics`, `startDate`, `endDate`). Present only when `include` contains `previousPeriod`.
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and destructiveHint=false, and the description does not contradict them. It adds context beyond annotations: the 'when applicable' qualifier for affiliate metrics, the email data breakdown (sent, delivered, etc.), and the default timeframe behavior. This provides behavioral insight without repeating safety annotations.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is concise and well-structured: it opens with the main purpose, then methodically covers key parameters and their semantics. Every sentence adds value, and there is no fluff or redundancy. It is front-loaded with the core function and flows logically.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present, the description need not detail return values. It covers all optional parameters, default behaviors, and special cases (e.g., email metrics with windows). It is complete for an analytics tool, giving an agent everything needed to make an informed call.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters5/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The description significantly expands on the schema: it explains that interval adds a per-period series, enumerates the include values and their effects (especially email detail), specifies days default (365) and max (1825), and clarifies the interaction of startDate/endDate and the fallback to GROWSURF_CAMPAIGN_ID. This covers even the undocumented 'days' parameter, making the description highly informative beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states it fetches analytics for the GrowSurf program, enumerating specific metrics (participants, referrals, impressions, shares, revenue, etc.). It uses a specific verb 'Fetch' and names the resource, which distinguishes it from siblings like growsurf_get_campaign (campaign settings) and growsurf_get_participant_analytics (per-participant data).

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description provides explicit guidance on how to use optional parameters: interval for series, include for optional data, days/startDate/endDate for timeframe, and campaignId targeting. However, it does not explicitly mention when to use this tool over alternatives like get_campaign, though the purpose clarity makes that inferable. The guidance on parameter combinations (e.g., combining email with previousPeriod) is valuable.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/growsurf/growsurf-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server