weeveo
  • Features
  • How it works
  • Revenue
  • Agents
  • Pricing
  • Docs
Sign in
Start free
weeveoanalytics

Understand your traffic.See what leads to sales.

See where visitors come from, what they do and which visits lead to purchases. Basic statistics without a popup. Recordings require permission.

Start freeService status

© 2026 Weeveo. All rights reserved.

Product

  • Features
  • Revenue reporting
  • Realtime
  • Funnels & journeys
  • Pricing

Developers

  • Documentation
  • Agents & MCP
  • Browser SDK
  • REST API
  • Start free
  • Sign in

Company

  • Changelog
  • Support
  • Contact
  • Privacy policy
  • Terms of service
  • Refund policy
  • Status

weeveo

Skip to content
Documentation home
Start here
Meet WeeveoYour first siteFind your way aroundCore concepts & metrics
Install & track
Install the trackerFramework & CMS recipesTracker configurationBrowser SDK referenceConsent & your CMPVisitor identity & payment matchingVerify your installationCustom tracking domains
Understand your traffic
Overview & realtimeDates, filters & comparisonsSources & campaignsPages & engagementEvents & visitor timelinesExplore, paths & saved viewsTraffic quality & anomalies
Conversions & revenue
Goals & conversionsFunnels & bottlenecksRetention cohortsRevenue reportingConnect a payment providerAttribution modelsCustomer journeysAll payment providers
Experience & performance
Session replaysClick & scroll heatmapsWeb Vitals & performance
Developers & agents
Connect ChatGPT, Claude & agentsCreate & manage API keysREST API quickstartAnalytics query referenceErrors, limits & safe retriesJavaScript & Python examplesMCP transport & tool discoveryOAuth discovery & authorizationPermissions & write consentAsk Weeveo & saved chatsApp identity & plugin metadataHTTP surface referenceAll API & MCP tools
Workspace & privacy
Workspaces & multiple sitesTeam, roles & invitationsSite preferences & notificationsPublic reports, embeds & badgesAccount & securityPrivacy & collection controlsVisitor export & erasure
Operate Weeveo
Background jobs & maintenanceTroubleshooting & common questionsQuestions & analysis recipes
Building something?Explore every API tool Download JSON reference ↗
DocsDevelopers & agents
Developers & agents

API & MCP reference

The complete REST and MCP catalog, generated from Weeveo's actual tool registry.

On this page
Tool catalog

Find a tool for any part of Weeveo. Open its reference for exact arguments, defaults, validation and examples. Read tools accept GET or POST; changes require POST and explicit write consent.

REST quickstart Access & permissions Download JSON

Tool catalog

93 tools in one place57 read tools36 management tools
Find an API tool

Showing 93 tools

Site & workspaceRead

List projects

list_projects

Lists the Weeveo projects (websites) this credential can read, with their ids and domains.

GET · POSTView reference
TrafficRead

Traffic summary

get_traffic_summary

Visitors, pageviews, sessions, bounce rate and average session duration, with deltas vs the previous period.

GET · POSTView reference
TrafficRead

Traffic over time

get_timeseries

Visitors, pageviews and sessions bucketed by hour, day or week.

GET · POSTView reference
TrafficRead

Dimension breakdown

get_breakdown

Top values for a dimension (page, referrer, utm_source, utm_medium, utm_campaign, country, region, city, device_type, browser, os). Use pageMode for entry/exit pages.

GET · POSTView reference
TrafficRead

Realtime visitors

get_realtime

Active visitor count and aggregate per-minute activity for the last 30 minutes. No individual visitor records.

GET · POSTView reference
TrafficRead

List events

list_events

Event names captured in the range with counts, unique visitors and visitor conversion rate.

GET · POSTView reference
RevenueRead

Revenue summary

get_revenue_summary

Total revenue, refunds, customers, ARPU, revenue per visitor and visitor→customer conversion rate.

GET · POSTView reference
RevenueRead

Revenue attribution

get_revenue_attribution

Revenue credited to sources, mediums, campaigns or landing pages using first_touch, last_touch, linear, u_shaped or time_decay attribution.

