Skip to main content
Glama
GrowSurf MCP Server

GrowSurf MCP Server

Official

Get Participant Analytics

growsurf_get_participant_analytics
Read-onlyIdempotent

Fetch all-time engagement, rank, share, and affiliate revenue, commission, and payout metrics for one participant by ID or email, with optional activation milestones and date-range series data.

Instructions

Fetch analytics for one participant by GrowSurf participant ID or email. The base response includes all-time engagement, rank, share, and applicable affiliate revenue, commission, and payout metrics. Add activation to include for the program-specific eligibility anchor and covered first milestones, including firstPortalViewedAt and firstShareChannel. A null milestone with a partial or unavailable state is unknown, not proof that the action never happened. Request both activation and series for covered portalViews and shareActions buckets. Filter optional series and email data with days (up to 1825) or both startDate and endDate as positive Unix timestamps in milliseconds. endDate must be at or after startDate, and the range can span at most 1825 days. These date parameters do not filter the base response or activation milestones. Targets campaignId if passed, otherwise GROWSURF_CAMPAIGN_ID.

Input Schema

NameRequiredDescriptionDefault
daysNoNumber of days for optional `series` and `email` analytics. Defaults to 365. Does not filter the all-time base response.
endDateNoEnd of the optional-data timeframe, positive Unix timestamp in milliseconds. Supply `startDate` too; `endDate` must be >= `startDate` and at most 1825 days later.
includeNoComma-separated optional data. Current values are `series`, `email`, and `activation`; the API returns `400` for unknown values.
intervalNoBucket size for `series` and email series. Defaults to `day`.
startDateNoStart of the optional-data timeframe, positive Unix timestamp in milliseconds. Supply `endDate` too; the window must span at most 1825 days.
campaignIdYesTarget program id for this call: the `id` returned by `growsurf_list_campaigns`, not the program name or a share URL. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server.
participantIdNo
participantEmailNo

Output Schema

