Privatus Analytics runs a hosted Model Context Protocol server. The API
operations you're allowed to use are MCP tools, so an agent can
read your stats, create goals, add notes or check uptime with the same
permissions as your API token. The tools are listed under
All tools .
Endpoint
https://privatusanalytics.com/mcp
Transport
Streamable HTTP: POST only, JSON responses, no event stream (GET and DELETE respond with 405)
Auth
Authorization: Bearer pat_… or OAuth 2.1
Set it up in your client: Claude, ChatGPT, Gemini CLI, Cursor and VS Code .
The API tokens page with tokens, their permissions, sites and expiry dates.
API token. Create a token in Workspace settings → API tokens and send
it as a Bearer token. Give the token only the permissions the agent needs.
For read-only analysis, analytics.read is enough. See
Authentication .
OAuth. Clients that support MCP authorization can connect with just
the URL. The server publishes its metadata at
/.well-known/oauth-protected-resource and
/.well-known/oauth-authorization-server, supports dynamic client
registration (/oauth/register), client ID metadata documents (the way
Claude, ChatGPT and Smithery name themselves) and the authorization code flow with PKCE
(S256 only). You sign in, choose the workspace and the access, and approve:
Access
Scope
What the client gets
Read-only
read
The analytics.read permission, if your role has it
Full access
full
Everything your role allows in that workspace
The client receives an API token named after the client, with "(MCP)" at
the end. It appears in your token list, where you can revoke it. The access
token lasts an hour, and the client renews it with a refresh token
(grant_type=refresh_token), which is replaced at every renewal. Each
renewal reads your role again, so a token narrows when your role does and
stops when you leave the workspace. A connection nobody used for 90 days
ends, and the client asks you to approve again. Revoking either token at
/oauth/revoke ends the connection.
Clients that send a resource parameter (RFC 8707) must name this
server's /mcp address, or the request is refused with invalid_target.
Every response sent back to the client's redirect address carries iss
(RFC 9207).
A request without a valid token gets 401 with a WWW-Authenticate header
that points to the metadata. A request from a web page of another site
(an Origin header that isn't ours or a local address) gets 403.
Tools are named <resource>_<verb>:
Verb
HTTP
Example
list
GET a collection
sites_list, goals_list
get
GET one record
sites_get
create
POST
goals_create, notes_create
update
PATCH
sites_update
delete
DELETE
goals_delete
other actions
as named
goals_duplicate, stats_breakdown, docs_search
Each tool's input schema is the operation's inputs plus its path
parameters (site_id, workspace_id…). Every tool has a title and all
four annotations, so clients can decide which tools to ask about first:
Annotation
true for
readOnlyHint
Reads, dry runs and previews, and tools for a person
destructiveHint
Deletes, updates, merges, pauses and stops, and anything that sends email or data out
idempotentHint
Reads, and DELETE and PUT calls
openWorldHint
Tools that reach people or pages outside your workspace: emails, webhooks, exports, imports from a link
Some tools are for a person and only return a
link.
The server only lists tools your token's permissions allow. A token
limited to some sites isn't offered the workspace-wide tools. Tool calls go
through the same routes, permission checks and validation as the API.
An AI assistant can pick the wrong tool or the wrong id, so the actions
that are hard to undo are left to you. Each has a tool named for the page
it returns (sites_delete_page, "Get the app page to delete a site").
Calling it changes nothing: it responds with the code human_only and a
link to the page of the app where you do it yourself, which the assistant
passes on to you. They are:
Deleting collected data: a site, a date range of its data, a
workspace, a custom event, an import, an export, a survey with its
responses, and disconnecting Search Console, Bing, a payment provider or
Cloudflare (which deletes what they imported).
Billing: checkout, plan changes, canceling and resuming, billing
settings, the badge bonus, discount applications and the Paddle links.
Access and security: API tokens, invitations, members, custom roles,
per-site access, ownership and site transfers, SSO, workspace security
and crawler log keys.
Warehouse destinations: adding, changing, deleting and syncing.
Testimonials: everything that deletes a record, moves it to the
trash or empties the trash. An assistant cannot delete anything or
move anything to the trash. It hands you a link to the page. Bulk
actions on many testimonials at once are not a tool (each action has
its own, and the bulk route stays in the JSON API), and an undo is
refused when taking the
run back would delete or trash something (the undo of a restore, a
translate run or a make images run). See
Trash .
The JSON API still runs every one of them, because a call
there is written on purpose. In the API reference they are
marked HTTP only, and in All tools the summary says so.
Creating an export, revoking a share link, creating or revoking a
wallboard link, and adding, changing, deleting, testing or redelivering a
webhook all run over MCP. Each time an assistant does one of them, the
member whose token it used gets an email that names the action and the
token, with a link to the API tokens page. The same call over the API
sends no email.
No tool takes a password, an API key or a token, because what you type
in a chat stays in its transcript. The actions that take one are in the
app only, never over MCP or the API: creating or changing a share link
(it can have a password), adding or changing a notification channel,
connecting Cloudflare, Search Console or Bing, a subscription provider,
a purchase connection (Stripe or Paddle) and a move from another
testimonials tool. Reading a share link or a site transfer by its token
is in the JSON API only.
Each request to /mcp counts as one request toward the workspace's
API rate limit . Over the limit you get 429 with
the error code rate_limited and a Retry-After header.
Agents usually begin with:
workspaces_list → your workspace id (ws_…).
sites_list with workspace_id → site ids (pa_…).
stats_aggregate, stats_timeseries, stats_breakdown or
stats_overview with site_id, period and filters
(filter syntax ).
docs_search and docs_get to read these docs.
See Examples .
Generated from the running code. The API reference has each
tool's full input and output schema.
Tool
Endpoint
Summary
Permission
api_tokens_create
POST /workspaces/:workspace_id/api_tokens
Create an API token (the token is returned once). For a person: the tool only returns a link to the app
public
api_tokens_delete
DELETE /workspaces/:workspace_id/api_tokens/:id
Revoke an API token. For a person: the tool only returns a link to the app
public
api_tokens_list
GET /workspaces/:workspace_id/api_tokens
List API tokens
public
Tool
Endpoint
Summary
Permission
account_get
GET /account
Get your profile and preferences
public
account_update
PATCH /account
Update your profile and preferences
public
Tool
Endpoint
Summary
Permission
ad_creatives_create
POST /sites/:site_id/experiments/ads/:ad_placement_id/creatives
Add a creative to an ad placement
content.write
ad_creatives_delete
DELETE /sites/:site_id/experiments/ads/:ad_placement_id/creatives/:id
Delete a creative and its image. For a person: the tool only returns a link to the app
content.write
ad_creatives_get
GET /sites/:site_id/experiments/ads/:ad_placement_id/creatives/:id
Get one creative with its state
analytics.read
ad_creatives_update
PATCH /sites/:site_id/experiments/ads/:ad_placement_id/creatives/:id
Change a creative
content.write
Tool
Endpoint
Summary
Permission
ad_placements_create
POST /sites/:site_id/experiments/ads
Create an ad placement
content.write
ad_placements_delete
DELETE /sites/:site_id/experiments/ads/:id
Delete an ad placement with its creatives. For a person: the tool only returns a link to the app
content.write
ad_placements_embed
GET /sites/:site_id/experiments/ads/:id/embed
Get the tag that shows a placement on the site
analytics.read
ad_placements_list
GET /sites/:site_id/experiments/ads
List a site's ad placements with their last 30 days
analytics.read
ad_placements_get
GET /sites/:site_id/experiments/ads/:id
Get a placement with each creative's numbers
analytics.read
ad_placements_update
PATCH /sites/:site_id/experiments/ads/:id
Change an ad placement
content.write
Tool
Endpoint
Summary
Permission
affiliate_commissions_list
GET /account/affiliate/commissions
List your affiliate commissions
public
affiliate_signup_box_get
GET /account/affiliate/signup-box
Get your affiliate signup box code and results
public
affiliate_get
GET /account/affiliate
Get your affiliate status, referral link and stats
public
Tool
Endpoint
Summary
Permission
alerts_acknowledge
POST /alerts/:id/acknowledge
Acknowledge the latest incident
analytics.read
alerts_create
POST /workspaces/:workspace_id/alerts
Create an alert
content.write
alerts_delete
DELETE /alerts/:id
Delete an alert
content.write
alerts_history
GET /alerts/:id/history
Incident history of an alert
analytics.read
alerts_list
GET /workspaces/:workspace_id/alerts
List alerts
analytics.read
alerts_mute
POST /alerts/:id/mute
Mute (or unmute) an alert’s notifications
content.write
alerts_get
GET /alerts/:id
Get an alert
analytics.read
alerts_update
PATCH /alerts/:id
Update an alert
content.write
site_alerts_list
GET /sites/:site_id/alerts
List alerts for a site
analytics.read
Tool
Endpoint
Summary
Permission
clicks_list
GET /sites/:site_id/clicks
Click map: the most clicked elements of the site, or of one page with the share of its visits that clicked each
analytics.read
stats_overview
GET /sites/:site_id/overview
Site overview: metrics, chart series, top panels, live visitors and notes
analytics.read
experiments_report
GET /sites/:site_id/experiments/external
Report for an A/B test run with another tool: conversion rate per variant from an event property, uplift vs control and significance (two-proportion z-test)
analytics.read
insights_get
GET /sites/:site_id/insights
Notable changes vs the previous period, in plain English (biggest movers, goal conversion changes)
analytics.read
journeys_explore
GET /sites/:site_id/journeys
Journeys: top 3-step paths after a page (or any entrance), or before a page or goal
analytics.read
pages_detail
GET /sites/:site_id/pages/detail
Page detail: metrics, previous and next pages, sources, Web Vitals, events and click map for one path
analytics.read
referrers_list
GET /sites/:site_id/referrers
Referrers: the sites that link to this site, with visitors, engagement, kind of traffic and number of linking pages
analytics.read
referrers_detail
GET /sites/:site_id/referrers/detail
Referrer detail: metrics and trend of one referring site, its linking pages, landing pages, countries, devices, campaigns and conversions
analytics.read
stats_aggregate
GET /sites/:site_id/stats/aggregate
Headline metrics for a period (with comparison)
analytics.read
stats_breakdown
GET /sites/:site_id/breakdown/:dimension
Top values of a dimension (pages, sources, countries…)
analytics.read
stats_timeseries
GET /sites/:site_id/stats/timeseries
Metrics per time bucket for charts
analytics.read
Tool
Endpoint
Summary
Permission
assistant_ask
POST /sites/:site_id/ask
Ask a question in a new conversation (counts toward the monthly AI questions limit)
analytics.read
assistant_conversations_delete
DELETE /sites/:site_id/ask/:id
Delete an Ask conversation and its messages
analytics.read
assistant_conversations_list
GET /sites/:site_id/ask
List your Ask conversations for a site
analytics.read
assistant_conversations_get
GET /sites/:site_id/ask/:id
An Ask conversation: questions, answers, the queries behind them and charts
analytics.read
assistant_ask_followup
POST /sites/:site_id/ask/:ask_conversation_id/messages
Ask a follow-up question in a conversation (counts toward the monthly AI questions limit). Returns the answer.
analytics.read
Tool
Endpoint
Summary
Permission
audit_logs_get
GET /workspaces/:workspace_id/audit_log
List audit log entries (add .csv to export)
workspace.manage
Tool
Endpoint
Summary
Permission
billing_badge
POST /workspaces/:workspace_id/billing/badge
Opt in or out of the badge bonus (free plan). For a person: the tool only returns a link to the app
billing.manage
billing_cancel
POST /workspaces/:workspace_id/billing/cancel
Cancel at the end of the billing period. For a person: the tool only returns a link to the app
billing.manage
billing_change_plan
POST /workspaces/:workspace_id/billing/change_plan
Change plan, tier or interval (prorated). For a person: the tool only returns a link to the app
billing.manage
billing_checkout
POST /workspaces/:workspace_id/billing/checkout
Start a Paddle checkout for a paid plan. For a person: the tool only returns a link to the app
billing.manage
billing_discount
POST /workspaces/:workspace_id/billing/discount
Apply for a discount program (nonprofit, education, open source or agency). For a person: the tool only returns a link to the app
billing.manage
billing_payment_method
POST /workspaces/:workspace_id/billing/payment_method
Get a link to update the payment method. For a person: the tool only returns a link to the app
billing.manage
billing_portal
POST /workspaces/:workspace_id/billing/portal
Get a Paddle customer portal link. For a person: the tool only returns a link to the app
billing.manage
billing_preview
GET /workspaces/:workspace_id/billing/preview
Preview a plan change with proration
billing.manage
billing_resume
POST /workspaces/:workspace_id/billing/resume
Undo a scheduled cancellation or resume a pause. For a person: the tool only returns a link to the app
billing.manage
billing_get
GET /workspaces/:workspace_id/billing
Get the plan, subscription and usage
billing.manage
billing_update
PATCH /workspaces/:workspace_id/billing
Update billing emails, tax id and auto-upgrade. For a person: the tool only returns a link to the app
billing.manage
billing_usage
GET /workspaces/:workspace_id/billing/usage
Get this month's usage, forecast and per-site split
billing.manage
billing_invoices_list
GET /workspaces/:workspace_id/billing/invoices
List invoices
billing.manage
billing_invoices_get
GET /workspaces/:workspace_id/billing/invoices/:id
Get the PDF link for an invoice
billing.manage
Tool
Endpoint
Summary
Permission
bot_detection_report
GET /sites/:site_id/bot-detection
Advanced Bot Detection report: hits on the site's honeypot pages, by page and by what gave the bot away
analytics.read
Tool
Endpoint
Summary
Permission
campaign_costs_create
POST /sites/:site_id/campaigns/costs
Set the spend for a campaign in a month
content.write
campaign_costs_delete
DELETE /sites/:site_id/campaigns/costs/:id
Delete a campaign cost entry
content.write
campaign_costs_import
POST /sites/:site_id/campaigns/costs/import
Import campaign costs from CSV (campaign,month,amount[,currency])
content.write
campaign_costs_list
GET /sites/:site_id/campaigns/costs
List campaign cost entries
analytics.read
campaign_costs_update
PATCH /sites/:site_id/campaigns/costs/:id
Change a campaign cost entry
content.write
campaigns_builder
GET /sites/:site_id/campaigns/builder
Build and validate a UTM-tagged URL
analytics.read
campaigns_hygiene
GET /sites/:site_id/campaigns/hygiene
UTM hygiene: near-duplicate values, style issues and unknown sources
analytics.read
campaigns_list
GET /sites/:site_id/campaigns
Campaign rollup with conversions, revenue, cost, CPA and ROAS
analytics.read
links_create
POST /sites/:site_id/campaigns/links
Save a UTM-tagged link to the library
content.write
links_delete
DELETE /sites/:site_id/campaigns/links/:id
Delete a saved link
content.write
links_list
GET /sites/:site_id/campaigns/links
List saved campaign links
analytics.read
links_qr
GET /sites/:site_id/campaigns/links/:id/qr
QR code (SVG) for a saved link
analytics.read
links_get
GET /sites/:site_id/campaigns/links/:id
Get a saved campaign link
analytics.read
links_update
PATCH /sites/:site_id/campaigns/links/:id
Change a saved link
content.write
Tool
Endpoint
Summary
Permission
channel_rules_create
POST /sites/:site_id/channel_rules
Add a channel rule
sites.manage
channel_rules_delete
DELETE /sites/:site_id/channel_rules/:id
Delete a channel rule
sites.manage
channel_rules_list
GET /sites/:site_id/channel_rules
List channel rules in order
analytics.read
channel_rules_move
PATCH /sites/:site_id/channel_rules/:id/move
Move a channel rule up or down
sites.manage
channel_rules_preview
POST /sites/:site_id/channel_rules/preview
Preview the channel for a sample referrer and UTM tags
analytics.read
channel_rules_update
PATCH /sites/:site_id/channel_rules/:id
Change a channel rule
sites.manage
Tool
Endpoint
Summary
Permission
crawlers_cloudflare_disconnect
DELETE /sites/:site_id/crawlers/connection
Disconnect Cloudflare and delete its stored API token and the crawler hits it imported. For a person: the tool only returns a link to the app
sites.manage
crawlers_cloudflare_sync
POST /sites/:site_id/crawlers/sync
Import crawler hits from Cloudflare now
sites.manage
crawlers_report
GET /sites/:site_id/crawlers
AI crawlers report: hits by crawler over time, top paths per crawler, by category
analytics.read
Tool
Endpoint
Summary
Permission
dashboards_card
GET /workspaces/:workspace_id/dashboards/:id/cards/:index
Data for one card of a custom dashboard
analytics.read
dashboards_create
POST /workspaces/:workspace_id/dashboards
Create a custom dashboard
content.write
dashboards_delete
DELETE /workspaces/:workspace_id/dashboards/:id
Delete a custom dashboard
content.write
dashboards_list
GET /workspaces/:workspace_id/dashboards
List custom dashboards
analytics.read
dashboards_get
GET /workspaces/:workspace_id/dashboards/:id
Get a custom dashboard and its cards
analytics.read
dashboards_update
PATCH /workspaces/:workspace_id/dashboards/:id
Rename a custom dashboard or replace its cards
content.write
Tool
Endpoint
Summary
Permission
docs_list
GET /docs
List documentation pages
public
docs_search
GET /docs/search
Search the documentation
public
docs_get
GET /docs/:section/:page
Read a documentation page (Markdown and HTML)
public
Domain Rating#
Tool
Endpoint
Summary
Permission
domain_rating_report
GET /sites/:site_id/domain-rating
Domain Rating report: the latest rating, inbound and outbound links, the change since the release before and the history by month
analytics.read
Tool
Endpoint
Summary
Permission
email_report_recipients_delete
DELETE /recipients/:id
Remove a recipient from an email report
content.write
email_report_recipients_list
GET /reports/:report_id/recipients
List the recipients of an email report with their status
analytics.read
email_report_recipients_resend
POST /recipients/:id/resend
Resend a pending report invite
content.write
email_reports_create
POST /workspaces/:workspace_id/reports
Create an email report
content.write
email_reports_deliveries
GET /reports/:id/deliveries
Delivery log of an email report
analytics.read
email_reports_delete
DELETE /reports/:id
Delete an email report
content.write
email_reports_list
GET /workspaces/:workspace_id/reports
List email reports
analytics.read
email_reports_send_test
POST /reports/:id/send_test
Send an email report now as a test
content.write
email_reports_get
GET /reports/:id
Get an email report
analytics.read
email_reports_update
PATCH /reports/:id
Update an email report
content.write
Tool
Endpoint
Summary
Permission
event_properties_list
GET /sites/:site_id/events/properties
List event property keys seen in the last 30 days
analytics.read
event_properties_update
PATCH /sites/:site_id/events/properties
Rename or hide an event property key
sites.manage
events_delete
DELETE /sites/:site_id/events
Delete an event and its history (runs in the background, confirm by typing the name). For a person: the tool only returns a link to the app
sites.manage
events_list
GET /sites/:site_id/events
List events with completions, visits, conversion rate and first/last seen
analytics.read
events_merge
POST /sites/:site_id/events/merge
Merge several events into one display name
sites.manage
events_get
GET /sites/:site_id/events/detail
One event: chart, property pivot, number property aggregates, pages and sources
analytics.read
events_update
PATCH /sites/:site_id/events/settings
Rename, hide or unhide an event, or set its currency
sites.manage
Tool
Endpoint
Summary
Permission
experiments_create
POST /sites/:site_id/experiments
Create an experiment as a draft
content.write
experiments_delete
DELETE /sites/:site_id/experiments/:id
Delete an experiment with its results. For a person: the tool only returns a link to the app
content.write
experiments_duplicate
POST /sites/:site_id/experiments/:id/duplicate
Copy an experiment as a new draft
content.write
experiments_end
POST /sites/:site_id/experiments/:id/end
End an experiment for good. For a person: the tool only returns a link to the app
content.write
experiments_list
GET /sites/:site_id/experiments
List a site's experiments with their visits and conversions
analytics.read
experiments_pause
POST /sites/:site_id/experiments/:id/pause
Pause an experiment and keep its results
content.write
experiments_get
GET /sites/:site_id/experiments/:id
Get one experiment with its results
analytics.read
experiments_start
POST /sites/:site_id/experiments/:id/start
Start an experiment. For a person: the tool only returns a link to the app
content.write
experiments_update
PATCH /sites/:site_id/experiments/:id
Update an experiment
content.write
Tool
Endpoint
Summary
Permission
exports_create
POST /workspaces/:workspace_id/exports
Queue an export (built in the background). Emails you when an assistant uses it
analytics.export
exports_delete
DELETE /exports/:id
Delete an export and its file. For a person: the tool only returns a link to the app
analytics.export
exports_download
GET /exports/:id/download
Get a signed link to the file (valid 10 minutes)
analytics.export
exports_list
GET /workspaces/:workspace_id/exports
List exports (the job queue)
analytics.export
exports_preview
POST /workspaces/:workspace_id/exports/preview
Preview an export: first 20 rows and the estimated row count
analytics.export
exports_get
GET /exports/:id
Get an export and its status
analytics.export
Tool
Endpoint
Summary
Permission
testimonial_forms_create
POST /sites/:site_id/testimonials/forms
Create a form
content.write
testimonial_forms_delete
DELETE /sites/:site_id/testimonials/forms/:id/permanent
Delete a form for good. For a person: the tool only returns a link to the app
sites.manage
testimonial_forms_trash
DELETE /sites/:site_id/testimonials/forms/:id
Move a form to the trash. For a person: the tool only returns a link to the app
content.write
testimonial_forms_duplicate
POST /sites/:site_id/testimonials/forms/:id/duplicate
Copy a form, optionally into another language
content.write
testimonial_forms_list
GET /sites/:site_id/testimonials/forms
List the forms of a site
analytics.read
testimonial_forms_qr
GET /sites/:site_id/testimonials/forms/:id/qr
Get a form's QR code as SVG or PNG
analytics.read
testimonial_forms_restore
POST /sites/:site_id/testimonials/forms/:id/restore
Restore a form from the trash. Its link works again
content.write
testimonial_forms_share
GET /sites/:site_id/testimonials/forms/:id/share
Get a form's link, QR code links and embed snippets
analytics.read
testimonial_forms_get
GET /sites/:site_id/testimonials/forms/:id
Get one form with every step, question, rule and setting
analytics.read
testimonial_forms_update
PATCH /sites/:site_id/testimonials/forms/:id
Change a form. Only the inputs sent change
content.write
Tool
Endpoint
Summary
Permission
funnels_create
POST /sites/:site_id/funnels
Create a funnel
content.write
funnels_delete
DELETE /sites/:site_id/funnels/:id
Delete a funnel
content.write
funnels_list
GET /sites/:site_id/funnels
List funnels with entries, completions and rate
analytics.read
funnels_get
GET /sites/:site_id/funnels/:id
Funnel report: step counts, conversion, drop-off, time between steps and where visits went instead
analytics.read
funnels_update
PATCH /sites/:site_id/funnels/:id
Update a funnel
content.write
Tool
Endpoint
Summary
Permission
goals_archive
POST /sites/:site_id/goals/:id/archive
Archive a goal (hidden from reports)
content.write
goals_create
POST /sites/:site_id/goals
Create a goal
content.write
goals_delete
DELETE /sites/:site_id/goals/:id
Delete a goal (data is kept)
content.write
goals_duplicate
POST /sites/:site_id/goals/:id/duplicate
Copy a goal
content.write
goals_list
GET /sites/:site_id/goals
List goals with completions, conversions, rate and value for a period
analytics.read
goals_get
GET /sites/:site_id/goals/:id
Goal report: metrics, chart, breakdowns and the journey to converting
analytics.read
goals_unarchive
POST /sites/:site_id/goals/:id/unarchive
Restore an archived goal
content.write
goals_update
PATCH /sites/:site_id/goals/:id
Update a goal
content.write
Tool
Endpoint
Summary
Permission
support_message_send
POST /help
Send a question or feedback to the Privatus Analytics team
public
Tool
Endpoint
Summary
Permission
imports_google_disconnect
DELETE /sites/:site_id/imports/google/connection
Disconnect your Google Analytics account and delete its stored access tokens
sites.manage
imports_google_properties
GET /sites/:site_id/imports/google/properties
List Google Analytics 4 properties to import
sites.manage
imports_create
POST /sites/:site_id/imports
Start an import (GA4 property or CSV upload)
sites.manage
imports_delete
DELETE /sites/:site_id/imports/:id
Delete an import and all its imported data. For a person: the tool only returns a link to the app
sites.manage
imports_list
GET /sites/:site_id/imports
List imports for a site
analytics.read
imports_get
GET /sites/:site_id/imports/:id
Get an import and its status
analytics.read
Tool
Endpoint
Summary
Permission
live_get
GET /sites/:site_id/live
Live visitors, activity stream and what is popular right now (last 30 minutes)
analytics.read
live_wallboard
GET /sites/:site_id/live/wallboard
Wallboard cards (live and today) for one or more sites
analytics.read
wallboard_links_create
POST /sites/:site_id/live/wallboard/links
Create a wallboard link (read-only, revocable). Emails you when an assistant uses it
sites.manage
wallboard_links_delete
DELETE /sites/:site_id/live/wallboard/links/:id
Revoke a wallboard link. Emails you when an assistant uses it
sites.manage
wallboard_links_list
GET /sites/:site_id/live/wallboard/links
List wallboard links for a site
sites.manage
Tool
Endpoint
Summary
Permission
invitations_create
POST /workspaces/:workspace_id/invitations
Invite people by email. For a person: the tool only returns a link to the app
members.manage
invitations_delete
DELETE /workspaces/:workspace_id/invitations/:id
Revoke a pending invitation. For a person: the tool only returns a link to the app
members.manage
invitations_list
GET /workspaces/:workspace_id/invitations
List pending invitations
members.manage
members_delete
DELETE /workspaces/:workspace_id/members/:id
Remove a member (or leave the workspace). For a person: the tool only returns a link to the app
public
members_list
GET /workspaces/:workspace_id/members
List workspace members
public
members_update
PATCH /workspaces/:workspace_id/members/:id
Change a member's role or site access. For a person: the tool only returns a link to the app
members.manage
ownership_transfers_create
POST /workspaces/:workspace_id/ownership_transfer
Transfer workspace ownership to another member (owner only, you become an admin). For a person: the tool only returns a link to the app
public
Tool
Endpoint
Summary
Permission
notes_create
POST /sites/:site_id/notes
Add a note to a site (use source "deploy" for release webhooks)
content.write
notes_delete
DELETE /sites/:site_id/notes/:id
Delete a note
content.write
notes_list
GET /sites/:site_id/notes
List notes for a site (including workspace-wide notes)
analytics.read
notes_get
GET /sites/:site_id/notes/:id
Get a note
analytics.read
notes_update
PATCH /sites/:site_id/notes/:id
Edit a note
content.write
workspace_notes_create
POST /workspaces/:workspace_id/notes
Add a workspace-wide note (shown on every site)
content.write
workspace_notes_delete
DELETE /workspaces/:workspace_id/notes/:id
Delete a workspace note
content.write
workspace_notes_list
GET /workspaces/:workspace_id/notes
List notes across a workspace
analytics.read
workspace_notes_update
PATCH /workspaces/:workspace_id/notes/:id
Edit a workspace note
content.write
Tool
Endpoint
Summary
Permission
notification_channels_delete
DELETE /channels/:id
Delete a notification channel
content.write
notification_channels_list
GET /workspaces/:workspace_id/channels
List notification channels
analytics.read
notification_channels_send_test
POST /channels/:id/send_test
Send a test message through a channel
content.write
notification_channels_get
GET /channels/:id
Get a notification channel
analytics.read
push_subscriptions_create
POST /push_subscription
Register a browser for push notifications
public
push_subscriptions_delete
DELETE /push_subscription
Remove a browser push registration
public
Tool
Endpoint
Summary
Permission
performance_report
GET /sites/:site_id/performance
Web Vitals: p75 scorecard, daily trend and breakdowns by page, device, browser and country
analytics.read
Tool
Endpoint
Summary
Permission
plans_list
GET /plans
List plans, prices and limits
public
Tool
Endpoint
Summary
Permission
testimonial_feedback_list
GET /sites/:site_id/testimonials/forms/:form_id/feedback
List the private feedback of a form, newest first
analytics.read
testimonial_feedback_mark_read
POST /sites/:site_id/testimonials/forms/:form_id/feedback/:id/mark_read
Mark a private feedback answer as read, or as unread again
analytics.read
testimonial_feedback_get
GET /sites/:site_id/testimonials/forms/:form_id/feedback/:id
Get one private feedback answer
analytics.read
Tool
Endpoint
Summary
Permission
testimonial_removal_requests_dismiss
POST /sites/:site_id/testimonials/removal_requests/:id/dismiss
Dismiss a removal request
content.write
testimonial_removal_requests_list
GET /sites/:site_id/testimonials/removal_requests
List the removal requests of a site
analytics.read
testimonial_removal_requests_resolve
POST /sites/:site_id/testimonials/removal_requests/:id/resolve
Decide a removal request. For a person: the tool only returns a link to the app
content.write
testimonial_removal_requests_get
GET /sites/:site_id/testimonials/removal_requests/:id
Get one removal request
analytics.read
Tool
Endpoint
Summary
Permission
testimonial_rewards_copy
POST /sites/:site_id/testimonials/settings/rewards/:id/copy
Copy a form's reward to other forms of the same site
sites.manage
testimonial_rewards_list
GET /sites/:site_id/testimonials/settings/rewards
List the reward of every form of a site
analytics.read
testimonial_rewards_update
PATCH /sites/:site_id/testimonials/settings/rewards/:id
Set the reward a form shows on its thank-you step
sites.manage
Tool
Endpoint
Summary
Permission
roles_create
POST /workspaces/:workspace_id/roles
Create a custom role. For a person: the tool only returns a link to the app
members.manage
roles_delete
DELETE /workspaces/:workspace_id/roles/:id
Delete a custom role (must be unused). For a person: the tool only returns a link to the app
members.manage
roles_list
GET /workspaces/:workspace_id/roles
List custom roles
public
roles_update
PATCH /workspaces/:workspace_id/roles/:id
Update a custom role. For a person: the tool only returns a link to the app
members.manage
Tool
Endpoint
Summary
Permission
sso_activate
POST /workspaces/:workspace_id/sso/activate
Activate a tested SSO configuration. For a person: the tool only returns a link to the app
workspace.manage
sso_deactivate
POST /workspaces/:workspace_id/sso/deactivate
Turn SSO off (back to draft). For a person: the tool only returns a link to the app
workspace.manage
sso_get
GET /workspaces/:workspace_id/sso
Get SSO settings
workspace.manage
sso_update
PATCH /workspaces/:workspace_id/sso
Create or update SSO settings. For a person: the tool only returns a link to the app
workspace.manage
Tool
Endpoint
Summary
Permission
search_report
GET /sites/:site_id/search
Search report: clicks, impressions, CTR, position, top queries/pages, landing pages and opportunities
analytics.read
search_disconnect
DELETE /sites/:site_id/search/connections/:provider
Disconnect Search Console or Bing and delete its data. For a person: the tool only returns a link to the app
sites.manage
search_sync
POST /sites/:site_id/search/sync
Import search data now
sites.manage
Tool
Endpoint
Summary
Permission
segments_create
POST /sites/:site_id/segments
Save filters as a segment
content.write
segments_delete
DELETE /sites/:site_id/segments/:id
Delete a segment
content.write
segments_list
GET /sites/:site_id/segments
List segments you can use on a site
analytics.read
segments_preview
POST /sites/:site_id/segments/preview
Describe filters in plain English and count the visitors they matched in the last 30 days
analytics.read
segments_get
GET /sites/:site_id/segments/:id
Get a segment
analytics.read
segments_update
PATCH /sites/:site_id/segments/:id
Rename a segment or change its filters or sharing
content.write
Tool
Endpoint
Summary
Permission
shared_links_delete
DELETE /sites/:site_id/shared_links/:id
Revoke a share link. Emails you when an assistant uses it
sites.manage
shared_links_list
GET /sites/:site_id/shared_links
List share links
sites.manage
Tool
Endpoint
Summary
Permission
site_audit_issues_list
GET /sites/:site_id/audit/issues
List the issues of a site audit, one row per check
analytics.read
site_audit_issues_get
GET /sites/:site_id/audit/issues/:check_key
Get one site audit check: why it matters, how to fix it and the affected URLs
analytics.read
site_audit_mutes_bulk
POST /sites/:site_id/audit/mutes/bulk
Mute a site audit check on several URLs, or several whole checks, in one call
content.write
site_audit_mutes_create
POST /sites/:site_id/audit/mutes
Mute a site audit check, for the whole site or one URL
content.write
site_audit_mutes_delete
DELETE /sites/:site_id/audit/mutes/:id
Unmute a site audit check
content.write
site_audit_mutes_list
GET /sites/:site_id/audit/mutes
List the checks a site has muted
analytics.read
site_audit_notifications_update
PATCH /sites/:site_id/audit/notifications
Turn your audit summary email for a site on or off
analytics.read
site_audit_pages_list
GET /sites/:site_id/audit/pages
List and filter the pages of a site audit
analytics.read
site_audit_pages_get
GET /sites/:site_id/audit/pages/:id
Get one audited page: its metadata, issues, links in and links out
analytics.read
site_audit_settings_get
GET /sites/:site_id/audit/settings
Get a site's audit settings
sites.manage
site_audit_settings_update
PATCH /sites/:site_id/audit/settings
Change a site's audit settings
sites.manage
site_audit_cancel
POST /sites/:site_id/audit/cancel
Cancel the site audit that is running
content.write
site_audit_compare
GET /sites/:site_id/audit/compare
Compare two site audits: URLs added and fixed per check
analytics.read
site_audit_run
POST /sites/:site_id/audit
Start a site audit now
content.write
site_audit_history
GET /sites/:site_id/audit/history
List a site's audits, newest first
analytics.read
site_audit_get
GET /sites/:site_id/audit
Get the site audit overview: score, counts, top issues by traffic and the audit running now
analytics.read
Tool
Endpoint
Summary
Permission
sites_reset_data
POST /sites/:site_id/data_reset
Delete all events and visits in a date range (runs in the background, cannot be undone). For a person: the tool only returns a link to the app
sites.manage
sites_filter_stats
GET /sites/:site_id/filter_stats
Filtered traffic summary: bots, traffic rules or PII redactions by reason and country (counts only)
analytics.read
sites_access_list
GET /sites/:site_id/access
List members and whether they can see this site
members.manage
sites_access_update
PATCH /sites/:site_id/access
Grant or remove one member's access to this site. For a person: the tool only returns a link to the app
members.manage
sites_favorite
POST /sites/:site_id/favorite
Star a site (pinned first on All sites)
analytics.read
sites_unfavorite
DELETE /sites/:site_id/favorite
Unstar a site
analytics.read
sites_setup_get
GET /sites/:site_id/setup
Installation status and snippet for a site
analytics.read
sites_transfer_start
POST /sites/:site_id/transfer
Start transferring a site to another workspace (emails the recipient). For a person: the tool only returns a link to the app
sites.manage
sites_transfer_cancel
DELETE /sites/:site_id/transfer
Cancel a pending site transfer. For a person: the tool only returns a link to the app
sites.manage
sites_create
POST /workspaces/:workspace_id/sites
Add a site
sites.manage
sites_delete
DELETE /sites/:id
Delete a site (purged after 7 days). For a person: the tool only returns a link to the app
sites.manage
sites_list
GET /workspaces/:workspace_id/sites
List sites in a workspace
analytics.read
sites_get
GET /sites/:id
Get a site and all its settings
analytics.read
sites_update
PATCH /sites/:id
Update site settings
sites.manage
Tool
Endpoint
Summary
Permission
ad_report_links_create
POST /sites/:site_id/experiments/ads/:ad_placement_id/reports
Create a sponsor report link for a placement. Emails you when an assistant uses it
content.write
ad_report_links_delete
DELETE /sites/:site_id/experiments/ads/:ad_placement_id/reports/:id
Delete a sponsor report link. For a person: the tool only returns a link to the app
content.write
ad_report_links_list
GET /sites/:site_id/experiments/ads/:ad_placement_id/reports
List a placement's sponsor report links
analytics.read
Status pages#
Tool
Endpoint
Summary
Permission
status_page_posts_create
POST /status_pages/:status_page_id/posts
Post an incident update (emails subscribers)
uptime.manage
status_page_posts_delete
DELETE /status_pages/:status_page_id/posts/:id
Delete a status page post
uptime.manage
status_page_posts_list
GET /status_pages/:status_page_id/posts
List posts on a status page
analytics.read
status_page_posts_update
PATCH /status_pages/:status_page_id/posts/:id
Edit a status page post
uptime.manage
status_page_subscribers_delete
DELETE /status_pages/:status_page_id/subscribers/:id
Remove a subscriber
uptime.manage
status_page_subscribers_list
GET /status_pages/:status_page_id/subscribers
List subscribers of a status page
uptime.manage
status_pages_create
POST /workspaces/:workspace_id/status_pages
Create a status page
uptime.manage
status_pages_delete
DELETE /status_pages/:id
Delete a status page
uptime.manage
status_pages_list
GET /workspaces/:workspace_id/status_pages
List status pages
analytics.read
status_pages_get
GET /status_pages/:id
Get a status page
analytics.read
status_pages_update
PATCH /status_pages/:id
Change a status page
uptime.manage
Tool
Endpoint
Summary
Permission
subscriptions_disconnect
DELETE /sites/:site_id/subscriptions/connections/:provider
Disconnect a payment provider and delete its key and subscription data. For a person: the tool only returns a link to the app
sites.manage
subscriptions_sync
POST /sites/:site_id/subscriptions/sync
Read subscriptions from a payment provider now
sites.manage
subscriptions_cohorts
GET /sites/:site_id/subscriptions/cohorts
Churn cohort grid: churn or retention by month of first payment
analytics.read
subscriptions_report
GET /sites/:site_id/subscriptions
Subscription metrics: MRR, ARR, MRR movements, churn, revenue retention, trials, plans and a forecast
analytics.read
Tool
Endpoint
Summary
Permission
surveys_create
POST /sites/:site_id/surveys
Create a survey
content.write
surveys_delete
DELETE /sites/:site_id/surveys/:id
Delete a survey with its responses. For a person: the tool only returns a link to the app
content.write
surveys_list
GET /sites/:site_id/surveys
List a site's surveys with their response counts
analytics.read
surveys_pause
POST /sites/:site_id/surveys/:id/pause
Stop collecting answers and keep the ones already given
content.write
surveys_get
GET /sites/:site_id/surveys/:id
Survey results for a period, broken down per question
analytics.read
surveys_start
POST /sites/:site_id/surveys/:id/start
Start collecting answers
content.write
surveys_themes
POST /sites/:site_id/surveys/:id/themes
Group the free-text answers to one question into themes (Business plan)
analytics.read
surveys_update
PATCH /sites/:site_id/surveys/:id
Update a survey
content.write
Tool
Endpoint
Summary
Permission
testimonial_stats_breakdown
GET /sites/:site_id/testimonials/analytics/breakdown
Split one testimonial metric by form, request, widget, wall, testimonial, channel, page, country or source
analytics.read
testimonial_stats_export
POST /sites/:site_id/testimonials/analytics/export
Queue a file of one section of the testimonial analytics. Emails you when an assistant uses it
analytics.export
testimonial_stats_overview
GET /sites/:site_id/testimonials/analytics
Read the testimonial analytics of a site in one call
analytics.read
testimonial_stats_timeseries
GET /sites/:site_id/testimonials/analytics/timeseries
Read one testimonial metric per day, week or month
analytics.read
Tool
Endpoint
Summary
Permission
testimonial_brand_kit_reset
DELETE /sites/:site_id/testimonials/settings/brand_kit
Return the brand kit of a site's testimonials to the Privatus Analytics defaults. For a person: the tool only returns a link to the app
sites.manage
testimonial_brand_kit_get
GET /sites/:site_id/testimonials/settings/brand_kit
Get the brand kit of a site's testimonials, with every color resolved for light and dark
analytics.read
testimonial_brand_kit_update
PATCH /sites/:site_id/testimonials/settings/brand_kit
Change the brand kit of a site's testimonials
sites.manage
Tool
Endpoint
Summary
Permission
testimonial_collections_add_items
POST /sites/:site_id/testimonials/collections/:id/items
Add testimonials to a manual collection
content.write
testimonial_collections_create
POST /sites/:site_id/testimonials/collections
Create a collection, manual or smart
content.write
testimonial_collections_destroy
DELETE /sites/:site_id/testimonials/collections/:id
Move a collection to the trash for 30 days. For a person: the tool only returns a link to the app
content.write
testimonial_collections_list
GET /sites/:site_id/testimonials/collections
List the collections of a site
analytics.read
testimonial_collections_preview
GET /sites/:site_id/testimonials/collections/preview
Try a set of rules without saving anything
analytics.read
testimonial_collections_remove_items
DELETE /sites/:site_id/testimonials/collections/:id/items
Take testimonials out of a manual collection
content.write
testimonial_collections_reorder
POST /sites/:site_id/testimonials/collections/:id/reorder
Move one testimonial to another place in a manual collection
content.write
testimonial_collections_get
GET /sites/:site_id/testimonials/collections/:id
Get one collection with its counts, its rules and what it feeds
analytics.read
testimonial_collections_update
PATCH /sites/:site_id/testimonials/collections/:id
Change a collection's name, description, rules or served order
content.write
Tool
Endpoint
Summary
Permission
testimonial_companies_list
GET /sites/:site_id/testimonials/companies
List the companies of a site with their people, testimonials and average rating
analytics.read
testimonial_companies_merge
POST /sites/:site_id/testimonials/companies/:id/merge
Merge a company into another one, for two spellings of one company
content.write
testimonial_companies_get
GET /sites/:site_id/testimonials/companies/:id
Get one company with its people
analytics.read
testimonial_companies_update
PATCH /sites/:site_id/testimonials/companies/:id
Correct a company's name and URL for all of its people at once
content.write
Testimonial custom domain requests#
Tool
Endpoint
Summary
Permission
testimonial_custom_domain_requests_create
POST /sites/:site_id/testimonials/settings/custom_domain
Ask for a custom domain on a wall or on forms
sites.manage
testimonial_custom_domain_requests_delete
DELETE /sites/:site_id/testimonials/settings/custom_domain
Withdraw a custom domain request, by its hostname. For a person: the tool only returns a link to the app
sites.manage
testimonial_custom_domain_requests_list
GET /sites/:site_id/testimonials/settings/custom_domain
List the custom domain requests of a site
analytics.read
Tool
Endpoint
Summary
Permission
testimonial_properties_create
POST /sites/:site_id/testimonials/settings/properties
Add a custom property to a site
sites.manage
testimonial_properties_destroy
DELETE /sites/:site_id/testimonials/settings/properties/:id
Delete a custom property and its values for good. For a person: the tool only returns a link to the app
sites.manage
testimonial_properties_list
GET /sites/:site_id/testimonials/settings/properties
List the custom properties of a site, in display order
analytics.read
testimonial_properties_update
PATCH /sites/:site_id/testimonials/settings/properties/:id
Change, reorder, archive or bring back a custom property
sites.manage
Tool
Endpoint
Summary
Permission
testimonial_duplicates_dismiss
POST /sites/:site_id/testimonials/duplicates/dismiss
Say that a group is not duplicates. It never returns to the queue
content.write
testimonial_duplicates_list
GET /sites/:site_id/testimonials/duplicates
List the groups of testimonials that are probably the same one twice
analytics.read
testimonials_merge
POST /sites/:site_id/testimonials/:id/merge
Merge copies of a testimonial into the one in the path
content.write
testimonial_duplicates_merge_exact
POST /sites/:site_id/testimonials/duplicates/merge_exact
Merge every exact match of the queue at once
content.write
Tool
Endpoint
Summary
Permission
testimonial_images_bulk_create
POST /sites/:site_id/testimonials/images/bulk
Make images for every approved testimonial of a collection
content.write
testimonial_images_create
POST /sites/:site_id/testimonials/images
Make images of one approved testimonial, one per size
content.write
testimonial_images_delete
DELETE /sites/:site_id/testimonials/images/:id
Delete an image and its file. For a person: the tool only returns a link to the app
content.write
testimonial_images_list
GET /sites/:site_id/testimonials/images
List the images of a site
analytics.read
testimonial_images_get
GET /sites/:site_id/testimonials/images/:id
Get one image, with its state and the address of its PNG
analytics.read
testimonial_images_update
PATCH /sites/:site_id/testimonials/images/:id
Change how an image is drawn and render it again
content.write
Tool
Endpoint
Summary
Permission
testimonial_import_runs_list
GET /sites/:site_id/testimonials/imports/sources/:import_source_id/runs
List the runs of a source, newest first
analytics.read
Tool
Endpoint
Summary
Permission
testimonial_import_sources_create
POST /sites/:site_id/testimonials/imports/sources
Add an import source from a link and start its first run
content.write
testimonial_import_sources_delete
DELETE /sites/:site_id/testimonials/imports/sources/:id
Delete a source. The testimonials it brought in stay. For a person: the tool only returns a link to the app
content.write
testimonial_import_sources_discard
POST /sites/:site_id/testimonials/imports/sources/:id/discard
Discard found items
content.write
testimonial_import_sources_find
POST /sites/:site_id/testimonials/imports/find
Find testimonials on the site's own website
content.write
testimonial_import_sources_list
GET /sites/:site_id/testimonials/imports
List the import sources of a site
analytics.read
testimonial_import_sources_keep
POST /sites/:site_id/testimonials/imports/sources/:id/keep
Keep found items as testimonials
content.write
testimonial_import_platforms_list
GET /sites/:site_id/testimonials/imports/platforms
List the platforms an import can read
analytics.read
testimonial_import_sources_review
GET /sites/:site_id/testimonials/imports/sources/:id/review
List what a source found and has not been decided yet
analytics.read
testimonial_import_sources_run
POST /sites/:site_id/testimonials/imports/sources/:id/run
Read a source again now
content.write
testimonial_import_sources_get
GET /sites/:site_id/testimonials/imports/sources/:id
Get one import source with its state and counts
analytics.read
testimonial_import_sources_update
PATCH /sites/:site_id/testimonials/imports/sources/:id
Change a source's link, name, sync, auto-approve, or pause it
content.write
Tool
Endpoint
Summary
Permission
testimonial_languages_get
GET /sites/:site_id/testimonials/settings/languages
Get the language settings of a site's testimonials
analytics.read
testimonial_languages_update
PATCH /sites/:site_id/testimonials/settings/languages
Set the default language, the offered languages and automatic translation. Emails you when an assistant uses it
sites.manage
Tool
Endpoint
Summary
Permission
testimonial_media_uploads_create
POST /sites/:site_id/testimonials/media/uploads
Start an upload, or add a file from a web address
content.write
testimonial_media_delete
DELETE /sites/:site_id/testimonials/media/:id
Delete a file that no testimonial keeps. For a person: the tool only returns a link to the app
content.write
testimonial_media_uploads_finish
POST /sites/:site_id/testimonials/media/uploads/:id/finish
Say an upload is complete, so the file is checked and processed
content.write
testimonial_media_retry
POST /sites/:site_id/testimonials/media/:id/retry
Try a failed file again
content.write
testimonial_media_get
GET /sites/:site_id/testimonials/media/:id
Get one file with its state and where to load it
analytics.read
Tool
Endpoint
Summary
Permission
testimonial_mentions_list
GET /sites/:site_id/testimonials/mentions
List the words and phrases that recur across a site's testimonials
analytics.read
testimonial_mentions_tag
POST /sites/:site_id/testimonials/mentions/tag
Tag every testimonial that mentions a word or phrase
content.write
testimonial_mentions_update
PATCH /sites/:site_id/testimonials/mentions
Hide a term that is only noise, or show it again
content.write
Tool
Endpoint
Summary
Permission
testimonial_migrations_discard
POST /sites/:site_id/testimonials/imports/migrations/:id/discard
Discard what a migration read
content.write
testimonial_migrations_list
GET /sites/:site_id/testimonials/imports/migrations
List the migrations of a site
analytics.read
testimonial_migrations_keep
POST /sites/:site_id/testimonials/imports/migrations/:id/keep
Keep what a migration read as testimonials
content.write
testimonial_migrations_review
GET /sites/:site_id/testimonials/imports/migrations/:id/review
List what a migration read and has not been decided yet
analytics.read
testimonial_migrations_get
GET /sites/:site_id/testimonials/imports/migrations/:id
Get a migration's progress and counts
analytics.read
Tool
Endpoint
Summary
Permission
testimonial_people_ask_again
POST /sites/:site_id/testimonials/people/:id/ask_again
Start a request with this person as its only recipient
content.write
testimonial_people_create
POST /sites/:site_id/testimonials/people
Add a person to a site
content.write
testimonial_people_delete_permanently
DELETE /sites/:site_id/testimonials/people/:id/permanent
Delete a person for good, with everything they said, the files and the ask history. For a person: the tool only returns a link to the app
sites.manage
testimonial_people_list
GET /sites/:site_id/testimonials/people
List the people of a site, filtered and sorted
analytics.read
testimonial_people_merge
POST /sites/:site_id/testimonials/people/:id/merge
Merge other records of the same person into this one
content.write
testimonial_people_get
GET /sites/:site_id/testimonials/people/:id
Get one person with what was asked of them and the people who look like the same person
analytics.read
testimonial_people_update
PATCH /sites/:site_id/testimonials/people/:id
Edit a person. Only the fields sent change
content.write
Tool
Endpoint
Summary
Permission
testimonial_purchase_connections_delete
DELETE /sites/:site_id/testimonials/settings/purchase_connections/:id
Disconnect a payment account. For a person: the tool only returns a link to the app
sites.manage
testimonial_purchase_connections_list
GET /sites/:site_id/testimonials/settings/purchase_connections
List the purchase connections of a site
sites.manage
Tool
Endpoint
Summary
Permission
testimonial_request_recipients_create
POST /sites/:site_id/testimonials/requests/:request_id/recipients
Add people to a request. Emails you when an assistant uses it
content.write
testimonial_request_recipients_delete
DELETE /sites/:site_id/testimonials/requests/:request_id/recipients
Remove chosen people from a request. For a person: the tool only returns a link to the app
content.write
testimonial_request_recipients_import
POST /sites/:site_id/testimonials/requests/:request_id/recipients/import
Add people to a request from a CSV file. Emails you when an assistant uses it
content.write
testimonial_request_recipients_list
GET /sites/:site_id/testimonials/requests/:request_id/recipients
List the people of a request
analytics.read
testimonial_request_recipients_resume
POST /sites/:site_id/testimonials/requests/:request_id/recipients/resume
Resume chosen people of a request. Emails you when an assistant uses it
content.write
testimonial_request_recipients_stop
POST /sites/:site_id/testimonials/requests/:request_id/recipients/stop
Stop chosen people of a request
content.write
Tool
Endpoint
Summary
Permission
testimonial_requests_create
POST /sites/:site_id/testimonials/requests
Start a request as a draft
content.write
testimonial_requests_delete
DELETE /sites/:site_id/testimonials/requests/:id
Delete a draft. For a person: the tool only returns a link to the app
content.write
testimonial_requests_duplicate
POST /sites/:site_id/testimonials/requests/:id/duplicate
Copy a request into a new draft
content.write
testimonial_requests_list
GET /sites/:site_id/testimonials/requests
List the requests of a site
analytics.read
testimonial_requests_preview
GET /sites/:site_id/testimonials/requests/:id/preview
See one email of a request as its first recipient gets it
analytics.read
testimonial_requests_resume
POST /sites/:site_id/testimonials/requests/:id/resume
Resume a stopped request. Emails you when an assistant uses it
content.write
testimonial_requests_send
POST /sites/:site_id/testimonials/requests/:id/send
Send a request, now or at a time. Emails you when an assistant uses it
content.write
testimonial_requests_send_test
POST /sites/:site_id/testimonials/requests/:id/send_test
Send one email of a request to your own address
content.write
testimonial_requests_get
GET /sites/:site_id/testimonials/requests/:id
Get one request with its email, follow-ups and funnel counts
analytics.read
testimonial_requests_stop
POST /sites/:site_id/testimonials/requests/:id/stop
Stop a request
content.write
testimonial_requests_update
PATCH /sites/:site_id/testimonials/requests/:id
Change a request's name, form or email
content.write
Tool
Endpoint
Summary
Permission
testimonial_saved_views_create
POST /sites/:site_id/testimonials/views
Save a filter, search text, sort and layout of the inbox under a name
analytics.read
testimonial_saved_views_destroy
DELETE /sites/:site_id/testimonials/views/:id
Delete a saved view. No testimonial is touched. For a person: the tool only returns a link to the app
analytics.read
testimonial_saved_views_list
GET /sites/:site_id/testimonials/views
List the saved views of a site that the caller can open
analytics.read
testimonial_saved_views_update
PATCH /sites/:site_id/testimonials/views/:id
Rename a saved view, change what it stores, pin it or share it
analytics.read
Tool
Endpoint
Summary
Permission
testimonial_spreadsheet_imports_create
POST /sites/:site_id/testimonials/imports/spreadsheet
Upload a spreadsheet (or send CSV text) and read its columns
content.write
testimonial_spreadsheet_imports_run
POST /sites/:site_id/testimonials/imports/spreadsheet/:id/run
Read the matched file into the review step
content.write
testimonial_spreadsheet_imports_get
GET /sites/:site_id/testimonials/imports/spreadsheet/:id
Get a spreadsheet's columns, samples, matching, options and counts
analytics.read
testimonial_spreadsheet_imports_update
PATCH /sites/:site_id/testimonials/imports/spreadsheet/:id
Save which column goes where, and the options for the file
content.write
Tool
Endpoint
Summary
Permission
testimonial_tags_apply_rules
POST /sites/:site_id/testimonials/tags/:id/apply_rules
Run a tag's rules over the testimonials already stored
content.write
testimonial_tags_create
POST /sites/:site_id/testimonials/tags
Create a tag, with auto-tag rules if you send them
content.write
testimonial_tags_destroy
DELETE /sites/:site_id/testimonials/tags/:id
Move a tag to the trash for 30 days. For a person: the tool only returns a link to the app
content.write
testimonial_tags_list
GET /sites/:site_id/testimonials/tags
List the tags of a site with their rules
analytics.read
testimonial_tags_merge
POST /sites/:site_id/testimonials/tags/:id/merge
Merge a tag into another one
content.write
testimonial_tags_update
PATCH /sites/:site_id/testimonials/tags/:id
Change a tag's name, color or rules
content.write
Tool
Endpoint
Summary
Permission
testimonial_translations_create
POST /sites/:site_id/testimonials/translations
Translate testimonials into the languages a site offers. Emails you when an assistant uses it
content.write
testimonial_translations_delete
DELETE /sites/:site_id/testimonials/translations/:testimonial_id/:language
Remove one stored translation. For a person: the tool only returns a link to the app
content.write
testimonial_translations_estimate
GET /sites/:site_id/testimonials/translations/estimate
Count the characters a translation run would send, before running it
analytics.read
testimonial_translations_list
GET /sites/:site_id/testimonials/translations
List the stored translations of a site
analytics.read
testimonial_translations_update
PATCH /sites/:site_id/testimonials/translations/:testimonial_id/:language
Write or correct one translation by hand
content.write
Tool
Endpoint
Summary
Permission
testimonial_trash_delete_permanently
DELETE /sites/:site_id/testimonials/trash/permanent
Delete up to 100 items in the trash for good. For a person: the tool only returns a link to the app
sites.manage
testimonial_trash_empty
DELETE /sites/:site_id/testimonials/trash/empty
Delete everything in the trash for good. For a person: the tool only returns a link to the app
sites.manage
testimonial_trash_list
GET /sites/:site_id/testimonials/trash
List what is in the trash, one kind at a time
analytics.read
testimonial_trash_restore
POST /sites/:site_id/testimonials/trash/restore
Restore up to 100 items from the trash, exactly as they were
content.write
Tool
Endpoint
Summary
Permission
testimonial_undo_records_list
GET /sites/:site_id/testimonials/settings/undo
List what was changed in the last 7 days and can be undone
analytics.read
testimonial_undo_records_get
GET /sites/:site_id/testimonials/settings/undo/:id
Read one undo record
analytics.read
testimonial_undo_records_undo
POST /sites/:site_id/testimonials/settings/undo/:id/undo
Undo a bulk action or a single change within 7 days
content.write
Tool
Endpoint
Summary
Permission
testimonials_overview
GET /sites/:site_id/testimonials/overview
Read the numbers of a site, what needs attention and what happened lately
analytics.read
testimonials_setup_get
GET /sites/:site_id/testimonials/setup
Get the setup checklist of a site
analytics.read
testimonials_setup_update
PATCH /sites/:site_id/testimonials/setup
Dismiss one item of the setup checklist, or the whole card
content.write
testimonials_approve
POST /sites/:site_id/testimonials/:id/approve
Approve a testimonial so it may be shown
content.write
testimonials_bulk_undo
POST /sites/:site_id/testimonials/bulk/:id/undo
Undo a bulk action within 7 days
content.write
testimonials_create
POST /sites/:site_id/testimonials
Add a testimonial by hand or through the API
content.write
testimonials_delete
DELETE /sites/:site_id/testimonials/:id/permanent
Delete a testimonial permanently, with its history, consent record and files. For a person: the tool only returns a link to the app
sites.manage
testimonials_trash
DELETE /sites/:site_id/testimonials/:id
Move a testimonial to the trash for 30 days. For a person: the tool only returns a link to the app
content.write
testimonials_facets
GET /sites/:site_id/testimonials/facets
Count the testimonials behind every filter value, for the same inputs as the list
analytics.read
testimonials_highlight
PATCH /sites/:site_id/testimonials/:id/highlight
Mark the best sentence of a testimonial, or clear it
content.write
testimonials_history
GET /sites/:site_id/testimonials/:id/history
List every version of a testimonial's words, title, rating and highlight
analytics.read
testimonials_list
GET /sites/:site_id/testimonials
List the testimonials of a site, filtered and sorted
analytics.read
testimonials_pend
POST /sites/:site_id/testimonials/:id/pend
Put a testimonial back to pending
content.write
testimonials_pin
POST /sites/:site_id/testimonials/:id/pin
Pin a testimonial so it is shown first, or unpin it
content.write
testimonials_reject
POST /sites/:site_id/testimonials/:id/reject
Reject a testimonial. It is kept and shown nowhere
content.write
testimonials_restore
POST /sites/:site_id/testimonials/:id/restore
Restore a testimonial from the trash, exactly as it was
content.write
testimonials_restore_version
POST /sites/:site_id/testimonials/:id/restore_version
Put back the words, title, rating and highlight of an earlier version
content.write
testimonials_get
GET /sites/:site_id/testimonials/:id
Get one testimonial with its person, files, consent record, tags and where it is used
analytics.read
testimonials_showable
GET /sites/:site_id/testimonials/showable
List the testimonials the public may see, as the public may see them
analytics.read
testimonials_triage
GET /sites/:site_id/testimonials/triage
Get the next testimonial of a triage queue
analytics.read
testimonials_update
PATCH /sites/:site_id/testimonials/:id
Edit a testimonial. Changes to the words, title, rating and highlight are kept in its history
content.write
Tool
Endpoint
Summary
Permission
tracking_ingest_key_rotate
POST /sites/:site_id/tracking/ingest_key
Create or rotate the crawler log key (shown once). For a person: the tool only returns a link to the app
sites.manage
tracking_ingest_key_revoke
DELETE /sites/:site_id/tracking/ingest_key
Revoke the crawler log key. For a person: the tool only returns a link to the app
sites.manage
tracking_verify
POST /sites/:site_id/tracking/verify
Check the tracker is installed on the site (script tag, site id, CSP and referrer policy)
sites.manage
tracking_snippet
GET /sites/:site_id/tracking/snippet
Build the tracking snippet for chosen options
analytics.read
Tool
Endpoint
Summary
Permission
traffic_rules_create
POST /sites/:site_id/traffic_rules
Add a traffic rule
sites.manage
traffic_rules_delete
DELETE /sites/:site_id/traffic_rules/:id
Delete a traffic rule
sites.manage
traffic_rules_list
GET /sites/:site_id/traffic_rules
List traffic rules
analytics.read
traffic_rules_test
POST /sites/:site_id/traffic_rules/test
Test whether a hit would be counted with the site's current rules
analytics.read
traffic_rules_update
PATCH /sites/:site_id/traffic_rules/:id
Change a traffic rule
sites.manage
Tool
Endpoint
Summary
Permission
uptime_checks_create
POST /sites/:site_id/uptime
Add an uptime check for a site
uptime.manage
uptime_checks_delete
DELETE /uptime/checks/:id
Delete an uptime check and its history
uptime.manage
uptime_checks_list
GET /sites/:site_id/uptime
List a site's uptime checks
analytics.read
uptime_checks_pause
POST /uptime/checks/:id/pause
Pause an uptime check
uptime.manage
uptime_checks_resume
POST /uptime/checks/:id/resume
Resume a paused uptime check
uptime.manage
uptime_checks_get
GET /uptime/checks/:id
Get an uptime check: uptime 24h/7d/30d, response times and incidents
analytics.read
uptime_checks_update
PATCH /uptime/checks/:id
Change an uptime check
uptime.manage
workspace_uptime_checks_create
POST /workspaces/:workspace_id/uptime
Add a workspace uptime check (not tied to a site)
uptime.manage
workspace_uptime_checks_list
GET /workspaces/:workspace_id/uptime
List all uptime checks in a workspace
analytics.read
Tool
Endpoint
Summary
Permission
testimonial_walls_create
POST /sites/:site_id/testimonials/walls
Create a Wall of Love
content.write
testimonial_walls_trash
DELETE /sites/:site_id/testimonials/walls/:id
Move a wall to the trash. For a person: the tool only returns a link to the app
content.write
testimonial_walls_duplicate
POST /sites/:site_id/testimonials/walls/:id/duplicate
Copy a wall under a new name and address
content.write
testimonial_walls_embed
GET /sites/:site_id/testimonials/walls/:id/embed
Get the link to a wall and the code to place it inside another page
analytics.read
testimonial_walls_list
GET /sites/:site_id/testimonials/walls
List the Walls of Love of a site
analytics.read
testimonial_walls_restore
POST /sites/:site_id/testimonials/walls/:id/restore
Restore a wall from the trash
content.write
testimonial_walls_get
GET /sites/:site_id/testimonials/walls/:id
Get one wall with every setting
analytics.read
testimonial_walls_update
PATCH /sites/:site_id/testimonials/walls/:id
Change a wall
content.write
Tool
Endpoint
Summary
Permission
warehouse_destinations_create
POST /workspaces/:workspace_id/warehouses
Add a warehouse destination. For a person: the tool only returns a link to the app
workspace.manage
warehouse_destinations_delete
DELETE /warehouses/:id
Delete a warehouse destination. For a person: the tool only returns a link to the app
workspace.manage
warehouse_destinations_list
GET /workspaces/:workspace_id/warehouses
List warehouse destinations
workspace.manage
warehouse_destinations_get
GET /warehouses/:id
Get a warehouse destination (no secrets)
workspace.manage
warehouse_destinations_sync
POST /warehouses/:id/sync
Queue a sync of one day now. For a person: the tool only returns a link to the app
workspace.manage
warehouse_destinations_update
PATCH /warehouses/:id
Update a warehouse destination (blank secrets are kept). For a person: the tool only returns a link to the app
workspace.manage
Tool
Endpoint
Summary
Permission
webhook_deliveries_list
GET /workspaces/:workspace_id/webhooks/:webhook_id/deliveries
List deliveries for a webhook
workspace.manage
webhook_deliveries_redeliver
POST /workspaces/:workspace_id/webhooks/:webhook_id/deliveries/:id/redeliver
Send a delivery again. Emails you when an assistant uses it
workspace.manage
webhooks_create
POST /workspaces/:workspace_id/webhooks
Add a webhook endpoint. Emails you when an assistant uses it
workspace.manage
webhooks_delete
DELETE /workspaces/:workspace_id/webhooks/:id
Delete a webhook. Emails you when an assistant uses it
workspace.manage
webhooks_list
GET /workspaces/:workspace_id/webhooks
List webhooks
workspace.manage
webhooks_get
GET /workspaces/:workspace_id/webhooks/:id
Get a webhook
workspace.manage
webhooks_test
POST /workspaces/:workspace_id/webhooks/:id/test
Send a test delivery. Emails you when an assistant uses it
workspace.manage
webhooks_update
PATCH /workspaces/:workspace_id/webhooks/:id
Update a webhook (events, URL, enabled, rotate secret). Emails you when an assistant uses it
workspace.manage
Tool
Endpoint
Summary
Permission
blog_list
GET /blog
List blog posts
public
blog_get
GET /blog/:slug
Read a blog post (Markdown and HTML)
public
changelog_list
GET /changelog
List changelog entries
public
pricing_get
GET /pricing
Get plans, prices and plan limits
public
status_get
GET /status
Get the current system status
public
tools_consent_gap
GET /tools/consent-gap
Estimate traffic missed by consent-based analytics
public
tools_header_check
GET /tools/header-checker
Check a page’s Referrer-Policy and CSP for analytics
public
tools_privacy_policy
GET /tools/privacy-policy-generator
Draft a privacy-policy paragraph for Privatus Analytics
public
tools_qr_code
GET /tools/qr-code
Generate a QR code as SVG
public
tools_tracker_scan
GET /tools/tracker-scanner
List cookies and known trackers on a page
public
tools_utm_builder
GET /tools/utm-builder
Build a campaign URL with UTM parameters
public
Tool
Endpoint
Summary
Permission
testimonial_widgets_mark_copied
POST /sites/:site_id/testimonials/widgets/:id/copied
Note that the pasted HTML embed of a widget was copied
content.write
testimonial_widgets_create
POST /sites/:site_id/testimonials/widgets
Create a widget
content.write
testimonial_widgets_trash
DELETE /sites/:site_id/testimonials/widgets/:id
Move a widget to the trash. For a person: the tool only returns a link to the app
content.write
testimonial_widgets_duplicate
POST /sites/:site_id/testimonials/widgets/:id/duplicate
Copy a widget with every setting
content.write
testimonial_widgets_embed
GET /sites/:site_id/testimonials/widgets/:id/embed
Get the embed code of a widget and what it weighs
analytics.read
testimonial_widgets_list
GET /sites/:site_id/testimonials/widgets
List the widgets of a site
analytics.read
testimonial_widgets_installs
GET /sites/:site_id/testimonials/widgets/:id/installs
List the pages a widget was seen live on
analytics.read
testimonial_widgets_restore
POST /sites/:site_id/testimonials/widgets/:id/restore
Restore a widget from the trash
content.write
testimonial_widgets_get
GET /sites/:site_id/testimonials/widgets/:id
Get one widget with every setting, what it shows and where it is live
analytics.read
testimonial_widgets_update
PATCH /sites/:site_id/testimonials/widgets/:id
Change a widget
content.write
Tool
Endpoint
Summary
Permission
white_label_get
GET /workspaces/:workspace_id/white_label
Get the white label brand
workspace.manage
white_label_update
PATCH /workspaces/:workspace_id/white_label
Set the white label brand for shared dashboards and email reports (Business)
workspace.manage
workspace_security_get
GET /workspaces/:workspace_id/security
Get workspace security settings
workspace.manage
workspace_security_update
PATCH /workspaces/:workspace_id/security
Update workspace security settings (2FA, login methods, session lifetime, IP allowlist, support access). For a person: the tool only returns a link to the app
workspace.manage
workspaces_delete
DELETE /workspaces/:id
Delete a workspace and all its sites (owner only, cancels any subscription). For a person: the tool only returns a link to the app
workspace.manage
workspaces_list
GET /workspaces
List your workspaces
public
workspaces_get
GET /workspaces/:id
Get a workspace
public
workspaces_update
PATCH /workspaces/:id
Update workspace settings
workspace.manage