v1Resources/Profile Analytics/getGet the funnel report
Get the funnel report
The Reports page's full-funnel report: what people did after finding your clients, per channel (Business Profile, website, Google search, social and review invites), over the last 4 or 12 full weeks against the same number of weeks before. Also returns new reviews, actions across channels, a per-client ranking and ranked breakdowns. Each number comes from one platform, and null means not reported or not enough history, never zero.
get
analytics:read/api/v1/analytics/funnelQuery parameters
clientIdstringoptional
Limit to one client. Omit to report across every client your key can read.
weeksinteger (4 | 12)optional
How many full weeks the period covers: 4 or 12. Default 12.
Response
dataobjectoptional
weeksinteger (4 | 12)optional
periodobjectoptional
The report's period, Monday to Sunday, as YYYY-MM-DD dates.
startstringoptional
endstringoptional
previousPeriodobjectoptional
startstringoptional
endstringoptional
weekStartsarray of stringoptional
scopeobjectoptional
clientIdstringoptional
clientNamestringoptional
clientsnumberoptional
foodbooleanoptional
channelsarray of objectoptional
keystring (profile | website | search | social | invites)optional
The channel: profile, website, search, social or invites.
periodobjectoptional
This channel's own Monday to Sunday period, present when it ends earlier than the report's (Search Console data runs behind).
startstringoptional
endstringoptional
availablebooleanoptional
Whether this channel has numbers to show.
reasonstring (not_connected | no_data | denied)optional
Why the channel has no numbers: not_connected (no client in scope has the source connected), no_data (connected, but nothing reported in the period yet) or denied (your access doesn't include this channel).
coverageobjectoptional
Which clients the channel's numbers cover: clients reporting it, of the clients in scope, how many need a reconnect, how many are left out of the change (leftOut), the last week with data (through) and the platforms behind the numbers.
clientsnumberoptional
ofnumberoptional
reconnectnumberoptional
leftOutnumberoptional
throughstringoptional
providersarray of stringoptional
metricsarray of objectoptional
keystringoptional
The metric, for example profileViews, visits or searchClicks.
currentnumberoptional
This period's total across every reporting client. Null when nobody reported it.
previousnumberoptional
The previous period's total over like-for-like clients. Null when there isn't enough history.
changenumberoptional
Change against the previous period over like-for-like clients (0.12 = +12%). Null when previous is null or 0.
seriesarray of numberoptional
This period's values, one per week, oldest first. Null for a week nobody reported.
rateBasenumberoptional
The denominator for this step's rate when it isn't the previous step's value. For example, website key events come from GA4 only, so their rate is over GA4 visits only.
reviewsobjectoptional
New public reviews in the period: count, change, weekly series, average rating, replies and star mix.
availablebooleanoptional
reasonstringoptional
currentnumberoptional
previousnumberoptional
changenumberoptional
seriesarray of numberoptional
avgRatingnumberoptional
previousAvgRatingnumberoptional
repliednumberoptional
starsarray of numberoptional
actionsobjectoptional
Actions across Business Profile, website, social and review invites, counted per action, not per person. Google search clicks aren't included: they're already in website visits.
currentnumberoptional
previousnumberoptional
changenumberoptional
seriesarray of numberoptional
excludedFromChangearray of stringoptional
byClientarray of objectoptional
One row per client with any numbers, for ranking clients. Empty for a one-client report.
clientIdstringoptional
publicIdstringoptional
namestringoptional
actionsnumberoptional
previousnumberoptional
changenumberoptional
topChannelstringoptional
channelsarray of stringoptional
detailsarray of objectoptional
keystring (listingPlatforms | websiteSources | landingPages | goals | events | queries | searchPages | socialPlatforms | reviewPlatforms)optional
availablebooleanoptional
totalnumberoptional
providersarray of stringoptional
rowsarray of objectoptional
keystringoptional
valuesobjectoptional
kindstringoptional
countedbooleanoptional
providerstringoptional
notRankedbooleanoptional
lastSyncedAtstringoptional
generatedAtstringoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/analytics/funnel
Your API key
clientId
weeks
{}Guides that use this resource
- What Is a Local SEO API?A local SEO API measures how a business ranks in local search, with geo-grid rank tracking, profile analytics and AI visibility, not just backlinks.
- How to Add Local Marketing Features to Your SaaSAdd listings management, reviews, Google posts, profile analytics, rank tracking and AI visibility to a SaaS product with the Synup API, tenant by tenant.
- How to Build a Multi-Location Marketing DashboardBuild a multi-location marketing dashboard from the API's rollup endpoints, one call per panel, covering listings, reviews, rank, AI visibility and duplicates.
- How to Retrieve Google Business Profile Analytics via APIPull Google Business Profile analytics through an API, portfolio-wide and per location, with views, calls, direction requests and a maps-versus-search split.
- Retrieve Profile Analytics via APIPull Google Business Profile analytics with the Synup API, portfolio-wide or per location, with views, actions, calls and direction requests.