NameRequiredDescriptionDefault
emailNoSent, delivered, opened, clicked, bounced, and spam complaint metrics for program emails in the requested window.
ranksNoLeaderboard ranks for this participant.
seriesNoThis participant's per-period activity. Present when `include` contains `series`.
endDateNoWindow end (Unix ms). Present with `series` or `email`.
analyticsNoAll-time participant analytics totals. Date-window parameters do not filter these fields.
startDateNoWindow start (Unix ms). Present with `series` or `email`.
activationNoOpt-in covered eligibility and first-milestone analytics for one participant.
shareCountNoPer-channel share counts (e.g. `email`, `facebook`, `twitter`).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed6 schema fields changedv0.19.34
    • changedInput schema / properties / days / description
      Previous value: -"Number of days for optional `series` and `email` analytics. Does not filter the all-time base response."New value: +"Number of days for optional `series` and `email` analytics. Defaults to 365. Does not filter the all-time base response."
    • changedOutput schema / properties / email / properties / byType / items / properties / clickRate / description
      Previous value: -"Clicked divided by delivered, from 0 to 1."New value: +"Clicked divided by delivered emails with click tracking enabled, from 0 to 1; zero when none qualify."
    • changedOutput schema / properties / email / properties / byType / items / properties / openRate / description
      Previous value: -"Opened divided by delivered, from 0 to 1."New value: +"Opened divided by delivered emails with open tracking enabled, from 0 to 1; zero when none qualify."
    • changedOutput schema / properties / email / properties / clickRate / description
      Previous value: -"Clicked divided by delivered, from 0 to 1."New value: +"Clicked divided by delivered emails with click tracking enabled, from 0 to 1; zero when none qualify."
    • changedOutput schema / properties / email / properties / isPartial / description
      Previous value: -"Whether the requested window starts before `coverageStartDate`."New value: +"Whether the requested window starts before `coverageStartDate` or some emails lack open, click, or spam complaint tracking. Totals can be incomplete."
    • changedOutput schema / properties / email / properties / openRate / description
      Previous value: -"Opened divided by delivered, from 0 to 1."New value: +"Opened divided by delivered emails with open tracking enabled, from 0 to 1; zero when none qualify."
  2. Changed1 schema field changedv0.19.33
    • changedInput schema / properties / campaignId / description
      Previous value: -"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."New value: +"Target program id for this call: the `id` returned by `growsurf_list_campaigns`, not the program name or a share URL. Defaults to GROWSURF_CAMPAIGN_ID when omitted. Program IDs also identify newly created programs without restarting the server."
  3. Changed2 schema fields changedv0.19.15
    • addedInput schema / properties / campaignId / minLength
      Added value: +1
    • addedInput schema / required
      Added value: +[
      +  "campaignId"
      +]
  4. Changed1 schema field changedv0.19.9
    • changedInput schema / properties / campaignId / description
      Previous value: -"Target 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."New value: +"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."
  5. Changed5 schema fields changedv0.19.8
    • addedInput schema / allOf
      Added value: +[
      +  {
      +    "if": {
      +      "required": [
      +        "startDate"
      +      ]
      +    },
      +    "then": {
      +      "required": [
      +        "endDate"
      +      ]
      +    }
      +  },
      +  {
      +    "if": {
      +      "required": [
      +        "endDate"
      +      ]
      +    },
      +    "then": {
      +      "required": [
      +        "startDate"
      +      ]
      +    }
      +  }
      +]
    • changedInput schema / properties / endDate / description
      Previous value: -"End of the optional-data timeframe, Unix timestamp in ms. Use with `startDate`."New value: +"End of the optional-data timeframe, positive Unix timestamp in milliseconds. Supply `startDate` too; `endDate` must be >= `startDate` and at most 1825 days later."
    • addedInput schema / properties / endDate / minimum
      Added value: +1
    • changedInput schema / properties / startDate / description
      Previous value: -"Start of the optional-data timeframe, Unix timestamp in ms. Use with `endDate` instead of `days`."New value: +"Start of the optional-data timeframe, positive Unix timestamp in milliseconds. Supply `endDate` too; the window must span at most 1825 days."
    • addedInput schema / properties / startDate / minimum
      Added value: +1
  6. Changed9 schema fields changedv0.14.0
    • addedInput schema / properties / days / description
      Added value: +"Number of days for optional `series` and `email` analytics. Does not filter the all-time base response."
    • changedInput schema / properties / endDate / description
      Previous value: -"End of the timeframe, Unix timestamp in ms."New value: +"End of the optional-data timeframe, Unix timestamp in ms. Use with `startDate`."
    • changedInput schema / properties / include / description
      Previous value: -"Comma-separated optional data. Current values are `series` and `email`; the API returns `400` for unknown values."New value: +"Comma-separated optional data. Current values are `series`, `email`, and `activation`; the API returns `400` for unknown values."
    • changedInput schema / properties / startDate / description
      Previous value: -"Start of the timeframe, Unix timestamp in ms. Use with endDate instead of days."New value: +"Start of the optional-data timeframe, Unix timestamp in ms. Use with `endDate` instead of `days`."
    • addedOutput schema / properties / activation
      Added value: +{
      +  "description": "Opt-in covered eligibility and first-milestone analytics for one participant.",
      +  "properties": {
      +    "cohort": {
      +      "description": "Program-specific eligibility anchor and covered value.",
      +      "properties": {
      +        "anchorAt": {
      +          "description": "Covered anchor time (Unix ms). `null` is unknown and does not mean enrollment never occurred.",
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        },
      +        "anchorField": {
      +          "enum": [
      +            "enrolledAsAdvocateAt",
      +            "approvedAsAffiliateAt"
      +          ],
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "coverageStartAt": {
      +      "description": "Earliest expected complete participant activation capture time (Unix ms).",
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "enrolledAsAdvocateAt": {
      +      "description": "Referral only. Covered advocate enrollment (Unix ms); `null` does not mean enrollment never occurred.",
      +      "type": [
      +        "integer",
      +        "null"
      +      ]
      +    },
      +    "metricContractVersion": {
      +      "description": "Shared activation and engagement metric version.",
      +      "type": "integer"
      +    },
      +    "milestones": {
      +      "description": "Covered first milestones. A `null` value is unknown and does not mean the action never happened.",
      +      "properties": {
      +        "firstCommissionAt": {
      +          "description": "Affiliate only. First covered commission (Unix ms).",
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        },
      +        "firstLeadAt": {
      +          "description": "First covered referred lead (Unix ms).",
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        },
      +        "firstPortalViewedAt": {
      +          "description": "First covered signed-in portal view (Unix ms).",
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        },
      +        "firstReferralAt": {
      +          "description": "First covered credited referral (Unix ms).",
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        },
      +        "firstReferralLinkCopiedAt": {
      +          "description": "First covered referral-link copy (Unix ms).",
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        },
      +        "firstRewardAt": {
      +          "description": "Referral only. First covered participant reward (Unix ms).",
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        },
      +        "firstShareAt": {
      +          "description": "First covered accepted share action (Unix ms).",
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        },
      +        "firstShareChannel": {
      +          "description": "Channel for `firstShareAt`, or `null` when the first covered share is unavailable.",
      +          "enum": [
      +            "email",
      +            "facebook",
      +            "twitter",
      +            "linkedin",
      +            "pinterest",
      +            "threads",
      +            "bluesky",
      +            "sms",
      +            "messenger",
      +            "whatsapp",
      +            "wechat",
      +            "telegram",
      +            "reddit",
      +            "tumblr",
      +            "qrcode",
      +            "copyRefLink",
      +            "iosNativeShare",
      +            "androidNativeShare",
      +            null
      +          ],
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        },
      +        "firstUniqueClickAt": {
      +          "description": "First covered unique referral visit (Unix ms).",
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        },
      +        "payoutSetupCompletedAt": {
      +          "description": "First covered payout-setup completion (Unix ms).",
      +          "type": [
      +            "integer",
      +            "null"
      +          ]
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "programType": {
      +      "description": "Program eligibility model.",
      +      "enum": [
      +        "REFERRAL",
      +        "AFFILIATE"
      +      ],
      +      "type": "string"
      +    },
      +    "reason": {
      +      "description": "Why a value is partial or unavailable, or `null` when it is available.",
      +      "enum": [
      +        "COVERAGE_UNAVAILABLE",
      +        "PRE_COVERAGE",
      +        "PARTIAL_COVERAGE",
      +        "INSUFFICIENT_COVERAGE",
      +        "EMPTY_DENOMINATOR",
      +        "QUERY_LIMIT_EXCEEDED",
      +        "PARTICIPANT_NOT_ELIGIBLE",
      +        null
      +      ],
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "state": {
      +      "description": "Whether the value is complete, partial, or unavailable for the requested bounds.",
      +      "enum": [
      +        "AVAILABLE",
      +        "PARTIAL",
      +        "UNAVAILABLE"
      +      ],
      +      "type": "string"
      +    }
      +  },
      +  "type": "object"
      +}
    • changedOutput schema / properties / analytics / description
      Previous value: -"Participant analytics totals."New value: +"All-time participant analytics totals. Date-window parameters do not filter these fields."
    • changedOutput schema / properties / analytics / properties / leads / description
      Previous value: -"Pending referral credits."New value: +"Current pending referral credits."
    • addedOutput schema / properties / series / items / properties / portalViews
      Added value: +{
      +  "description": "Covered signed-in portal views, or `null` outside known coverage.",
      +  "type": [
      +    "integer",
      +    "null"
      +  ]
      +}
    • addedOutput schema / properties / series / items / properties / shareActions
      Added value: +{
      +  "description": "Covered accepted share actions, or `null` outside known coverage.",
      +  "type": [
      +    "integer",
      +    "null"
      +  ]
      +}
  7. First observedv0.12.2

TDQS

A4.6/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds real behavioral context beyond them: date params do NOT filter the base response or activation milestones, a null milestone with partial/unavailable state means unknown rather than 'never happened', the 1825-day cap, and that unknown `include` values return 400. These are exactly the edge cases an agent would otherwise get wrong.

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?

Front-loaded with purpose, then progressively elaborates base response, opt-in data, filtering, and targeting fallback. Dense but each sentence carries a distinct fact; a few clauses (e.g. the state/null caveat) are wordy but earn their place.

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?

For an 8-parameter analytics read with an output schema already present, nothing an agent needs to call it correctly is missing: identifier selection, campaign targeting and default, include semantics, date-window constraints, and the null-milestone interpretation caveat.

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 coverage is 75% and the schema already documents days/startDate/endDate/interval/include well; the description still adds the cross-field constraint (endDate >= startDate, max 1825-day span), the non-obvious scoping behavior of the date filters, and the participantId-or-email acceptance that the schema leaves undocumented. Only the two identifier params remain thin.

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?

Opens with a specific verb+resource+scope: 'Fetch analytics for one participant by GrowSurf participant ID or email.' The phrase 'one participant' scopes it against the campaign-level analytics siblings (get_campaign_analytics, get_campaign_activation_analytics) without ambiguity, and the base-response sentence enumerates exactly what comes back.

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?

Gives actionable composition guidance: add `activation` for eligibility anchors, request both `activation` and `series` for portalViews/shareActions buckets, and filter with `days` or both dates. It does not explicitly say when to prefer this over sibling tools like get_participant_activity_logs or get_campaign_activation_analytics, so a routing rule is left implicit.

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

Deploy Server

Other Tools