GET · POSTView reference
RevenueRead

Customer journey

query_customer_journey

Retrieve recorded visits and purchases for an authorized project using a customer email or transaction id. Share personal data only with authorized recipients.

GET · POSTView reference
ConversionsRead

Analyze funnel bottlenecks

analyze_funnel_bottlenecks

Step-by-step conversion for a saved funnel, plus the biggest drop-off and the exit pages behind it. Omit funnelId to list the saved funnels.

GET · POSTView reference
TrafficRead

Detect anomalies

detect_anomalies

Z-score and IQR outlier detection over daily visitors, pageviews, revenue and conversion rate, plus failed payment webhooks.

GET · POSTView reference
TrafficRead

Traffic diagnostics

get_traffic_diagnostics

Delta analysis across visitors, bounce rate, session duration, devices, sources and top pages versus the comparison period, with the most common session paths.

GET · POSTView reference
TrafficRead

Audience demographics

get_demographics

Audience geography and technology: countries, regions, cities, city-location coverage, devices, browsers and operating systems. Uses the dashboard's dates, timezone and traffic filters. Locations are approximate; age and gender are not collected.

GET · POSTView reference
TrafficRead

Export report CSV

export_report

Export traffic timeseries, dimension breakdowns, visitor paths or quality evidence as formula-safe CSV for download.

GET · POSTView reference
TrafficRead

Page report

get_pages

Top, landing and exit pages with visitors, views and bounce rates, using the site's timezone and filters.

GET · POSTView reference
TrafficRead

Session engagement

get_session_engagement

Average session duration and bounce rate over time for the selected date range and traffic filters.

GET · POSTView reference
TrafficRead

Visitors

list_visitors

Visitor records for the authorized site and date range. Results can contain personal analytics data.

GET · POSTView reference
TrafficRead

Visitor activity

get_visitor_events

Recorded event timeline for one visitor in the authorized site, bounded by the requested limit.

GET · POSTView reference
TrafficRead

Realtime activity

get_realtime_activity

Live visitor records, locations, recent events and per-minute traffic in the authorized site.

GET · POSTView reference
TrafficRead

Bot traffic

get_bot_traffic

Bot and suspicious traffic report, including classifications and counts, for the authorized site.

GET · POSTView reference
TrafficRead

Traffic quality evidence

get_evidence_trail

Traffic quality and payment evidence behind the dashboard, with the same date range and filters.

GET · POSTView reference
ConversionsRead

Visitor paths

get_paths

Most common ordered page paths through the site, with counts and a configurable number of steps.

GET · POSTView reference
ConversionsRead

Exit drop-offs

get_dropoffs

Pages where visitors leave the authorized site, ranked using the selected analytics range and filters.

GET · POSTView reference
ConversionsRead

Custom funnel

query_funnel

Evaluate an ad-hoc sequence of page or event steps without saving a funnel. Names default to matching values.

GET · POSTView reference
ConversionsRead

Goal conversions

get_goal_conversions

Conversion counts and rates for every saved page or event goal in the selected date range and filters.

GET · POSTView reference
ConversionsRead

Retention cohorts

get_retention

Daily visitor retention cohorts and return rates using the authorized site's configured timezone.

GET · POSTView reference
ExperienceRead

Web vitals

get_performance_summary

Core Web Vitals summary with LCP, INP, CLS, FCP and TTFB distributions for the selected range.

GET · POSTView reference
ExperienceRead

Web vitals over time

get_performance_timeseries

Selected Web Vital and percentile over time with the same scope and filters as the performance page.

GET · POSTView reference
ExperienceRead

Web vitals breakdown

get_performance_breakdown

Compare Web Vitals by page path, page title, device or browser at a selected percentile.

GET · POSTView reference
ExperienceRead

Session recordings

list_replays

Find recorded sessions by date, path, visitor, session and minimum duration for an authorized site.

GET · POSTView reference
ExperienceRead

Session replay

get_replay

Retrieve a masked session recording and metadata for the authorized site. Can contain personal analytics data.

