Analytics API

Read the first-party analytics Stoked records for your community: visits, searches, profile views, funnel steps, offer views and similar activity. The same data powers the Analytics pages in the admin portal. You can read it three ways:

Endpoint Returns
GET /api/v1/analytics/events The raw events, one record each, newest first
GET /api/v1/analytics/aggregates A count per day, week or month for each event name you ask for
GET /api/v1/analytics/reports/:report One of the portal’s Analytics reports, such as the prospect funnel

All three require the analytics permission. The same permission reads the Reply Speed ranking, which has its own page.

These endpoints aren’t limited by plan. The Analytics pages in the admin portal come with the Pro and Enterprise plans, but a key with the analytics permission can read this API on any plan.

What gets recorded depends on your Data Collection settings under Settings > Analytics. With Behavioral events off, only page views and visits are recorded. With Page view tracking off, there are no page.viewed events. See First-Party Analytics.


Periods

Every endpoint takes a filter[period] and reads the activity inside it. Without one, the period is last-30-days.

Value Covers Buckets
last-7-days, last-30-days, or any last-N-days up to last-366-days From the start of the day N days ago through today, so N + 1 days Days
this-month, last-month, or a month as 2026-09 That calendar month Days
this-quarter, last-quarter, or a quarter as 2026-Q3 That calendar quarter Weeks, starting Monday
this-year, last-year, or a year as 2026 That calendar year Weeks, starting Monday
all-time From 1 January of last year through today Months

The period’s days run in US Eastern time, the same as the portal’s reports, and every response says so in period.time_zone. An unknown value, or last-N-days above 366, returns 400.

Names like this-month are turned into the period they mean when you ask: the response’s period.identifier reads 2026-09, not this-month. A rolling period ends today, so the same request returns more data later in the day.

The period object

The aggregates and reports return the period they covered:

Key Description
identifier The period, with names like this-month replaced by the actual month, quarter or year
title The portal’s label for it, such as Last 7 days or September 2026
start_date, end_date The first and last day covered, as YYYY-MM-DD
time_zone The time zone the days were counted in

Series

Counts over time are arrays of [label, value] pairs, one per bucket, oldest first, with a 0 for an empty bucket. The label is the portal’s chart label, not a date: Sep 1 for a day or for the week starting that Monday, September 2026 for a month. Day and week labels have no year. To turn them into dates, count buckets forward from start_date (for weekly buckets, from the Monday of that week, which can fall before start_date).


List events

GET https://integrations.stokedhq.com/api/v1/analytics/events

Returns the raw events in the period, newest first.

Parameters

Parameter Description
filter[period] The period to read. Defaults to last-30-days.
filter[name] One or more event names, separated by commas: filter[name]=offer.viewed,offer.clicked
filter[surface] Only events recorded on one site: community_site, embedded_community_site, advocate_site or community_admin_site. See Surfaces.
page[number], page[size] The page to return and its size. See Pagination.

An unknown event name returns 400. An unknown surface is not checked and returns an empty list.

Pagination

Events don’t follow the cursor pagination the rest of the API uses. They are in newest-first order and paged by number: links.next carries page[number], and page[after] returns 400. meta always has page, per_page, total_count and total_pages. Pages hold 50 events by default and at most 200.

Because the list is newest first, an event recorded while you are reading pushes older events one place down, so a page boundary can repeat one. Event ids are unique, so store events by id. Events are never edited, so there is no filter[updated_since]. To keep a copy up to date, read the last few days each night and skip the ids you already have.

Request

GET /api/v1/analytics/events

cURL

# Requires jq. Writes one JSON object per line to analytics.jsonl.
url="https://integrations.stokedhq.com/api/v1/analytics/events?filter[period]=last-7-days&filter[name]=advocate.profile_viewed,conversation.created"
while [ "$url" != "null" ]; do
page=$(curl -sg "$url" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/vnd.api+json")
echo "$page" | jq -c '.data[]' >> analytics.jsonl
url=$(echo "$page" | jq -r '.links.next')
done

Ruby

require "net/http"
require "json"
url = "https://integrations.stokedhq.com/api/v1/analytics/events?filter[period]=last-7-days&filter[name]=advocate.profile_viewed,conversation.created"
analytics = []
while url
uri = URI(url)
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer YOUR_API_KEY"
request["Accept"] = "application/vnd.api+json"
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) }
raise "HTTP #{response.code}: #{response.body}" unless response.is_a?(Net::HTTPSuccess)
page = JSON.parse(response.body)
analytics.concat(page["data"])
url = page.dig("links", "next")
end
puts "Fetched #{analytics.size} analytics"

