GrowSurf

Get Program Analytics

growsurf_get_campaign_analytics

Read-onlyIdempotent

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, email, or engagement. engagement groups unique active, sharing, repeat, and retained participants by when portal views and share actions occurred. Its coverageStartAt, state, and reason distinguish measured zeroes from partial or unavailable history. Scope the timeframe with days (default 365, max 1825) or an explicit startDate/endDate window. Explicit dates must both be positive Unix timestamps in milliseconds, with endDate >= startDate and a maximum span of 1825 days. timezone and platform apply to engagement only. Targets campaignId if passed, otherwise GROWSURF_CAMPAIGN_ID.

Input Schema

Name	Required	Description
`days`	No
`endDate`	No	End of the timeframe, positive Unix timestamp in milliseconds. Supply `startDate` too; `endDate` must be >= `startDate` and at most 1825 days later.
`include`	No	Comma-separated optional data: `previousPeriod`, `statusCounts`, `rates`, `email`, and `engagement`. Combine values when the question needs more than one view.
`interval`	No	day/week/month adds a per-period `series`; total (default) returns totals only.
`platform`	No	Client-platform filter for engagement. Defaults to `ALL`.
`timezone`	No	IANA timezone for engagement interval and distinct-day calculations. Used with `include=engagement`.
`startDate`	No	Start of the timeframe, positive Unix timestamp in milliseconds. Supply `endDate` too; the window must span at most 1825 days.
`campaignId`	Yes	Target program (campaign) id for this call. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server.

Output Schema

Name	Required	Description
`email`	No	Sent, delivered, opened, clicked, bounced, and spam complaint metrics for program emails in the requested window.
`rates`	No	Derived referral rates, each a ratio from 0 to 1. Present only when `include` contains `rates`.
`series`	No	Per-period totals in ascending order. Present only when `interval` is `day`, `week`, or `month`.
`endDate`	No	End of the analytics timeframe, as a Unix timestamp in milliseconds.
`analytics`	No	Analytics 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`.
`startDate`	No	Start of the analytics timeframe, as a Unix timestamp in milliseconds.
`engagement`	No	Opt-in participant engagement grouped by when activity occurred.
`statusCounts`	No	Status-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`.
`previousPeriod`	No	Totals for the equal-length window immediately before the requested one (`analytics`, `startDate`, `endDate`). Present only when `include` contains `previousPeriod`.

Schema Changelog

Changes observed during successful MCP inspections.

First observedOct 8, 2026

TDQS

A3.9/5.0

Behavior4/5

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

Annotations already declare readOnly/idempotent/non-destructive, so the safety profile is covered. The description adds real behavioral context the annotations cannot: engagement coverageStartAt/state/reason distinguish measured zeroes from partial or unavailable history, and it discloses defaults and limits (days default 365, max 1825, timezone/platform scoped to engagement only).

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

Conciseness4/5

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

A dense but well-ordered paragraph: scope first, then interval, then include values, then timeframe constraints, then targeting. Nearly every sentence carries information, though the date/timestamp constraint is restated in both the prose and the schema, adding a little redundancy.

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 explain return values, and it still covers defaults, limits, enum usage, engagement-only parameters, and campaignId fallback to GROWSURF_CAMPAIGN_ID. Nothing an agent needs to invoke this 8-parameter tool correctly is missing.

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

Parameters4/5

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

Schema description coverage is high (88%), so the baseline is 3, but the description adds cross-parameter semantics the schema does not: timezone and platform apply only to engagement, engagement requires include=engagement, and the startDate/endDate pairing constraints (both positive ms timestamps, endDate >= startDate, 1825-day span) are spelled out as a coherent rule set.

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

Purpose4/5

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

States a specific verb and resource ('Fetch analytics for your GrowSurf program') and enumerates the metric families returned (participants, referrals, impressions, shares, affiliate revenue/commission/payout). An agent can tell it is a program-level analytics read, though it never names the closest sibling (growsurf_get_campaign_activation_analytics) or explains how the two differ.

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

Usage Guidelines3/5

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

The description teaches *how* to drive the tool (interval for a series, comma-separated include values, days vs. explicit dates, campaignId fallback) but never states when this tool should be chosen over activation analytics or participant analytics. Usage context is implied rather than explicit, so the agent must infer the routing decision.

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

All GrowSurf tools Inspect

Try in Browser

One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.