GET · POSTView reference
ExperienceRead

Replay event timeline

get_replay_events

Pageviews and custom events belonging to a recorded session in the authorized site, for replay context.

GET · POSTView reference
ExperienceRead

Click and scroll heatmaps

get_heatmap

Page heatmap points, scroll depth and page choices by device using the selected date range.

GET · POSTView reference
ExperienceRead

Heatmap page capture

get_heatmap_snapshot

Latest complete masked page capture for a heatmap path, optionally matched to a viewport width.

GET · POSTView reference
RevenueRead

Revenue over time

get_revenue_timeseries

Revenue and transaction time series in the site's reporting currency. Values retain the service's named minor-unit fields.

GET · POSTView reference
RevenueRead

Attribution flow

get_attribution_flow

Revenue paths between marketing sources and purchases under first, last, linear, U-shaped or time-decay attribution.

GET · POSTView reference
RevenueRead

Payment transactions

list_transactions

Paginated purchases, refunds and source attribution in the authorized site. Monetary fields named Cents are minor units.

GET · POSTView reference
Site & workspaceRead

Site settings

get_project_settings

Read site identity, timezone, currency, exclusions, consent, recorder and notification settings without secrets.

GET · POSTView reference
Site & workspaceWrite consent

Update site settings

update_project_settings

Update site name, timezone, currency, CORS, excluded paths and email notifications. Requires explicit write consent and admin access.

POSTView reference
ExperienceWrite consent

Configure recordings

update_recorder_settings

Enable or disable replay and heatmaps, sample rates, duration and blocked selectors. Text and inputs stay strictly masked.

POSTView reference
Access & privacyWrite consent

Configure analytics consent

update_privacy_settings

Pause or enable tracking and identity collection. Enabling requires a valid HTTPS notice, explicit acknowledgment and no queued erasure.

POSTView reference
Site & workspaceRead

Tracker installation

get_tracking_installation

Get the canonical tracker URL, complete installation snippet and consent setup for installation, onboarding and custom domains.

GET · POSTView reference
Site & workspaceWrite consent

Complete installation

complete_onboarding

Mark this site's installation walkthrough complete after the user has installed the tracker and configured consent.

POSTView reference
Site & workspaceWrite consent

Create a site

create_project

Create a site in the authorized site's workspace. The new site needs a new connection before this credential can read it.

POSTView reference
Site & workspaceWrite consent

Delete a site

delete_project

Permanently delete the authorized site and queue analytics cleanup. Owner role and exact domain confirmation are required.

POSTView reference
ConversionsRead

Saved funnels

list_funnels

List all saved funnel definitions, matching steps and conversion windows for the authorized site.

GET · POSTView reference
ConversionsWrite consent

Create a funnel

create_funnel

Save a funnel with two to eight named page or event steps and a bounded conversion window. Member access is required.

POSTView reference
ConversionsWrite consent

Update a funnel

update_funnel

Change the authorized site's saved funnel name, steps or conversion window. Requires explicit write consent and member access.

POSTView reference
ConversionsWrite consent

Delete a funnel

delete_funnel

Remove one saved funnel in the authorized site. This does not delete the underlying analytics events.

POSTView reference
ConversionsRead

Saved conversion goals

list_goals

List all saved pageview and custom-event goal definitions for the authorized site without querying conversions.

GET · POSTView reference
ConversionsWrite consent

Create a goal

create_goal

Save a pageview or event conversion goal, with wildcard matching and the same fifty-goal limit as the dashboard.

POSTView reference
ConversionsWrite consent

Update a goal

update_goal

Update a saved conversion goal's name, event or page matching rule in the authorized site. Requires member access.

POSTView reference
ConversionsWrite consent

Delete a goal

delete_goal

Delete one saved conversion goal from the authorized site without deleting its recorded events.

POSTView reference
ConversionsRead

My saved reports

list_saved_views

List the credential owner's saved Explore views with date ranges and filters. Other users' views remain private.

GET · POSTView reference
ConversionsWrite consent

Save a report view

save_view

Save a named Explore report with whitelisted date, traffic and dimension filters for the credential owner only.

