growsurf_get_participant_analytics
Fetch participant analytics by ID or email, covering engagement, rank, and revenue. Optionally include email metrics and time-series data with adjustable intervals.
Instructions
Fetch analytics for one participant by GrowSurf participant ID or email. The base response includes engagement, rank, share, and applicable affiliate revenue, commission, and payout metrics. Set include to series, email, or both comma-separated. email reports sent, delivered, opened, clicked, bounced, and spam-complaint metrics attributed to this participant, including invitations they sent; series returns per-period activity. Bucket with interval (day, week, or month, default day) and scope the window with days (max 1825) or startDate/endDate (Unix ms). Targets campaignId if passed, otherwise GROWSURF_CAMPAIGN_ID.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| days | No | ||
| endDate | No | End of the timeframe, Unix timestamp in ms. | |
| include | No | Comma-separated optional data. Current values are `series` and `email`; the API returns `400` for unknown values. | |
| interval | No | Bucket size for `series` and email series. Defaults to `day`. | |
| startDate | No | Start of the timeframe, Unix timestamp in ms. Use with endDate instead of days. | |
| campaignId | No | 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. | |
| participantId | No | ||
| participantEmail | No |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Sent, delivered, opened, clicked, bounced, and spam complaint metrics for program emails in the requested window. | ||
| ranks | No | Leaderboard ranks for this participant. | |
| series | No | This participant's per-period activity. Present when `include` contains `series`. | |
| endDate | No | Window end (Unix ms). Present with `series` or `email`. | |
| analytics | No | Participant analytics totals. | |
| startDate | No | Window start (Unix ms). Present with `series` or `email`. | |
| shareCount | No | Per-channel share counts (e.g. `email`, `facebook`, `twitter`). |