Python

import requests
url = "https://integrations.stokedhq.com/api/v1/analytics/events?filter[period]=last-7-days&filter[name]=advocate.profile_viewed,conversation.created"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/vnd.api+json",
}
analytics = []
while url:
response = requests.get(url, headers=headers)
response.raise_for_status()
page = response.json()
analytics.extend(page["data"])
url = page["links"]["next"]
print(f"Fetched {len(analytics)} analytics")

C#

using System.Net.Http.Headers;
using System.Text.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
client.DefaultRequestHeaders.Accept.ParseAdd("application/vnd.api+json");
string? url = "https://integrations.stokedhq.com/api/v1/analytics/events?filter[period]=last-7-days&filter[name]=advocate.profile_viewed,conversation.created";
var analytics = new List<JsonElement>();
while (url is not null)
{
using var response = await client.GetAsync(url);
response.EnsureSuccessStatusCode();
using var page = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
foreach (var item in page.RootElement.GetProperty("data").EnumerateArray())
{
analytics.Add(item.Clone());
}
url = page.RootElement.GetProperty("links").GetProperty("next").GetString();
}
Console.WriteLine($"Fetched {analytics.Count} analytics");

JavaScript

let url = "https://integrations.stokedhq.com/api/v1/analytics/events?filter[period]=last-7-days&filter[name]=advocate.profile_viewed,conversation.created";
const analytics = [];
while (url) {
const response = await fetch(url, {
headers: {
Authorization: "Bearer YOUR_API_KEY",
Accept: "application/vnd.api+json",
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const page = await response.json();
analytics.push(...page.data);
url = page.links.next;
}
console.log(`Fetched ${analytics.length} analytics`);

Response

Response analytics-events-index.json Download
{
"data": [
{
"type": "analytics_events",
"id": "900609",
"attributes": {
"name": "advocate.profile_viewed",
"time": "2026-09-02T18:01:00Z",
"surface": "embedded_community_site",
"properties": {
"source": "card_list",
"surface": "embedded_community_site",
"advocate_id": 900101
},
"user_id": null,
"user_type": null
}
},
{
"type": "analytics_events",
"id": "900603",
"attributes": {
"name": "conversation.created",
"time": "2026-09-01T15:00:00Z",
"surface": "community_site",
"properties": {
"surface": "community_site",
"advocate_id": 900101,
"prospect_id": 900201,
"conversation_id": 900301
},
"user_id": 900201,
"user_type": "Community::Prospect"
}
}
],
"links": {
"self": "https://integrations.stokedhq.com/api/v1/analytics/events?filter%5Bperiod%5D=last-7-days&filter%5Bname%5D=advocate.profile_viewed%2Cconversation.created&page%5Bsize%5D=2&page%5Bnumber%5D=1",
"first": "https://integrations.stokedhq.com/api/v1/analytics/events?filter%5Bperiod%5D=last-7-days&filter%5Bname%5D=advocate.profile_viewed%2Cconversation.created&page%5Bsize%5D=2&page%5Bnumber%5D=1",
"prev": null,
"next": "https://integrations.stokedhq.com/api/v1/analytics/events?filter%5Bperiod%5D=last-7-days&filter%5Bname%5D=advocate.profile_viewed%2Cconversation.created&page%5Bsize%5D=2&page%5Bnumber%5D=2",
"last": "https://integrations.stokedhq.com/api/v1/analytics/events?filter%5Bperiod%5D=last-7-days&filter%5Bname%5D=advocate.profile_viewed%2Cconversation.created&page%5Bsize%5D=2&page%5Bnumber%5D=2"
},
"meta": {
"page": 1,
"per_page": 2,
"total_count": 3,
"total_pages": 2
}
}

Attributes

Records with "type": "analytics_events".

Attribute Type Description
name string The event name
time timestamp When it happened
surface string or null The site it happened on, copied from properties.surface. See Surfaces.
properties object Details recorded with the event. The keys depend on the event; see Event names.
user_id integer or null The signed-in person the event belongs to, when there was one and User linking is on. Stoked’s internal number, not the person’s API id.
user_type string or null What user_id points to: Community::Prospect, Community::Advocate or Community::Admin

Numbers in properties that end in _id (advocate_id, conversation_id, offer_id and so on) and user_id are Stoked’s internal numbers. They are not the id strings the other endpoints use, so you can’t look the record up by them. They are consistent across events, so you can count or group by them. The exception is conversation_ulid on offer events: the conversation’s API id, when the offer link carried one.

An event’s id is a number in a string, unique across all events.

When a person’s data is erased, their events stay but lose user_id and user_type.


Get counts over time

GET https://integrations.stokedhq.com/api/v1/analytics/aggregates

Counts events per bucket of the period: one record per event name, each with the full series. Nothing is paginated, and every name you ask for comes back, in the order you asked for it, even when it has no events.

Parameters

Parameter Description
filter[name] Required. One or more event names, separated by commas
filter[period] The period to count. Defaults to last-30-days.
filter[metric] count (the default) counts events. unique_visitors counts distinct visits (sessions) that had the event.
filter[surface] Only count events from one surface

unique_visitors counts sessions per bucket, not people: someone who comes back on two days is counted on both. The total is the sum of the buckets, so it matches the chart.

A missing filter[name], an unknown name, or an unknown metric returns 400.

Request

GET /api/v1/analytics/aggregates

cURL

curl -G "https://integrations.stokedhq.com/api/v1/analytics/aggregates" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/vnd.api+json" \
--data-urlencode "filter[period]=last-7-days" \
--data-urlencode "filter[name]=advocate.profile_viewed,conversation.created"

Ruby

require "net/http"
require "json"
uri = URI("https://integrations.stokedhq.com/api/v1/analytics/aggregates")
uri.query = URI.encode_www_form("filter[period]" => "last-7-days", "filter[name]" => "advocate.profile_viewed,conversation.created")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer YOUR_API_KEY"
request["Accept"] = "application/vnd.api+json"
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) }
raise "HTTP #{response.code}: #{response.body}" unless response.is_a?(Net::HTTPSuccess)
puts JSON.parse(response.body)["data"]

Python

import requests
response = requests.get(
"https://integrations.stokedhq.com/api/v1/analytics/aggregates",
headers={
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/vnd.api+json",
},
params={"filter[period]": "last-7-days", "filter[name]": "advocate.profile_viewed,conversation.created"},
)
response.raise_for_status()
print(response.json()["data"])

C#

using System.Net.Http.Headers;
using System.Text.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
client.DefaultRequestHeaders.Accept.ParseAdd("application/vnd.api+json");
using var response = await client.GetAsync("https://integrations.stokedhq.com/api/v1/analytics/aggregates?filter[period]=last-7-days&filter[name]=advocate.profile_viewed,conversation.created");
response.EnsureSuccessStatusCode();
using var document = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
Console.WriteLine(document.RootElement.GetProperty("data"));

JavaScript

const url = new URL("https://integrations.stokedhq.com/api/v1/analytics/aggregates");
url.searchParams.set("filter[period]", "last-7-days");
url.searchParams.set("filter[name]", "advocate.profile_viewed,conversation.created");
const response = await fetch(url, {
headers: {
Authorization: "Bearer YOUR_API_KEY",
Accept: "application/vnd.api+json",
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const { data } = await response.json();
console.log(data);

Response

Response analytics-aggregates-index.json Download
{
"data": [
{
"type": "analytics_aggregates",
"id": "advocate.profile_viewed:last-7-days:count",
"attributes": {
"name": "advocate.profile_viewed",
"total": 2,
"points": [
[
"Sep 1",
1
],
[
"Sep 2",
1
],
[
"Sep 3",
0
],
[
"Sep 4",
0
],
[
"Sep 5",
0
],
[
"Sep 6",
0
],
[
"Sep 7",
0
],
[
"Sep 8",
0
]
],
"metric": "count",
"surface": null,
"period": {
"identifier": "last-7-days",
"title": "Last 7 days",
"start_date": "2026-09-01",
"end_date": "2026-09-08",
"time_zone": "Eastern Time (US & Canada)"
}
}
},
{
"type": "analytics_aggregates",
"id": "conversation.created:last-7-days:count",
"attributes": {
"name": "conversation.created",
"total": 1,
"points": [
[
"Sep 1",
1
],
[
"Sep 2",
0
],
[
"Sep 3",
0
],
[
"Sep 4",
0
],
[
"Sep 5",
0
],
[
"Sep 6",
0
],
[
"Sep 7",
0
],
[
"Sep 8",
0
]
],
"metric": "count",
"surface": null,
"period": {
"identifier": "last-7-days",
"title": "Last 7 days",
"start_date": "2026-09-01",
"end_date": "2026-09-08",
"time_zone": "Eastern Time (US & Canada)"
}
}
}
]
}

Attributes

Records with "type": "analytics_aggregates". A series isn’t a stored record, so its id is made from the name, period, metric and surface that produced it, for example offer.viewed:2026-09:count.

Attribute Type Description
name string The event name
total integer The sum of points
points array [label, value] pairs, one per bucket. See Series.
metric string count or unique_visitors
surface string or null The filter[surface] used, or null
period object The period counted

Get a report

GET https://integrations.stokedhq.com/api/v1/analytics/reports/:report

Returns one of the reports on the portal’s Analytics pages, computed the same way, for one period. Reports are computed each time you ask, so there is nothing to sync incrementally: re-read the periods you chart.

:report Portal page
traffic_sources Traffic & sources
search_coverage Search & coverage gaps
prospect_funnel Prospect funnel
application_funnel Application funnel
advocate_engagement Advocate engagement
offer_engagement Monetization, offers
revenue_attribution Monetization, Shopify revenue

An unknown report returns 404. The portal’s Events tab (public event views and RSVPs) has no report here; count event.viewed, rsvp.started and rsvp.verified with aggregates instead.

Parameters

Parameter Description
filter[period] The period to report on. Defaults to last-30-days.

Request

GET /api/v1/analytics/reports/prospect_funnel

cURL

curl -G "https://integrations.stokedhq.com/api/v1/analytics/reports/prospect_funnel" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Accept: application/vnd.api+json" \
--data-urlencode "filter[period]=last-30-days"

Ruby

require "net/http"
require "json"
uri = URI("https://integrations.stokedhq.com/api/v1/analytics/reports/prospect_funnel")
uri.query = URI.encode_www_form("filter[period]" => "last-30-days")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer YOUR_API_KEY"
request["Accept"] = "application/vnd.api+json"
response = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(request) }
raise "HTTP #{response.code}: #{response.body}" unless response.is_a?(Net::HTTPSuccess)
puts JSON.parse(response.body)["data"]

Python

import requests
response = requests.get(
"https://integrations.stokedhq.com/api/v1/analytics/reports/prospect_funnel",
headers={
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/vnd.api+json",
},
params={"filter[period]": "last-30-days"},
)
response.raise_for_status()
print(response.json()["data"])

C#

using System.Net.Http.Headers;
using System.Text.Json;
using var client = new HttpClient();
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", "YOUR_API_KEY");
client.DefaultRequestHeaders.Accept.ParseAdd("application/vnd.api+json");
using var response = await client.GetAsync("https://integrations.stokedhq.com/api/v1/analytics/reports/prospect_funnel?filter[period]=last-30-days");
response.EnsureSuccessStatusCode();
using var document = JsonDocument.Parse(await response.Content.ReadAsStringAsync());
Console.WriteLine(document.RootElement.GetProperty("data"));

JavaScript

const url = new URL("https://integrations.stokedhq.com/api/v1/analytics/reports/prospect_funnel");
url.searchParams.set("filter[period]", "last-30-days");
const response = await fetch(url, {
headers: {
Authorization: "Bearer YOUR_API_KEY",
Accept: "application/vnd.api+json",
},
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const { data } = await response.json();
console.log(data);

Attributes

A single record with "type": "analytics_reports" and the report’s name as its id.

Attribute Type Description
period object The period reported on
data object The report itself. Its keys depend on the report, below.

Percentages are numbers from 0 to 100, rounded to one decimal place, and 0.0 when there is nothing to divide by. Each report’s data always has every key listed, even when the period is empty.

Lists marked “top 10” or “top 25” are capped the same way as the portal’s tables. The others are complete.

Traffic sources

Visits to your community site and embedded site. Visits to the advocate site and admin portal are not counted.

Key Description
total_visits Visits that started in the period
unique_visitors Distinct visitors (browsers) among them
identified_visits Visits linked to a signed-in person
visits_series, visitors_series Visits and distinct visitors per bucket. See Series.
by_surface Visits per site, as {key, label, visits}: community_site (“Hosted site”) and embedded_community_site (“Embedded widget”). Sites with no visits are left out.
top_referrers Top 10 referring domains, as {key, label, visits}
top_utm_sources Top 10 utm_source values, as {key, label, visits}
Response analytics-reports-traffic-sources.json Download
{
"data": {
"type": "analytics_reports",
"id": "traffic_sources",
"attributes": {
"period": {
"identifier": "last-7-days",
"title": "Last 7 days",
"start_date": "2026-09-01",
"end_date": "2026-09-08",
"time_zone": "Eastern Time (US & Canada)"
},
"data": {
"total_visits": 5,
"unique_visitors": 5,
"identified_visits": 1,
"visits_series": [
[
"Sep 1",
1
],
[
"Sep 2",
1
],
[
"Sep 3",
2
],
[
"Sep 4",
1
],
[
"Sep 5",
0
],
[
"Sep 6",
0
],
[
"Sep 7",
0
],
[
"Sep 8",
0
]
],
"visitors_series": [
[
"Sep 1",
1
],
[
"Sep 2",
1
],
[
"Sep 3",
2
],
[
"Sep 4",
1
],
[
"Sep 5",
0
],
[
"Sep 6",
0
],
[
"Sep 7",
0
],
[
"Sep 8",
0
]
],
"by_surface": [
{
"key": "community_site",
"label": "Hosted site",
"visits": 4
},
{
"key": "embedded_community_site",
"label": "Embedded widget",
"visits": 1
}
],
"top_referrers": [
{
"key": "www.google.com",
"label": "www.google.com",
"visits": 2
},
{
"key": "example-bikes.com",
"label": "example-bikes.com",
"visits": 1
}
],
"top_utm_sources": [
{
"key": "newsletter",
"label": "newsletter",
"visits": 1
}
]
}
}
}
}

Search coverage

Location searches on your maps, and whether an advocate was nearby. The advocate counts are taken when the search happens, so they show your coverage at that time.

Key Description
total_searches Location searches in the period
geocoded_searches Searches that matched a place
coverage_gap_searches Matched searches with no advocate within 25 miles
median_nearest_advocate_mi Median distance from a matched search to the nearest advocate, in miles, or null
searches_series Searches per bucket
locations Every matched city, most searched first, as {city, state, label, searches, advocates_within_25mi, nearest_advocate_mi}. advocates_within_25mi is the most found by any search there; nearest_advocate_mi the closest.
top_locations The first 10 of locations
coverage_gaps The first 10 of locations where no search found an advocate within 25 miles
top_terms Top 10 typed searches, as {term, searches}. Empty when Raw search query storage is off.
raw_query_storage_enabled Whether Raw search query storage is on now
Response analytics-reports-search-coverage.json Download
{
"data": {
"type": "analytics_reports",
"id": "search_coverage",
"attributes": {
"period": {
"identifier": "last-7-days",
"title": "Last 7 days",
"start_date": "2026-09-01",
"end_date": "2026-09-08",
"time_zone": "Eastern Time (US & Canada)"
},
"data": {
"total_searches": 3,
"geocoded_searches": 3,
"coverage_gap_searches": 1,
"median_nearest_advocate_mi": 1.4,
"searches_series": [
[
"Sep 1",
0
],
[
"Sep 2",
2
],
[
"Sep 3",
1
],
[
"Sep 4",
0
],
[
"Sep 5",
0
],
[
"Sep 6",
0
],
[
"Sep 7",
0
],
[
"Sep 8",
0
]
],
"top_locations": [
{
"city": "Springfield",
"state": "IL",
"label": "Springfield, IL",
"searches": 2,
"advocates_within_25mi": 1,
"nearest_advocate_mi": 1.4
},
{
"city": "Shelbyville",
"state": "IL",
"label": "Shelbyville, IL",
"searches": 1,
"advocates_within_25mi": 0,
"nearest_advocate_mi": 58.2
}
],
"coverage_gaps": [
{
"city": "Shelbyville",
"state": "IL",
"label": "Shelbyville, IL",
"searches": 1,
"advocates_within_25mi": 0,
"nearest_advocate_mi": 58.2
}
],
"locations": [
{
"city": "Springfield",
"state": "IL",
"label": "Springfield, IL",
"searches": 2,
"advocates_within_25mi": 1,
"nearest_advocate_mi": 1.4
},
{
"city": "Shelbyville",
"state": "IL",
"label": "Shelbyville, IL",
"searches": 1,
"advocates_within_25mi": 0,
"nearest_advocate_mi": 58.2
}
],
"top_terms": [
{
"term": "springfield il",
"searches": 2
},
{
"term": "shelbyville",
"searches": 1
}
],
"raw_query_storage_enabled": true
}
}
}
}

Prospect funnel

Sessions on your community site and embedded site that reached each step on the way to a conversation. The steps are explained in Funnel Reports.

Key Description
steps The five steps in order, each as {key, label, sessions, pct_of_start, pct_of_previous, drop_off_sessions, drop_off_pct}. key is the step’s event name.
overall_conversion_rate Sessions that sent a message, as a percentage of sessions that viewed a profile
profile_to_started_rate Sessions that started the contact form, as a percentage of profile views
started_to_message_rate Sessions that sent a message, as a percentage of those that started the form
contact_form The two-step contact form: started (finished step 1), went_back (clicked Back on step 2), submitted, abandonment_rate and completion_rate. started and went_back are 0 for one-step forms.
application_form_views Sessions that viewed your join form

Each step is counted on its own, so a later step can be larger than an earlier one. drop_off_sessions is never negative.

Response analytics-reports-prospect-funnel.json Download
{
"data": {
"type": "analytics_reports",
"id": "prospect_funnel",
"attributes": {
"period": {
"identifier": "last-7-days",
"title": "Last 7 days",
"start_date": "2026-09-01",
"end_date": "2026-09-08",
"time_zone": "Eastern Time (US & Canada)"
},
"data": {
"steps": [
{
"key": "advocate.profile_viewed",
"label": "Profile views",
"sessions": 2,
"pct_of_start": 100.0,
"pct_of_previous": 100.0,
"drop_off_sessions": 0,
"drop_off_pct": 0.0
},
{
"key": "send_message.started",
"label": "Started messaging",
"sessions": 1,
"pct_of_start": 50.0,
"pct_of_previous": 50.0,
"drop_off_sessions": 1,
"drop_off_pct": 50.0
},
{
"key": "conversation.created",
"label": "Message sent",
"sessions": 1,
"pct_of_start": 50.0,
"pct_of_previous": 100.0,
"drop_off_sessions": 0,
"drop_off_pct": 0.0
},
{
"key": "conversation.verification_viewed",
"label": "Verification viewed",
"sessions": 1,
"pct_of_start": 50.0,
"pct_of_previous": 100.0,
"drop_off_sessions": 0,
"drop_off_pct": 0.0
},
{
"key": "waiver.signing_viewed",
"label": "Waiver signing viewed",
"sessions": 0,
"pct_of_start": 0.0,
"pct_of_previous": 0.0,
"drop_off_sessions": 1,
"drop_off_pct": 100.0
}
],
"overall_conversion_rate": 50.0,
"profile_to_started_rate": 50.0,
"started_to_message_rate": 100.0,
"contact_form": {
"started": 0,
"went_back": 0,
"submitted": 1,
"abandonment_rate": 0.0,
"completion_rate": 0.0
},
"application_form_views": 1
}
}
}
}

Application funnel

From the join form to an approved application. Explained in Funnel Reports.

Key Description
steps The four steps in order, each as {key, label, count, pct_of_start, pct_of_previous, drop_off_count, drop_off_pct}. The first two count sessions; application.submitted and application.approved count applications submitted in the period, and how many of them are approved now.
overall_conversion_rate Approved applications as a percentage of form-view sessions
view_to_started_rate Sessions that started the form, as a percentage of form views
started_to_submitted_rate Applications submitted, as a percentage of sessions that started the form
approval_rate The percentage of the period’s applications that are approved
outcome The period’s applications split into approved, rejected and pending. The three add up to the submitted count.

The steps are named count and drop_off_count here, where the prospect funnel says sessions and drop_off_sessions.

Response analytics-reports-application-funnel.json Download
{
"data": {
"type": "analytics_reports",
"id": "application_funnel",
"attributes": {
"period": {
"identifier": "last-7-days",
"title": "Last 7 days",
"start_date": "2026-09-01",
"end_date": "2026-09-08",
"time_zone": "Eastern Time (US & Canada)"
},
"data": {
"steps": [
{
"key": "application.form_viewed",
"label": "Form views",
"count": 1,
"pct_of_start": 100.0,
"pct_of_previous": 100.0,
"drop_off_count": 0,
"drop_off_pct": 0.0
},
{
"key": "application.form_started",
"label": "Started filling",
"count": 1,
"pct_of_start": 100.0,
"pct_of_previous": 100.0,
"drop_off_count": 0,
"drop_off_pct": 0.0
},
{
"key": "application.submitted",
"label": "Submitted",
"count": 0,
"pct_of_start": 0.0,
"pct_of_previous": 0.0,
"drop_off_count": 1,
"drop_off_pct": 100.0
},
{
"key": "application.approved",
"label": "Approved",
"count": 0,
"pct_of_start": 0.0,
"pct_of_previous": 0.0,
"drop_off_count": 0,
"drop_off_pct": 0.0
}
],
"overall_conversion_rate": 0.0,
"view_to_started_rate": 100.0,
"started_to_submitted_rate": 0.0,
"approval_rate": 0.0,
"outcome": {
"approved": 0,
"rejected": 0,
"pending": 0
}
}
}
}
}

Advocate engagement

How advocates use the advocate site to read their conversations.

Key Description
active_advocates Advocates who viewed at least one conversation in the period
total_conversation_views Conversation views on the advocate site
views_series Conversation views per bucket
advocates Every advocate with activity in the period, most views first, as {advocate_id, name, conversation_views, waiver_views_seen}. waiver_views_seen counts the times a waiver-signed notice scrolled into view.
waiver_followup Of conversations with a signed waiver, how many the advocate opened after the signing: total, viewed_after_signing, percentage, and median_latency_seconds (the median time to that view, or null). This one counts all time, whatever the period.

advocate_id is Stoked’s internal number for the advocate, not the advocate’s API id. name is the advocate’s first and last name.

Response analytics-reports-advocate-engagement.json Download
{
"data": {
"type": "analytics_reports",
"id": "advocate_engagement",
"attributes": {
"period": {
"identifier": "last-7-days",
"title": "Last 7 days",
"start_date": "2026-09-01",
"end_date": "2026-09-08",
"time_zone": "Eastern Time (US & Canada)"
},
"data": {
"active_advocates": 1,
"total_conversation_views": 1,
"views_series": [
[
"Sep 1",
1
],
[
"Sep 2",
0
],
[
"Sep 3",
0
],
[
"Sep 4",
0
],
[
"Sep 5",
0
],
[
"Sep 6",
0
],
[
"Sep 7",
0
],
[
"Sep 8",
0
]
],
"advocates": [
{
"advocate_id": 900101,
"name": "Sarah Example",
"conversation_views": 1,
"waiver_views_seen": 0
}
],
"waiver_followup": {
"total": 0,
"viewed_after_signing": 0,
"percentage": 0.0,
"median_latency_seconds": null
}
}
}
}
}

Offer engagement

Views and clicks on your offers.

Key Description
total_views, total_clicks Offer views and clicks in the period
click_through_rate Clicks as a percentage of views
views_series Offer views per bucket
offers Every offer viewed or clicked in the period, most viewed first, as {offer_id, name, views, clicks, click_through_rate}

offer_id is Stoked’s internal number for the offer.

Response analytics-reports-offer-engagement.json Download
{
"data": {
"type": "analytics_reports",
"id": "offer_engagement",
"attributes": {
"period": {
"identifier": "last-7-days",
"title": "Last 7 days",
"start_date": "2026-09-01",
"end_date": "2026-09-08",
"time_zone": "Eastern Time (US & Canada)"
},
"data": {
"total_views": 1,
"total_clicks": 1,
"click_through_rate": 100.0,
"views_series": [
[
"Sep 1",
1
],
[
"Sep 2",
0
],
[
"Sep 3",
0
],
[
"Sep 4",
0
],
[
"Sep 5",
0
],
[
"Sep 6",
0
],
[
"Sep 7",
0
],
[
"Sep 8",
0
]
],
"offers": [
{
"offer_id": 900401,
"name": "Spring test ride offer",
"views": 1,
"clicks": 1,
"click_through_rate": 100.0
}
]
}
}
}
}

Revenue attribution

Shopify orders Stoked tied to an advocate or conversation. Empty unless your Shopify store is connected.

Key Description
shopify_connected Whether a Shopify store is connected now
attributed_orders Orders placed in the period, refunded ones included
attributed_revenue_cents Order subtotals in the period, in cents, refunded orders left out
currency The currency with the most revenue in the period (USD when there is none). Amounts in other currencies are added in as if they were the same currency.
revenue_series Revenue per bucket, in currency units (1899.0), not cents
by_source Orders and revenue per attribution source, most orders first, as {source, label, orders, revenue_cents}. source is discount_code, landing_site, manual or unattributed.
top_advocates Top 10 advocates by revenue, as {advocate_id, name, orders, revenue_cents}. Refunded orders are left out of both numbers.

advocate_id is Stoked’s internal number for the advocate, not the advocate’s API id.

Response analytics-reports-revenue-attribution.json Download
{
"data": {
"type": "analytics_reports",
"id": "revenue_attribution",
"attributes": {
"period": {
"identifier": "last-7-days",
"title": "Last 7 days",
"start_date": "2026-09-01",
"end_date": "2026-09-08",
"time_zone": "Eastern Time (US & Canada)"
},
"data": {
"shopify_connected": true,
"attributed_orders": 1,
"attributed_revenue_cents": 189900,
"currency": "USD",
"revenue_series": [
[
"Sep 1",
0.0
],
[
"Sep 2",
0.0
],
[
"Sep 3",
0.0
],
[
"Sep 4",
0.0
],
[
"Sep 5",
1899.0
],
[
"Sep 6",
0.0
],
[
"Sep 7",
0.0
],
[
"Sep 8",
0.0
]
],
"by_source": [
{
"source": "discount_code",
"label": "Discount code",
"orders": 1,
"revenue_cents": 189900
}
],
"top_advocates": [
{
"advocate_id": 900101,
"name": "Sarah Example",
"orders": 1,
"revenue_cents": 189900
}
]
}
}
}
}

Event names

Use these in filter[name]. An event is recorded only while its Data Collection toggle is on: page.viewed needs Page view tracking and every other event needs Behavioral events.

Name Recorded when Typical properties
page.viewed Someone opens a page on any of your sites, the admin portal included controller, action; widget on the embedded site
search.location A visitor searches a map by location query (when Raw search query storage is on), geocoded, result_city, result_state, result_country, result_latitude, result_longitude, advocates_within_25mi, nearest_advocate_mi
search.filters_applied A visitor applies map filters selections, matched_count, zero_results
map.results_refreshed The map’s results are reloaded lat, lng, result_count, nearby_fill_count, selections
map.viewed A map opens with a saved map applied map_id
advocate.profile_viewed A visitor opens an advocate’s profile advocate_id, source (map_marker, card_list or direct)
send_message.started A visitor types into the contact form advocate_id
send_message.step1_completed A visitor finishes step 1 of the two-step contact form advocate_id
send_message.step2_back A visitor clicks Back on step 2 advocate_id
conversation.created A visitor sends a message, starting a conversation advocate_id, prospect_id, conversation_id
conversation.verification_viewed A prospect reaches the verification page conversation_id
waiver.signing_viewed A prospect opens a waiver signing link waiver_request_id, conversation_id, waiver_template_id, completed
application.form_viewed A visitor opens your join form application_form, custom_questions_count
application.form_started A visitor types into the join form  
application.submitted An application is submitted application_form, custom_questions_count
application.submission_failed A submission is sent back with errors error_fields: the fields that failed, never what was typed
offer.viewed A prospect opens an advocate’s offer offer_id, advocate_id, conversation_ulid
offer.clicked A prospect clicks through to the store offer_id, advocate_id, conversation_ulid
event.viewed A visitor opens a public event public_event_id
rsvp.started A visitor submits an RSVP public_event_id
rsvp.verified An RSVP is verified public_event_id, channel, sms_consent
conversation.viewed An advocate opens a conversation on the advocate site conversation_id, beats_count, has_waiver_signed_beat, last_beat_type
waiver.signed_seen A waiver-signed notice scrolls into an advocate’s view conversation_id, beat_type, beat_ulid

Properties with no value are left out rather than set to null. Every event also carries surface.

Surfaces

Surface Site
community_site Your hosted community site
embedded_community_site The map embedded on your own website
advocate_site The advocate site
community_admin_site The admin portal

Related: Funnel Reports · Analytics & Tracking · Reply Speed API


© 2024-2026 Stoked — Real conversations. Real trust.