POSTView reference
ConversionsWrite consent

Delete a saved report

delete_saved_view

Delete a saved Explore report belonging to the credential owner in the authorized site, preserving other users' views.

POSTView reference
Access & privacyRead

Public dashboards

list_share_links

List public dashboard links, badge and embed URLs and their revenue visibility. Requires site administrator access.

GET · POSTView reference
Access & privacyWrite consent

Create public dashboard

create_share_link

Publish a domain-named public aggregate dashboard link with optional revenue visibility. Requires explicit write consent and admin access.

POSTView reference
Access & privacyWrite consent

Update public dashboard

update_share_link

Enable, disable or change revenue visibility on a public link belonging to the authorized site. Requires admin access.

POSTView reference
Access & privacyWrite consent

Revoke public dashboard

delete_share_link

Permanently revoke an authorized site's public dashboard, badge and embed link. Requires administrator access.

POSTView reference
Access & privacyRead

API key metadata

list_api_keys

List key names, masked identifiers, permissions, expiry and usage. Full API keys and stored hashes are never returned.

GET · POSTView reference
Access & privacyWrite consent

Create an API key

create_api_key

Create a named expiring key. Returns the secret exactly once. Write access requires allowWrite=true and existing write consent; save it now.

POSTView reference
Access & privacyWrite consent

Delete an API key

delete_api_key

Delete a key scoped to the authorized site and immediately revoke its access. Full keys cannot be retrieved.

POSTView reference
Access & privacyRead

Connected agents

list_oauth_connections

List the credential owner's OAuth agents and granted scopes for the authorized site, without exposing tokens.

GET · POSTView reference
Access & privacyWrite consent

Disconnect an agent

revoke_oauth_connection

Revoke one of the credential owner's OAuth connections for the authorized site, invalidating access and refresh tokens across all sites in that connection.

POSTView reference
Access & privacyRead

API and MCP activity

get_api_activity

Recent MCP, REST and Ask Weeveo tool calls, durations and outcomes for the authorized site. Arguments and secrets are not logged.

GET · POSTView reference
RevenueRead

Payment integrations

list_integrations

List supported payment gateways, connection status and webhook URLs. Encrypted credentials and signing secrets are never returned.

GET · POSTView reference
RevenueWrite consent

Connect a payment gateway

connect_integration

Verify and store a payment provider API key or webhook signing secret encrypted. Credentials are inputs only and never returned or logged.

POSTView reference
RevenueWrite consent

Disconnect payment gateway

disconnect_integration

Remove a payment integration and its stored credentials from the authorized site. Existing transactions remain in reports.

POSTView reference
RevenueWrite consent

Import payment history

sync_integration

Synchronize recent transactions from a supported connected payment gateway into the authorized site's revenue reports.

POSTView reference
RevenueWrite consent

Register payment webhook

register_integration_webhook

Register a canonical HTTPS webhook at a supported connected provider, storing its returned signing secret encrypted.

POSTView reference
RevenueRead

Payment webhook status

list_webhook_events

List payment webhook audit statuses and event types for the authorized site, omitting raw payloads and credentials.

GET · POSTView reference
Site & workspaceRead

Tracking domain and DNS

get_tracking_domain

Read the site's custom tracking domain, activation state and exact DNS records required to verify ownership.

GET · POSTView reference
Site & workspaceWrite consent

Set a tracking domain

set_tracking_domain

Configure a first-party tracking subdomain belonging to this site. Requires subsequent DNS ownership and HTTPS verification.

POSTView reference
Site & workspaceWrite consent

Verify tracking DNS and HTTPS

verify_tracking_domain

Verify both tracking DNS records, provision the Cloud Run mapping and activate only after the pinned HTTPS ownership check passes.

POSTView reference
Site & workspaceWrite consent

Remove tracking domain

remove_tracking_domain

Remove the site's custom tracking hostname. Reinstall the standard tracker snippet and remove the old DNS records afterward.

POSTView reference
Site & workspaceRead

Workspace settings

get_workspace

Read the workspace name, plan and current role through the authorized site. Requires current workspace membership.

GET · POSTView reference
Site & workspaceWrite consent

Rename a workspace

update_workspace

Rename the workspace containing this site. This affects all of its sites and requires administrator access and write consent.

POSTView reference
Site & workspaceRead

Workspace members

list_members

List workspace members and roles through the authorized site. Requires current administrator access; emails are personal data.

GET · POSTView reference
Site & workspaceWrite consent

Change a member role

update_member_role

Change another non-owner workspace member to admin, member or viewer. Owners require the authenticated ownership-transfer flow.

POSTView reference
Site & workspaceWrite consent

Remove a workspace member

remove_member

Remove another non-owner workspace member and revoke their connected access. Owners must use ownership transfer first.

POSTView reference
Site & workspaceRead

Pending invitations

list_invitations

List pending workspace invitations and expiration dates. Invitation tokens are never returned; administrator access is required.

GET · POSTView reference
Site & workspaceWrite consent

Invite a workspace member

invite_member

Send an explicitly requested workspace invitation email with a selected role. Requires write consent and administrator access.

POSTView reference
Site & workspaceWrite consent

Resend an invitation

resend_invitation

Send a fresh explicitly requested workspace invitation email and invalidate the previous link. Requires administrator access.

POSTView reference
Site & workspaceWrite consent

Revoke an invitation

revoke_invitation

Revoke a pending invitation in the authorized site's workspace so the emailed link can no longer be accepted.

POSTView reference
Access & privacyRead

Export visitor data

export_visitor_data

Export a specific visitor's analytics and legacy identity mappings for a privacy request. Requires admin access; large exports fail explicitly.

GET · POSTView reference
Access & privacyWrite consent

Erase visitor analytics

erase_visitor_data

Queue a confirmed visitor privacy erasure and pause collection for the site until reviewed. Requires admin access and exact visitor confirmation.

POSTView reference
Access & privacyRead

Visitor erasure status

list_privacy_requests

List visitor privacy request status and completion times without exposing subjects or encrypted identifiers. Requires admin access.

GET · POSTView reference
Ask WeeveoWrite consent

Ask Weeveo

ask_weeveo

Ask the dashboard analytics assistant and save its answer in your private chat history. Uses the configured AI provider and aggregate read-only reports. Requires write consent to save the chat; does not allow the assistant to change settings.

POSTView reference
Ask WeeveoRead

My Ask Weeveo chats

list_agent_chats

List or search the credential owner's private Ask Weeveo conversations for the authorized site, with cursor pagination.

GET · POSTView reference
Ask WeeveoRead

Read my saved chat

get_agent_chat

Read a private Ask Weeveo conversation owned by this credential's user and site, with optional earlier-message pagination.

GET · POSTView reference
Ask WeeveoWrite consent

Delete my saved chat

delete_agent_chat

Delete one private Ask Weeveo conversation and its messages belonging to the credential owner in the authorized site.

POSTView reference
Access & privacyRead

Account and secure operations

get_account_management

Get authenticated account settings for password, email, passkeys, MFA, sessions, account export/deletion and workspace ownership transfer. These require browser reauthentication.

GET · POSTView reference

Still looking for an answer? Try troubleshooting or get in touch.

ExploreDocumentation homeReferenceAll API & MCP tools
ON THIS PAGE
Tool catalog
Your sites. Your permission.

Start with read access. Grant changes when you need them.

Understand access

Search Weeveo documentation

Good places to start

Start hereYour first siteGo from a new workspace to your first verified visit.Install & trackInstall the trackerOne shared script, configured for your site and consent policy.Install & trackBrowser SDK referenceTrack actions, inspect consent and identify a permitted persistent visitor.Developers & agentsConnect ChatGPT, Claude & agentsUse OAuth sign-in for hosted agents, with optional API keys for other clients.Developers & agentsAnalytics query referenceExact shared date, traffic, comparison and filter parameters.Developers & agentsAll API & MCP toolsEvery tool, argument schema and permission in the shared registry.
K to open↑ ↓ to select · Enter to open · Esc to close