Privatus Analytics API
Every page in Privatus Analytics is also an API endpoint: add .json to the URL and send an API token as a Bearer token. Most of them are MCP tools too.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Every page in Privatus Analytics is also an API endpoint: add .json to the URL and send an API token as a Bearer token. Most of them are MCP tools too.
Endpoints 400
API tokens
- GETList API tokens
/workspaces/:workspace_id/api_tokens.jsonLists the API tokens of a workspace, newest first and paginated. Without the tokens.manage permission you only see your own tokens, with it you see every… - POSTCreate an API token (the token is returned once)
/workspaces/:workspace_id/api_tokens.jsonCreates an API token for the calling member in a workspace and returns the secret exactly once in the token field. Copy it immediately, it cannot be read… - DELETERevoke an API token
/workspaces/:workspace_id/api_tokens/:id.jsonRevokes an API token immediately and permanently. Requests that use it fail from then on, and a revoked token cannot be restored, create a new one instead.…
Account
- GETGet your profile and preferences
/account.jsonReturns the signed-in member's own profile and preferences. Use it to read settings before changing them with account_update. This is about the person, not a… - PATCHUpdate your profile and preferences
/account.jsonUpdates the signed-in member's own profile, display preferences and email subscriptions. Only the inputs you send change, everything else stays as it is.…
Ad creatives
- POSTAdd a creative to an ad placement
/sites/:site_id/experiments/ads/:ad_placement_id/creatives.jsonAdds an image of the placement's shape (at least its size, twice the size looks sharpest) and the address a click goes to. Send the image as a multipart file,… - GETGet one creative with its state
/sites/:site_id/experiments/ads/:ad_placement_id/creatives/:id.jsonA creative is processing until its image is made, then ready (or failed, with the reason in error). Requires analytics.read. - DELETEDelete a creative and its image
/sites/:site_id/experiments/ads/:ad_placement_id/creatives/:id.jsonPermanently deletes a creative and its image. One that an experiment compares can't be deleted: switch it off instead. The MCP tool does not run it and… - PATCHChange a creative
/sites/:site_id/experiments/ads/:ad_placement_id/creatives/:id.jsonChanges the link, weight, schedule or targeting, switches it off (active false) or replaces the image. Only given inputs change. A new image replaces the old…
Ad placements
- GETList a site's ad placements with their last 30 days
/sites/:site_id/experiments/ads.jsonEach placement with its key, size, how many creatives it has and stats (impressions, viewable impressions, clicks and ctr, the click rate per viewable… - POSTCreate an ad placement
/sites/:site_id/experiments/ads.jsonCreates a slot of one size on the site. Send size (a common size such as medium_rectangle or leaderboard) or width and height in pixels. key is what the tag… - GETGet a placement with each creative's numbers
/sites/:site_id/experiments/ads/:id.jsonThe placement, its creatives with their stats over the period (7d, 30d or 90d) and the placement's numbers day by day. humans_only keeps what the bot score… - DELETEDelete an ad placement with its creatives
/sites/:site_id/experiments/ads/:id.jsonPermanently deletes a placement with its creatives and their images, its ad experiments and their results, and its sponsor links. The tag on the site then… - PATCHChange an ad placement
/sites/:site_id/experiments/ads/:id.jsonChanges the name, key, size or label. Only given inputs change. A new key needs the new tag on the site. Requires content.write. - GETGet the tag that shows a placement on the site
/sites/:site_id/experiments/ads/:id/embed.jsonThe loader script (once a page) and the slot for this placement, as html to paste. The slot keeps its size before the loader runs. Requires analytics.read.
Affiliate program
- GETList your affiliate commissions
/account/affiliate/commissions.jsonCommissions, refund and chargeback clawbacks and reversals, newest first. Amounts are in cents. - GETGet your affiliate signup box code and results
/account/affiliate/signup-box.jsonThe embed code for your signup box (a script and a plain iframe) for the chosen theme, the attributes that prefill the form, the events the script fires on… - GETGet your affiliate status, referral link and stats
/account/affiliate.jsonYour affiliate application status, referral link, signups and paying customers you referred, and balances per currency (on hold, payable, paid). status is…
Alerts
- POSTAcknowledge the latest incident
/alerts/:id/acknowledge.jsonMarks the latest unacknowledged incident of an alert as seen by the calling user. It does not resolve the incident or mute the alert, the alert resolves by… - GETList alerts
/workspaces/:workspace_id/alerts.jsonLists the alert rules of a workspace (path takes workspace_id), sorted by name and paginated. Returns a data array of alerts with meta pagination. Each alert… - POSTCreate an alert
/workspaces/:workspace_id/alerts.jsonCreates an alert rule that watches a site (or the whole workspace for kind usage) and notifies the chosen channels when it triggers. Path takes workspace_id.… - GETGet an alert
/alerts/:id.jsonReturns one alert rule by id (alr_..., from alerts_list or site_alerts_list). The response is the alert object with id, site_id (null for usage alerts), name,… - DELETEDelete an alert
/alerts/:id.jsonPermanently deletes an alert rule and its whole incident history. This cannot be undone and notifications stop at once. To pause an alert without losing… - PATCHUpdate an alert
/alerts/:id.jsonChanges an existing alert rule (id from alerts_list). Only the inputs you send change, everything else keeps its value. The same per kind rules as… - GETIncident history of an alert
/alerts/:id/history.jsonLists the incidents of one alert, newest first and paginated. Each incident has triggered_at, resolved_at (null while still open), value (the measured number… - POSTMute (or unmute) an alert’s notifications
/alerts/:id/mute.jsonSilences the notifications of one alert for a number of minutes while it keeps evaluating and recording incidents in its history. minutes defaults to 60, the… - GETList alerts for a site
/sites/:site_id/alerts.jsonLists the alert rules of one site (path takes site_id), sorted by name and paginated. It returns the same alert objects and accepts the same state and kind…
Analytics
- GETClick map: the most clicked elements of the site, or of one page with the share of its visits that clicked each
/sites/:site_id/clicks.jsonClicks per element from the clicks tracker module. An element is a short CSS selector (tag, id and up to two classes, at most four levels), or… - GETSite overview: metrics, chart series, top panels, live visitors and notes
/sites/:site_id/overview.jsonOne call that returns everything the site overview page shows: use it to answer a broad question such as how a site is doing, instead of calling several… - GETReport 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)
/sites/:site_id/experiments/external.jsonReports an A/B test using event data. Visits are assigned to the variant found in an event property (the first value seen in the visit, for example property… - GETNotable changes vs the previous period, in plain English (biggest movers, goal conversion changes)
/sites/:site_id/insights.jsonPlain-English notable changes for a site, compared with the previous period of the same length. Returns period, comparison_period, insights and benchmarks.… - GETJourneys: top 3-step paths after a page (or any entrance), or before a page or goal
/sites/:site_id/journeys.jsonExplores the most common three-step page paths inside visits. In forward mode (default) it shows the paths after a start page given in path, or after any… - GETPage detail: metrics, previous and next pages, sources, Web Vitals, events and click map for one path
/sites/:site_id/pages/detail.jsonOne page in depth. Pass path (it must start with a slash, for example /pricing), exactly as stored (without query string or host). Returns period, path, url,… - GETReferrers: the sites that link to this site, with visitors, engagement, kind of traffic and number of linking pages
/sites/:site_id/referrers.jsonRanks the external sites that sent visitors, with what each one sent. Direct visits (no referrer) are left out. Returns period, summary, channels, page,… - GETReferrer detail: metrics and trend of one referring site, its linking pages, landing pages, countries, devices, campaigns and conversions
/sites/:site_id/referrers/detail.jsonOne referring site in depth. Pass referrer as the host without www and without a path (for example news.ycombinator.com), the same value as in referrers_list.… - GETHeadline metrics for a period (with comparison)
/sites/:site_id/stats/aggregate.jsonHeadline numbers for one period, as one object. Returns period {from, to} and metrics {visitors, visits, pageviews, views_per_visit, bounce_rate,… - GETTop values of a dimension (pages, sources, countries…)
/sites/:site_id/breakdown/:dimension.jsonTop values of one dimension with their metrics, most important first, paginated. The dimension is the last part of the path and must be an exact name from its… - GETMetrics per time bucket for charts
/sites/:site_id/stats/timeseries.jsonMetrics per time bucket, for charts and trends. Returns period, interval (the bucket actually used) and series, a list of {date, visitors, visits, pageviews,…
Assistant
- GETList your Ask conversations for a site
/sites/:site_id/ask.jsonLists the signed-in member's Ask conversations on one site, most recently updated first. Conversations of other members are never shown. Use it to find a… - POSTAsk a question in a new conversation (counts toward the monthly AI questions limit)
/sites/:site_id/ask.jsonStarts a new Ask conversation on one site and answers its first question using that site's analytics. Use it for a plain-English question about a site. Use… - GETAn Ask conversation: questions, answers, the queries behind them and charts
/sites/:site_id/ask/:id.jsonReturns one Ask conversation with its full message history. Get the conversation id from assistant_conversations_list or from the result of assistant_ask.… - DELETEDelete an Ask conversation and its messages
/sites/:site_id/ask/:id.jsonPermanently deletes one Ask conversation and all its messages right away. This cannot be undone. Get the conversation id from assistant_conversations_list.… - POSTAsk a follow-up question in a conversation (counts toward the monthly AI questions limit). Returns the answer.
/sites/:site_id/ask/:ask_conversation_id/messages.jsonAsks a follow-up question inside an existing Ask conversation, so the assistant keeps the earlier questions and answers as context. Use assistant_ask to start…
Audit log
- GETList audit log entries (add .csv to export)
/workspaces/:workspace_id/audit_log.jsonReturns the workspace audit log, a newest-first, paginated record of who changed what (settings, members, sites, goals, tokens and so on). It needs the…
Billing
- POSTOpt in or out of the badge bonus (free plan)
/workspaces/:workspace_id/billing/badge.jsonOpts a Free workspace in or out of the Privatus Analytics badge bonus, which raises the monthly event allowance. Set enabled to true to opt in. A background… - POSTCancel at the end of the billing period
/workspaces/:workspace_id/billing/cancel.jsonCancels the paid subscription at the end of the current paid period. Nothing is refunded and the plan stays active until current_period_ends_at, after which… - POSTChange plan, tier or interval (prorated)
/workspaces/:workspace_id/billing/change_plan.jsonMoves the existing subscription to another plan, event tier or billing interval. This charges money. The change takes effect immediately and Paddle prorates… - POSTStart a Paddle checkout for a paid plan
/workspaces/:workspace_id/billing/checkout.jsonStarts a Paddle checkout for a workspace that has no subscription yet and returns a hosted checkout URL. Nothing is charged until a person completes the… - POSTApply for a discount program (nonprofit, education, open source or agency)
/workspaces/:workspace_id/billing/discount.jsonApplies for a discount program for the workspace. This submits an application for staff review and emails the Privatus Analytics team, it does not grant a… - POSTGet a link to update the payment method
/workspaces/:workspace_id/billing/payment_method.jsonReturns a Paddle link where a person can update the subscription's payment method. Nothing is changed by the call itself. Give the url to the person to open… - POSTGet a Paddle customer portal link
/workspaces/:workspace_id/billing/portal.jsonReturns a link to the Paddle customer portal, where a person can see invoices, payment methods and addresses. Nothing is changed by the call itself. Give the… - GETPreview a plan change with proration
/workspaces/:workspace_id/billing/preview.jsonShows what moving the subscription to another plan, tier or interval would cost right now, without changing anything. Always run it before billing_change_plan… - POSTUndo a scheduled cancellation or resume a pause
/workspaces/:workspace_id/billing/resume.jsonUndoes a scheduled cancellation, or resumes a paused subscription, so the plan keeps renewing. Use it after billing_cancel and before current_period_ends_at.… - GETGet the plan, subscription and usage
/workspaces/:workspace_id/billing.jsonReturns the workspace's plan and billing state. Use it before changing anything in billing, and to learn whether the subscription is active or cancelling.… - PATCHUpdate billing emails, tax id and auto-upgrade
/workspaces/:workspace_id/billing.jsonUpdates the workspace's billing settings. Only the inputs you send change. billing_emails is an array of up to 5 extra addresses for invoices and billing… - GETGet this month's usage, forecast and per-site split
/workspaces/:workspace_id/billing/usage.jsonReturns the workspace's event usage for one month. Use it to check how close the workspace is to its hard monthly limit. Inputs are month (any day in the… - GETList invoices
/workspaces/:workspace_id/billing/invoices.jsonLists the workspace's billing transactions, newest first. Each item has id (use it with billing_invoices_get), invoice_number (nullable), status, amount_minor… - GETGet the PDF link for an invoice
/workspaces/:workspace_id/billing/invoices/:id.jsonReturns a link to the PDF invoice of one billed transaction. Get the invoice id from billing_invoices_list (the id field, a Paddle transaction id). The result…
Bot detection
- GETAdvanced Bot Detection report: hits on the site's honeypot pages, by page and by what gave the bot away
/sites/:site_id/bot-detection.jsonReports the hits on the site's honeypot pages. A honeypot page is a page reached only through a hidden link and set up as the Advanced Bot Detection page in…
Campaigns
- GETList campaign cost entries
/sites/:site_id/campaigns/costs.jsonLists the ad spend entries recorded for a site, newest month first, then by campaign name. Each row is one campaign in one month with amount_minor (an integer… - POSTSet the spend for a campaign in a month
/sites/:site_id/campaigns/costs.jsonRecords ad spend for one campaign in one month, so campaigns_list can show cost per acquisition and return on ad spend. If an entry for the same campaign and… - DELETEDelete a campaign cost entry
/sites/:site_id/campaigns/costs/:id.jsonPermanently deletes one spend entry, found by its id from campaign_costs_list. This cannot be undone, and CPA and ROAS for that campaign and month stop… - PATCHChange a campaign cost entry
/sites/:site_id/campaigns/costs/:id.jsonChanges an existing spend entry, found by its id from campaign_costs_list. Only the inputs you send change, so send just amount to correct a number. amount is… - POSTImport campaign costs from CSV (campaign,month,amount[,currency])
/sites/:site_id/campaigns/costs/import.jsonBulk-imports ad spend from CSV, the quick way to load many campaigns and months. Send the CSV text in csv (best for tools and API calls) or upload a file in… - GETBuild and validate a UTM-tagged URL
/sites/:site_id/campaigns/builder.jsonBuilds a UTM-tagged URL for a landing page and checks the values. Nothing is saved and no data is read, so it is safe to call repeatedly. Pass destination (a… - GETUTM hygiene: near-duplicate values, style issues and unknown sources
/sites/:site_id/campaigns/hygiene.jsonFinds messy UTM values in the traffic of a period so you can fix tagging. Returns period, duplicates, style_issues and unknown_sources. duplicates groups… - GETCampaign rollup with conversions, revenue, cost, CPA and ROAS
/sites/:site_id/campaigns.jsonCampaign performance report built from utm_campaign, with cost and return on ad spend. Returns period, currency (the site currency), goal_id and goal_name… - GETList saved campaign links
/sites/:site_id/campaigns/links.jsonLists the saved campaign links (UTM-tagged URLs) of one site (path takes site_id), newest first and paginated. Each link has id (lnk_...), name, destination,… - POSTSave a UTM-tagged link to the library
/sites/:site_id/campaigns/links.jsonSaves a UTM-tagged link to the site's link library (path takes site_id). name (up to 120 characters) and destination (an http or https URL up to 2048… - GETGet a saved campaign link
/sites/:site_id/campaigns/links/:id.jsonReturns one saved campaign link by id (lnk_..., from links_list). The response has name, destination, utm_source, utm_medium, utm_campaign, utm_content,… - DELETEDelete a saved link
/sites/:site_id/campaigns/links/:id.jsonRemoves a saved link from the library. This only deletes the saved entry, URLs you already shared keep working and their visits are still counted by campaign.… - PATCHChange a saved link
/sites/:site_id/campaigns/links/:id.jsonChanges a saved campaign link (id from links_list). Only the inputs you send change. The same cleaning and personal data checks as links_create apply. Sending… - GETQR code (SVG) for a saved link
/sites/:site_id/campaigns/links/:id/qr.jsonReturns a QR code for a saved link's full tagged URL, for print. The response has link_id, url (the tagged URL encoded in the code) and svg (a complete…
Channel rules
- GETList channel rules in order
/sites/:site_id/channel_rules.jsonLists the custom channel rules of a site in evaluation order (position 1 first). Rules run top to bottom against each new visit and the first rule whose… - POSTAdd a channel rule
/sites/:site_id/channel_rules.jsonAdds a custom channel rule at the end of the list, so it runs after all existing rules and the built-in taxonomy only applies when no rule matches. channel is… - DELETEDelete a channel rule
/sites/:site_id/channel_rules/:id.jsonDeletes a custom channel rule, found by its id from channel_rules_list. Visits it already classified keep their channel, and new visits fall through to the… - PATCHChange a channel rule
/sites/:site_id/channel_rules/:id.jsonChanges a custom channel rule, found by its id from channel_rules_list. Send channel to rename the channel it assigns and conditions to replace the whole… - PATCHMove a channel rule up or down
/sites/:site_id/channel_rules/:id/move.jsonMoves a channel rule within the evaluation order, because the first matching rule wins and order decides which channel a visit gets. direction is up or down… - POSTPreview the channel for a sample referrer and UTM tags
/sites/:site_id/channel_rules/preview.jsonDry run that tells you which channel a sample visit would get with the site's current rules. Nothing is stored. Send any of referrer (a URL or bare hostname,…
Collection
- POSTRecord that a creative was shown, seen or clicked, called by the ad loader
/embed/ads/e.json - GETA site's ad slots and the creatives each one shows, called by the ad loader
/embed/ads/:site.json - POSTThe clicks of one page for the click overlay, called by pa.overlay.js with its pass
/api/overlay.json - POSTSend server access logs for AI crawler reporting (JSON {lines: [...]} or combined log text, with the site's crawler log key as Bearer token)
/api/logs.json - POSTCollect a browser hit (used by /js/pa.js)
/api/event.json - GETWhether an experiment sends this visitor to a variant page, called by the experiments head script
/api/experiment.json - GETThe script the optional experiments head tag loads for a site
/js/exp/:site.json - POSTRecord that a survey card was shown, dismissed or answered
/api/survey.json - GETWhat survey to show on a page, called by the tracker's ask module
/api/surveys.json
Crawlers
- DELETEDisconnect Cloudflare and delete its stored API token and the crawler hits it imported
/sites/:site_id/crawlers/connection.jsonDisconnects Cloudflare from a site. This deletes the stored API token and every crawler hit that was imported from Cloudflare, and it cannot be undone. Hits… - POSTImport crawler hits from Cloudflare now
/sites/:site_id/crawlers/sync.jsonQueues an immediate Cloudflare import for a site that is already connected, instead of waiting for the regular schedule. It returns right away (HTTP 202) with… - GETAI crawlers report: hits by crawler over time, top paths per crawler, by category
/sites/:site_id/crawlers.jsonReports which AI, search and SEO crawlers fetch the site, how often and which paths, from shipped server logs and the Cloudflare import. This is crawler…
Dashboards
- GETData for one card of a custom dashboard
/workspaces/:workspace_id/dashboards/:id/cards/:index.jsonReturns the live data of one card of a custom dashboard. Dashboards are lists of cards (see dashboards_get for the card list) and each card loads separately,… - GETList custom dashboards
/workspaces/:workspace_id/dashboards.jsonLists the custom dashboards of a workspace, ordered by name. Each item has id (dash_...), name, cards and timestamps, the same shape as dashboards_get. A… - POSTCreate a custom dashboard
/workspaces/:workspace_id/dashboards.jsonCreates a custom dashboard in a workspace. A custom dashboard is a named, ordered list of up to 40 cards, and the cards can come from different sites of the… - GETGet a custom dashboard and its cards
/workspaces/:workspace_id/dashboards/:id.jsonReturns one custom dashboard: id (dash_...), name, cards and created_at and updated_at. Each card is {type, site_id, title, params} (type is metric, chart,… - DELETEDelete a custom dashboard
/workspaces/:workspace_id/dashboards/:id.jsonPermanently deletes a custom dashboard. Only the dashboard layout is removed, no analytics data is touched, and there is no undo. You need access to every… - PATCHRename a custom dashboard or replace its cards
/workspaces/:workspace_id/dashboards/:id.jsonRenames a custom dashboard and/or replaces its whole list of cards. Only the fields you send change, and name is left alone when empty. Sending cards replaces…
Documentation
- GETList every API operation and MCP tool
/docs/api.jsonReturns the full catalog of every API operation. Most are MCP tools too, and mcp is false for the ones that are HTTP only or that a person does in the app… - GETList documentation pages
/docs.jsonLists every documentation page with title, description, path (such as /docs/api/authentication), section and no body. Use it to browse what exists. To find a… - GETOpenAPI 3.1 document for the whole API
/openapi.jsonReturns the OpenAPI 3 document describing the whole public API as raw JSON (not wrapped in a data field). Use it when you need a machine-readable spec for… - GETSearch the documentation
/docs/search.jsonSearches the documentation on the server and returns ranked pages. Use it to find how a feature works before guessing. q is split into up to 10 terms, every… - GETRead a documentation page (Markdown and HTML)
/docs/:section/:page.jsonsection and page come from the page path /docs/<section>/<page>. Use page "index" for a section overview.
Domain Rating
- GETDomain Rating report: the latest rating, inbound and outbound links, the change since the release before and the history by month
/sites/:site_id/domain-rating.jsonReturns the site's Domain Rating, a 0 to 100 estimate of how strong the links pointing at its domain are, plus inbound and outbound link counts and their…
Email reports
- DELETERemove a recipient from an email report
/recipients/:id.jsonRemoves one address from an email report (id of the recipient, from email_report_recipients_list). The address stops receiving reports and its row is deleted.… - GETList the recipients of an email report with their status
/reports/:report_id/recipients.jsonStatuses: active (gets reports), pending (invited, not yet accepted), declined or unsubscribed. Add or remove addresses through the report's recipients list. - POSTResend a pending report invite
/recipients/:id/resend.jsonSends the invite again with new links. Allowed once every 7 days per address per report. - GETList email reports
/workspaces/:workspace_id/reports.jsonLists the scheduled email reports of a workspace (path takes workspace_id), sorted by name and paginated. Each report has id (rep_...), name, site_ids,… - POSTCreate an email report
/workspaces/:workspace_id/reports.jsonCreates a scheduled analytics email report covering one or more sites (path takes workspace_id). Required are name and site_ids (pa_... ids). frequency is… - GETDelivery log of an email report
/reports/:id/deliveries.jsonLists the send log of one email report, newest first and paginated. Each entry has status (sent for a scheduled send, test, failed or skipped),… - GETGet an email report
/reports/:id.jsonReturns one email report by id (rep_..., from email_reports_list). The response has name, site_ids, frequency, hour, weekday, recipients, recipient_details… - DELETEDelete an email report
/reports/:id.jsonPermanently deletes an email report together with its recipients and delivery log. This cannot be undone and no further emails are sent. To stop sending but… - PATCHUpdate an email report
/reports/:id.jsonChanges an email report (id from email_reports_list). Only the inputs you send change. Sending recipients replaces the whole list. Addresses you drop are… - POSTSend an email report now as a test
/reports/:id/send_test.jsonSends the report to one address right now as a test, without changing its schedule or last_sent_at. Sends a real email, so only use it when the user wants… - POSTAccept a report invite
/reports/invites/:token/accept.json - POSTDecline a report invite
/reports/invites/:token/decline.json - POSTReceive reports again after opting out
/reports/resubscribe/:token.json - POSTEmail an address a link to receive reports again
/reports/unsubscribe/:token/resubscribe.json - POSTUnsubscribe an address from an email report
/reports/unsubscribe/:token.json
Email settings
- POSTStop every email to an address that it can turn off, with the token from its email settings link
/email/preferences/:token/unsubscribe.json - POSTTurn emails to an address off or on with the token from its email settings link
/email/preferences/:token.json
Events
- GETList event property keys seen in the last 30 days
/sites/:site_id/events/properties.jsonLists the property keys that custom events carried in the last 30 days, with display settings. Returns a list of {key, events, display_name, hidden,… - PATCHRename or hide an event property key
/sites/:site_id/events/properties.jsonRenames, hides or marks as export-safe one event property key, for the whole site. Only the inputs you send change. key must be the key as stored (lowercase… - GETList events with completions, visits, conversion rate and first/last seen
/sites/:site_id/events.jsonThe events explorer: every custom event in the period. Returns period, events and hidden. Each event has name (the display name after renames and merges),… - DELETEDelete an event and its history (runs in the background, confirm by typing the name)
/sites/:site_id/events.jsonPermanently deletes a custom event and its whole history. This cannot be undone. The raw event name must be sent twice, in name and again in confirm, as a… - POSTMerge several events into one display name
/sites/:site_id/events/merge.jsonMerges several raw event names into one display name, for example signup_click and signup_button into Signup. Reports then show a single event with the… - GETOne event: chart, property pivot, number property aggregates, pages and sources
/sites/:site_id/events/detail.jsonDetail of one custom event. Pass name exactly as shown in events_list (the display name after renames and merges). Returns period, name, raw_names (the stored… - PATCHRename, hide or unhide an event, or set its currency
/sites/:site_id/events/settings.jsonChanges how one custom event is shown: rename it with display_name, hide or unhide it with hidden, or set the revenue currency. name is the raw event name as…
Experiments
- GETList a site's experiments with their visits and conversions
/sites/:site_id/experiments.jsonLists the A/B and split URL tests of a site, newest first. Filter with status (draft, scheduled, running, paused, ended or all, default all). Paginated with… - POSTCreate an experiment as a draft
/sites/:site_id/experiments.jsonCreates an A/B or split URL test for a site. It is saved as a draft and sends no visitor anywhere until a person starts it in the app. Required are name, path… - GETGet one experiment with its results
/sites/:site_id/experiments/:id.jsonReturns one experiment by id (exp_..., from experiments_list) with its results: per variant the visits, conversions and conversion rate on the goal, and… - DELETEDelete an experiment with its results
/sites/:site_id/experiments/:id.jsonPermanently deletes an experiment with its variants and results. This cannot be undone. Use experiments_pause to stop it and keep the results. The MCP tool… - PATCHUpdate an experiment
/sites/:site_id/experiments/:id.jsonChanges an experiment. Only the inputs you send change, and variants replaces the whole list. Once an experiment has started only name and send_to_winner can… - POSTCopy an experiment as a new draft
/sites/:site_id/experiments/:id/duplicate.jsonCreates a draft with the same pages, shares, goal and rules as an existing experiment and none of its results. Use it to change a test that has already… - POSTEnd an experiment for good
/sites/:site_id/experiments/:id/end.jsonEnds a running or paused experiment. It cannot be started again, its results are kept and it no longer counts toward the plan limit. The MCP tool does not run… - POSTPause an experiment and keep its results
/sites/:site_id/experiments/:id/pause.jsonPauses a running or scheduled experiment. Every visitor gets the original page again at once and the results so far are kept. experiments_start resumes it.… - POSTStart an experiment
/sites/:site_id/experiments/:id/start.jsonStarts a draft or paused experiment, so visitors of the original page begin to be sent to the variants. With starts_at in the future it waits for that time.…
Exports
- GETList exports (the job queue)
/workspaces/:workspace_id/exports.jsonLists the exports of a workspace for the sites you can access, newest first. Use it to find an export id, check which exports are still running or to see what… - POSTQueue an export (built in the background)
/workspaces/:workspace_id/exports.jsonQueues a data export that is built in the background and returns it right away with status queued. Choose it when you need a file (CSV, JSON, XLSX, NDJSON or… - GETGet an export and its status
/exports/:id.jsonReturns one export, including its progress. Use it to poll an export started with exports_create until status is complete or failed. Statuses are queued,… - DELETEDelete an export and its file
/exports/:id.jsonPermanently deletes an export and its generated file. The download link stops working at once and this cannot be undone, but you can create the export again.… - GETGet a signed link to the file (valid 10 minutes)
/exports/:id/download.jsonReturns a short-lived download link for a finished export. Choose it after exports_get shows status complete. The response has url (a signed link that is… - POSTPreview an export: first 20 rows and the estimated row count
/workspaces/:workspace_id/exports/preview.jsonDry run of an export that creates nothing. It takes the same inputs as exports_create and returns kind, file_format, columns (the column names in order), rows…
Forms
- GETList the forms of a site
/sites/:site_id/testimonials/forms.jsonForms in the trash are listed with trashed true, and left out otherwise. Each form carries its settings, its reward and how many submissions it has had. - POSTCreate a form
/sites/:site_id/testimonials/forms.jsonOne call carries the whole form: steps, questions, skip logic, consent wording and language. Anything left out starts from a sensible default in the form's… - DELETEDelete a form for good
/sites/:site_id/testimonials/forms/:id/permanent.jsonDeletes the form, its submission records, its reward and its private feedback. The testimonials it collected are kept. It cannot be undone, so it is done by a… - GETGet one form with every step, question, rule and setting
/sites/:site_id/testimonials/forms/:id.jsonReturns the whole form as testimonial_forms_create and testimonial_forms_update take it, with its slug, its link, its reward and how many submissions it has.… - DELETEMove a form to the trash
/sites/:site_id/testimonials/forms/:id.jsonIts link responds that the form is closed until it is restored. The trash is emptied after 30 days. Over MCP the tool changes nothing and responds with the… - PATCHChange a form. Only the inputs sent change
/sites/:site_id/testimonials/forms/:id.jsonA change to a step, a question or the consent wording raises the form's version, which every consent record stores. A changed slug leaves the old link… - POSTCopy a form, optionally into another language
/sites/:site_id/testimonials/forms/:id/duplicate.jsonCopies every setting except the slug, the statistics and the reward. - GETGet a form's QR code as SVG or PNG
/sites/:site_id/testimonials/forms/:id/qr.jsonThe code holds the form's link with ?src=qr, so scans are counted as their own channel. A changed slug keeps a printed code working. - POSTRestore a form from the trash. Its link works again
/sites/:site_id/testimonials/forms/:id/restore.jsonTakes a form out of the trash as it was, with its questions, submissions and private feedback. Its link (/f/<slug>) and its embeds take answers again. The… - GETGet a form's link, QR code links and embed snippets
/sites/:site_id/testimonials/forms/:id/share.jsonReturns the link, the inline embed snippet and the popup embed snippet. The popup inputs (trigger, label, position, accent) change the popup snippet.
Funnels
- GETList funnels with entries, completions and rate
/sites/:site_id/funnels.jsonLists the funnels of a site with their headline results for the period, ordered by name. Each funnel has id (fun_...), name, steps, order_mode, window and… - POSTCreate a funnel
/sites/:site_id/funnels.jsonCreates a funnel, a sequence of steps that visits move through, measured per visit. Pass name and steps, an ordered list of {type, value, match, name}. type… - GETFunnel report: step counts, conversion, drop-off, time between steps and where visits went instead
/sites/:site_id/funnels/:id.jsonThe conversion report of one funnel for a period. Returns period, funnel_id, name, order_mode, window, steps, overall_conversion_rate, breakdown and, with… - DELETEDelete a funnel
/sites/:site_id/funnels/:id.jsonPermanently deletes a funnel definition. No analytics data is touched, but the funnel and its settings cannot be recovered and there is no undo. Returns the… - PATCHUpdate a funnel
/sites/:site_id/funnels/:id.jsonChanges a funnel. Only the inputs you send change. Sending steps replaces the whole list of steps, so send every step in order (format and step limits are the…
Goals
- POSTArchive a goal (hidden from reports)
/sites/:site_id/goals/:id/archive.jsonArchives a goal. An archived goal is hidden from reports, does not count toward the plan's goal limit and keeps its definition, so it can be restored later… - GETList goals with completions, conversions, rate and value for a period
/sites/:site_id/goals.jsonLists the goals of a site with their results for the period. Each goal is the definition (id goal_..., name, kind, match_type, pattern, hostname, event_name,… - POSTCreate a goal
/sites/:site_id/goals.jsonCreates a conversion goal. Goals are definitions applied when reports are read, so a new goal immediately counts matching events in all existing history.… - GETGoal report: metrics, chart, breakdowns and the journey to converting
/sites/:site_id/goals/:id.jsonOne goal in depth for a period. Returns period, goal_id, goal (the definition), metrics, interval, series, breakdowns, journey and, with compare,… - DELETEDelete a goal (data is kept)
/sites/:site_id/goals/:id.jsonPermanently deletes a goal definition. No event data is deleted, but the goal disappears from reports, and funnel steps, journeys and experiments that point… - PATCHUpdate a goal
/sites/:site_id/goals/:id.jsonChanges a goal's definition. Only the inputs you send change. The new definition applies to all history straight away, so past conversion numbers will change.… - POSTCopy a goal
/sites/:site_id/goals/:id/duplicate.jsonCopies a goal's definition into a new active goal. The copy is named name if you send it, otherwise the original name followed by (copy). It counts toward the… - POSTRestore an archived goal
/sites/:site_id/goals/:id/unarchive.jsonRestores an archived goal so it shows in reports again. It counts toward the plan's goal limit again (10 active goals per site on Free), so the call fails…
Help and feedback
- POSTSend a question or feedback to the Privatus Analytics team
/help.jsonThe message is emailed to the team with your account, workspace and plan details attached. The reply and a receipt go to your account email. Up to 10 messages…
Imports
- DELETEDisconnect your Google Analytics account and delete its stored access tokens
/sites/:site_id/imports/google/connection.jsonRemoves the stored Google Analytics connection of the calling member for this site's workspace, so GA4 imports can no longer read from Google until it is… - GETList Google Analytics 4 properties to import
/sites/:site_id/imports/google/properties.jsonLists the Google Analytics 4 properties the calling member's connected Google account can read. Call it before imports_create with source ga4 to get the… - GETList imports for a site
/sites/:site_id/imports.jsonLists the imports of a site, newest first. Use it to find an import id or check whether one is still running. Optionally filter by status (queued, running,… - POSTStart an import (GA4 property or CSV upload)
/sites/:site_id/imports.jsonStarts an import of historical data from another analytics tool into a site, processed in the background, and returns the import with status queued. Choose… - GETGet an import and its status
/sites/:site_id/imports/:id.jsonReturns one import of a site, used to poll an import started with imports_create. Fields are id (imp_...), site_id, source, status (queued, running, complete… - DELETEDelete an import and all its imported data
/sites/:site_id/imports/:id.jsonPermanently deletes an import together with every row it brought in and its uploaded file. Stats that included the imported data change right away when…
Live
- GETLive visitors, activity stream and what is popular right now (last 30 minutes)
/sites/:site_id/live.jsonWhat is happening on the site right now. Returns live_visitors (visitors in the last 5 minutes), window_minutes (30), sparkline (visits per minute for the… - GETWallboard cards (live and today) for one or more sites
/sites/:site_id/live/wallboard.jsonCompact big-number cards for one or more sites, built for an office screen. Returns rotate_seconds, generated_at and sites. Each site card has id (pa_...),… - GETWallboard for a wallboard token (no login needed)
/wallboard/:token.json - GETList wallboard links for a site
/sites/:site_id/live/wallboard/links.jsonLists the wallboard links of a site (path takes site_id), newest first and including revoked ones. A wallboard link is a secret URL that shows live visitors… - POSTCreate a wallboard link (read-only, revocable)
/sites/:site_id/live/wallboard/links.jsonCreates a read-only wallboard URL that anyone holding it can open without logging in, so share it only with people who should see these numbers. Path takes… - DELETERevoke a wallboard link
/sites/:site_id/live/wallboard/links/:id.jsonRevokes a wallboard link so TVs that show it stop updating and the URL stops working. This cannot be undone, create a new link instead. Revoking an already…
Members
- GETList pending invitations
/workspaces/:workspace_id/invitations.jsonLists the pending team invitations of a workspace, newest first and paginated. Accepted and revoked invitations are not listed (use members_list for people… - POSTInvite people by email
/workspaces/:workspace_id/invitations.jsonInvites one or more people to a workspace by email and sends each an invitation email with a link that is valid for 14 days. emails is a list of up to 50… - DELETERevoke a pending invitation
/workspaces/:workspace_id/invitations/:id.jsonRevokes a pending invitation so its link no longer works, and frees the seat it held. The deletion cannot be undone, invite the person again with… - DELETERemove a member (or leave the workspace)
/workspaces/:workspace_id/members/:id.jsonRemoves a member from a workspace, or lets the caller leave it when the id is their own membership. This is immediate and cannot be undone, the person loses… - PATCHChange a member's role or site access
/workspaces/:workspace_id/members/:id.jsonChanges a member's role and or site access in a workspace. Only the inputs you send change. To change the role send role (admin, editor, analyst, viewer or… - GETList workspace members
/workspaces/:workspace_id/members.jsonLists the members of a workspace in the order they joined, paginated. Use query to search by name or email (partial, case-insensitive) and role to filter by… - POSTTransfer workspace ownership to another member (owner only, you become an admin)
/workspaces/:workspace_id/ownership_transfer.jsonTransfers ownership of a workspace to another member and demotes the caller to admin, which is hard to undo because only the new owner can transfer it back.…
Mobile app
- GETGet what the mobile app needs to open a workspace
/workspaces/:workspace_id/app.jsonReturns, for one workspace (path takes workspace_id), the caller's role and permissions there, features (which gated reports the plan includes:… - GETGet the mobile app's push registration
/account/device.jsonReturns the device of the mobile app login that is calling: registered (false until the app registered a push token), platform, locale, timezone, app_version,… - DELETEStop push notifications to the mobile app
/account/device.jsonRemoves the push registration of the calling mobile app login, so the device gets no more pushes. The login itself stays, and the app can register again.… - PATCHRegister the mobile app for push notifications
/account/device.jsonRegisters the device of the calling mobile app login for push notifications, or changes what it gets. Only the inputs you send change. The first call needs…
Notes
- GETList notes for a site (including workspace-wide notes)
/sites/:site_id/notes.jsonLists the annotations (notes) shown on a site's charts, newest date first and paginated. It returns the site's own notes plus workspace-wide notes that apply… - POSTAdd a note to a site (use source "deploy" for release webhooks)
/sites/:site_id/notes.jsonAdds an annotation to one site's charts, for example a launch, a campaign or a release. Use workspace_notes_create instead for a note that shows on every… - GETGet a note
/sites/:site_id/notes/:id.jsonReturns one note by its id (note_..., from notes_list) for a site, including workspace-wide notes that apply to the site. A note is a dated annotation shown… - DELETEDelete a note
/sites/:site_id/notes/:id.jsonPermanently deletes a site note, which disappears from the charts and cannot be restored. The note must belong to this site, workspace-wide notes are deleted… - PATCHEdit a note
/sites/:site_id/notes/:id.jsonEdits a site note, changing only the fields you send (date, end_date, title, body, url, color). The source cannot be changed. Sending an empty url removes the… - GETList notes across a workspace
/workspaces/:workspace_id/notes.jsonLists the annotations across a workspace, newest date first and paginated. It returns workspace-wide notes (which show on every site) plus the notes of every… - POSTAdd a workspace-wide note (shown on every site)
/workspaces/:workspace_id/notes.jsonAdds a workspace-wide annotation that appears on the charts of every site in the workspace, for example a company-wide launch or an outage. It is created… - DELETEDelete a workspace note
/workspaces/:workspace_id/notes/:id.jsonPermanently deletes a workspace-wide note so it disappears from every site's charts, and it cannot be restored. Only notes with no site can be deleted here,… - PATCHEdit a workspace note
/workspaces/:workspace_id/notes/:id.jsonEdits a workspace-wide note, changing only the fields you send (date, end_date, title, body, url, color). Only notes with no site can be edited here, use…
Notification channels
- GETGet a notification channel
/channels/:id.jsonReturns one notification channel by id (nch_..., from notification_channels_list). The response has kind, name, target (a masked summary, secrets such as… - DELETEDelete a notification channel
/channels/:id.jsonDeletes a notification channel and removes it from every alert that used it, so those alerts stop notifying there. This cannot be undone and the alerts… - GETList notification channels
/workspaces/:workspace_id/channels.jsonLists the notification channels of a workspace (path takes workspace_id), sorted by name and paginated. A channel is a place alerts are delivered to. Each has… - POSTSend a test message through a channel
/channels/:id/send_test.jsonSends a real test message through the channel (an email, a chat post, a webhook call and so on), so only use it when the user wants that. The call fails with… - POSTUnsubscribe an address from one alert channel or uptime check with the token from an email
/notifications/unsubscribe/:token.json - POSTRegister a browser for push notifications
/push_subscription.jsonRegisters the current browser for web push alerts, using the three values from the browser's PushSubscription (endpoint, p256dh and auth). A subscription… - DELETERemove a browser push registration
/push_subscription.jsonRemoves one of the signed-in member's browser push registrations so that browser stops receiving alert notifications. Pass the same endpoint that was used…
Performance
- GETWeb Vitals: p75 scorecard, daily trend and breakdowns by page, device, browser and country
/sites/:site_id/performance.jsonWeb Vitals report from real visitors. Returns period, metric, sample_rate, scorecard, trend and breakdowns. scorecard has one row for each of LCP, INP, CLS,…
Plans
- GETList plans, prices and limits
/plans.jsonLists the public plans (free, pro, business and enterprise) with their limits and price tiers, so you can pick valid values for billing_checkout,…
Private feedback
- GETList the private feedback of a form, newest first
/sites/:site_id/testimonials/forms/:form_id/feedback.jsonPrivate feedback is an answer with a rating of 1 to 3 on a form with low-rating routing on (Business and up). It is never a testimonial, never public and… - POSTMark a private feedback answer as read, or as unread again
/sites/:site_id/testimonials/forms/:form_id/feedback/:id/mark_read.jsonSets read_at on one private feedback answer, or clears it with read false. Marking an answer that is already read keeps the time it was first read. Nothing is… - GETGet one private feedback answer
/sites/:site_id/testimonials/forms/:form_id/feedback/:id.jsonReturns the rating, the text, the name the person gave and when it was read. Private feedback is an answer with a low rating on a form with low-rating routing…
Removal requests
- POSTDismiss a removal request
/sites/:site_id/testimonials/removal_requests/:id/dismiss.jsonCloses the request with a note and leaves the testimonial where it is shown. Nothing is deleted and no email is sent to the person who asked. The note is… - GETList the removal requests of a site
/sites/:site_id/testimonials/removal_requests.jsonOpen requests unless another status is asked for. The email the giver typed is returned only to a caller who may change content. - POSTDecide a removal request
/sites/:site_id/testimonials/removal_requests/:id/resolve.jsontrash moves the testimonial to the trash, which takes it off every widget, wall and public page at once and can be undone for 30 days. dismiss leaves it… - GETGet one removal request
/sites/:site_id/testimonials/removal_requests/:id.jsonOne request with the testimonial it is about, the note the person left, whether the email they typed matches the email on the testimonial, how many times they…
Rewards
- POSTCopy a form's reward to other forms of the same site
/sites/:site_id/testimonials/settings/rewards/:id/copy.jsonCopies the title, the text, the code and the on or off state of this form's reward to each form in form_ids (1 to 100 forms of the same site, not in the… - GETList the reward of every form of a site
/sites/:site_id/testimonials/settings/rewards.jsonOne row per form. A form with no reward set has enabled false. - PATCHSet the reward a form shows on its thank-you step
/sites/:site_id/testimonials/settings/rewards/:id.jsonThe id is the form's id. The code is text you supply. Privatus Analytics does not create, check or expire it.
Roles
- GETList custom roles
/workspaces/:workspace_id/roles.jsonLists the custom roles of a workspace, ordered by name. Custom roles are a Business plan feature that bundle permissions under your own name, and the built-in… - POSTCreate a custom role
/workspaces/:workspace_id/roles.jsonCreates a custom role, a named set of permissions you can give to members through invitations_create or members_update with role custom and the role's id as… - DELETEDelete a custom role (must be unused)
/workspaces/:workspace_id/roles/:id.jsonDeletes a custom role. This cannot be undone and it fails while any member or pending invitation still uses the role, so move those people to another role… - PATCHUpdate a custom role
/workspaces/:workspace_id/roles/:id.jsonRenames a custom role and or replaces its whole permission list. Only the inputs you send change, and permissions replaces the existing list rather than…
SCIM
- GETList provisioned users
/scim/v2/Users.json - POSTProvision a user
/scim/v2/Users.json - GETGet a provisioned user
/scim/v2/Users/:id.json - DELETEDeprovision a user
/scim/v2/Users/:id.json - PATCHUpdate a user (PATCH active, name)
/scim/v2/Users/:id.json
SSO
- POSTActivate a tested SSO configuration
/workspaces/:workspace_id/sso/activate.jsonTurns SSO on for the workspace. The configuration must already have status tested, which happens after a successful trial login (started from the workspace… - POSTTurn SSO off (back to draft)
/workspaces/:workspace_id/sso/deactivate.jsonTurns SSO off by returning the configuration to draft and clearing enforced, so members go back to the workspace's other login methods. Provider details are… - POSTGenerate a new SCIM token (shown once)
/workspaces/:workspace_id/sso/scim_token.json - GETGet SSO settings
/workspaces/:workspace_id/sso.jsonReturns the workspace's single sign-on (SSO) configuration, or an empty draft when none exists. Fields are protocol (saml or oidc), status (draft, testing,… - PATCHCreate or update SSO settings
/workspaces/:workspace_id/sso.jsonCreates or edits the workspace's SSO settings. Business plan only. Only the inputs you send change. For SAML send protocol saml with idp_sso_url,…
Search
- GETSearch report: clicks, impressions, CTR, position, top queries/pages, landing pages and opportunities
/sites/:site_id/search.jsonSearch performance from Google Search Console and Bing Webmaster, joined to the site's own landing page metrics. Choose provider: all (the default) adds every… - DELETEDisconnect Search Console or Bing and delete its data
/sites/:site_id/search/connections/:provider.jsonDisconnects a search provider (google or bing) from a site and permanently deletes its imported search data for that provider. This cannot be undone. The… - POSTImport search data now
/sites/:site_id/search/sync.jsonQueues an immediate import of search data for a connected provider (google, the default, or bing) instead of waiting for the regular schedule. It returns…
Segments
- GETList segments you can use on a site
/sites/:site_id/segments.jsonLists the saved segments of a site, ordered by name: the shared ones plus your own private ones. Each segment has id (seg_...), site_id, name, description,… - POSTSave filters as a segment
/sites/:site_id/segments.jsonSaves a set of filters as a named segment that can be reused on any stats tool through segment_id. Pass name and filters (all conditions must match, and an… - GETGet a segment
/sites/:site_id/segments/:id.jsonReturns one saved segment: id (seg_...), site_id, name, description, filters (the stored conditions), summary (a plain English description such as Visitors… - DELETEDelete a segment
/sites/:site_id/segments/:id.jsonPermanently deletes a saved segment. Dashboards and links that use it fall back to all traffic. No analytics data is touched and there is no undo. Returns the… - PATCHRename a segment or change its filters or sharing
/sites/:site_id/segments/:id.jsonRenames a segment, replaces its filters or changes who can see it. Only the inputs you send change. Sending filters replaces all existing filters, in the same… - POSTDescribe filters in plain English and count the visitors they matched in the last 30 days
/sites/:site_id/segments/preview.jsonChecks a set of filters without saving anything. Returns summary (the filters in plain English), visitors (how many visitors matched in the last 30 days, null…
Sharing
- GETVisitor counter badge (SVG) for a public site
/badge/:site_id.json - DELETERevoke a share link
/sites/:site_id/shared_links/:id.jsonRevokes a share link right away, so its URL and embed code stop working for everyone. This cannot be undone and a revoked link cannot be restored, create a… - GETList share links
/sites/:site_id/shared_links.jsonLists the active (not revoked) share links of one site (path takes site_id), newest first, as a plain list with no pagination. Each link has id (shr_...),… - GETTop values of a shared dimension
/share/:token/breakdown/:dimension.jsonTop values of one dimension behind a share link, the shared equivalent of stats_breakdown. Path takes token (the last part of the share URL) and dimension,… - GETShared dashboard overview for a share token
/share/:token.jsonReads the dashboard behind a share link for people who have no account. The path token is the last part of a share URL (/share/<token>) and is the only…
Site audit
- GETList the issues of a site audit, one row per check
/sites/:site_id/audit/issues.jsonLists the issues of one audit, one row per check that flagged something, worst first (errors, then warnings, then notices, each by URLs affected). Each row… - GETGet one site audit check: why it matters, how to fix it and the affected URLs
/sites/:site_id/audit/issues/:check_key.jsonDetails of one check in an audit, by check_key from site_audit_issues_list (for example title_missing). Returns audit_id, issue (the same row as in the list),… - POSTMute a site audit check on several URLs, or several whole checks, in one call
/sites/:site_id/audit/mutes/bulk.jsonMutes many findings in one request, all or nothing. Use one of two shapes. Either send check_key plus urls (up to 100 URLs) to mute one check on several… - GETList the checks a site has muted
/sites/:site_id/audit/mutes.jsonLists the checks muted for the site, newest first. A mute hides a check either for the whole site (url is null) or for one URL, so those findings stay out of… - POSTMute a site audit check, for the whole site or one URL
/sites/:site_id/audit/mutes.jsonMutes one check for the site, or for one URL only. check_key comes from site_audit_issues_list. Leave url out to mute the check everywhere, or pass a full URL… - DELETEUnmute a site audit check
/sites/:site_id/audit/mutes/:id.jsonRemoves a mute, found by its id from site_audit_mutes_list, so the check or URL counts in the audit score again. The latest audit is recounted immediately.… - PATCHTurn your audit summary email for a site on or off
/sites/:site_id/audit/notifications.jsonTurns the weekly audit summary email on or off for the calling member on one site. It is a personal preference and does not affect other members. enabled true… - GETList and filter the pages of a site audit
/sites/:site_id/audit/pages.jsonThe page explorer, listing the URLs of one audit (the latest finished one by default, or audit_id). kind is page (default, HTML documents), resource (images,… - GETGet one audited page: its metadata, issues, links in and links out
/sites/:site_id/audit/pages/:id.jsonEverything the audit stored about one URL, by id (a UUID from site_audit_pages_list or from the urls of site_audit_issues_get). Returns id, audit_id,… - GETGet a site's audit settings
/sites/:site_id/audit/settings.jsonReturns the site's audit settings. Fields are site_id, enabled (scheduled audits on or off, on by default), include_subdomains, check_external_links,… - PATCHChange a site's audit settings
/sites/:site_id/audit/settings.jsonChanges how the site is audited. Only inputs you send change. enabled turns scheduled and manual audits on or off (turning it on schedules the next audit one… - POSTUnsubscribe from site audit summary emails with the token from an email
/audit/unsubscribe/:token.json - POSTCancel the site audit that is running
/sites/:site_id/audit/cancel.jsonStops the audit that is running or queued for the site. The audit is marked canceled and nothing from the unfinished crawl is reported. A canceled audit does… - GETCompare two site audits: URLs added and fixed per check
/sites/:site_id/audit/compare.jsonCompares two audits of the site, check by check. audit_id is the newer audit and base_id the older one. Both default sensibly (the latest finished audit… - GETGet the site audit overview: score, counts, top issues by traffic and the audit running now
/sites/:site_id/audit.jsonThe SEO site audit overview, the best first call for audit questions. By default it describes the latest finished audit, or pass audit_id (aud_..., from… - POSTStart a site audit now
/sites/:site_id/audit.jsonStarts a new crawl and SEO audit of the site now. It crawls the site's public pages in the background, so this returns immediately with the new audit in… - GETList a site's audits, newest first
/sites/:site_id/audit/history.jsonLists the site's audits, newest first, each with id (aud_...), status (queued, running, analyzing, complete, partial, failed or canceled), trigger (first,…
Sites
- POSTDelete all events and visits in a date range (runs in the background, cannot be undone)
/sites/:site_id/data_reset.jsonIrreversibly deletes a site's pageviews, custom events and visits for a date range, and cannot be undone. Use it to clear test traffic or remove a bad period.… - GETFiltered traffic summary: bots, traffic rules or PII redactions by reason and country (counts only)
/sites/:site_id/filter_stats.jsonCounts of hits that were dropped or cleaned before storage, over the last days. Use it to see how much bot traffic, rule-blocked traffic or redaction a site… - GETList members and whether they can see this site
/sites/:site_id/access.jsonShows which workspace members can see one site. Every member of the workspace is listed in join order, not paginated. Fields are membership_id (the uuid used… - PATCHGrant or remove one member's access to this site
/sites/:site_id/access.jsonGrants or removes one member's access to one site. membership_id comes from sites_access_list (or members_list) and access is true to grant or false to… - POSTStar a site (pinned first on All sites)
/sites/:site_id/favorite.jsonStars a site for the calling user so it is listed first by sites_list and on the All sites page. It only affects the caller, never other members, and starring… - DELETEUnstar a site
/sites/:site_id/favorite.jsonRemoves the calling user's star from a site, so it is no longer pinned first in sites_list. It only affects the caller and does nothing if the site was not… - GETInstallation status and snippet for a site
/sites/:site_id/setup.jsonReturns what is needed to install tracking on a site and whether data has arrived. Fields are site_id, snippet (the ready-to-paste HTML script tag with every… - POSTAccept a site transfer into one of your workspaces
/transfers/:token/accept.jsonAccepts a site transfer invitation and moves the site into one of the caller's workspaces. The token path parameter is from the invitation link, and… - POSTStart transferring a site to another workspace (emails the recipient)
/sites/:site_id/transfer.jsonStarts moving a site to another workspace by emailing the recipient an invitation link that is valid for 7 days. Nothing moves until the recipient signs in… - DELETECancel a pending site transfer
/sites/:site_id/transfer.jsonCancels the site's pending transfer invitation so its link stops working. It fails with a validation error when no transfer is pending. A transfer that was… - GETGet a pending transfer from its emailed token
/transfers/:token.jsonShows a site transfer invitation from the token in its link (the token path parameter, from the invitation email sent by sites_transfer_start). The caller… - GETList sites in a workspace
/workspaces/:workspace_id/sites.jsonLists the sites of a workspace that the caller can access, paginated, with the caller's starred sites first. Use query to search domain or name (partial,… - POSTAdd a site
/workspaces/:workspace_id/sites.jsonAdds a website to a workspace and returns it, including the tracking snippet to install. The workspace's plan limits the number of sites (Free allows 3) and… - GETGet a site and all its settings
/sites/:id.jsonReturns one site's settings and status by its public id (pa_..., from sites_list). Key fields are id, workspace_id (ws_...), domain, name, extra_domains and… - DELETEDelete a site (purged after 7 days)
/sites/:id.jsonDeletes a site. It is a soft delete, the site stops collecting and disappears from lists immediately, and its data is permanently purged after 7 days, so… - PATCHUpdate site settings
/sites/:id.jsonUpdates settings of a site, changing only the fields you send. Name and identity fields are name, domain (changing it re-checks the domain rating),…
Sponsor report
- GETA sponsor report, by its link's token
/sponsor/:token.json
Sponsor reports
- GETList a placement's sponsor report links
/sites/:site_id/experiments/ads/:ad_placement_id/reports.jsonThe links, with their address and when they expire. Requires analytics.read. - POSTCreate a sponsor report link for a placement
/sites/:site_id/experiments/ads/:ad_placement_id/reports.jsonA read-only link to the placement's numbers, for all of its creatives or the ones listed in creative_ids, for someone with no account. Over MCP the member is… - DELETEDelete a sponsor report link
/sites/:site_id/experiments/ads/:ad_placement_id/reports/:id.jsonThe address stops working at once. The MCP tool does not run it and responds with human_only and the page where a person deletes it. Requires content.write.
Status pages
- GETConfirm a subscription from the emailed link
/status/:slug/confirm/:token.json - GETPublic status page: current status, 90-day uptime bars, incidents and posts
/status/:slug.json - POSTSubscribe an email address (double opt-in)
/status/:slug/subscribers.jsonBrowser clients send a Cloudflare Turnstile token as cf-turnstile-response. Requests with an API token need none. - POSTUnsubscribe with the emailed token
/status/:slug/unsubscribe/:token.json - GETList posts on a status page
/status_pages/:status_page_id/posts.jsonLists the incident posts of a status page, newest first by posted_at. Use it to find a post id or see the incident history. Optionally filter by status… - POSTPost an incident update (emails subscribers)
/status_pages/:status_page_id/posts.jsonPublishes an incident update on a status page and, by default, emails its confirmed subscribers. Choose it to announce or update an incident, and use… - DELETEDelete a status page post
/status_pages/:status_page_id/posts/:id.jsonPermanently deletes an incident post from a status page. It disappears from the public page at once and this cannot be undone. No email is sent. The id comes… - PATCHEdit a status page post
/status_pages/:status_page_id/posts/:id.jsonEdits an incident post. Only the inputs you send change, so send just status to resolve an incident. Subscribers are emailed only when the status actually… - DELETERemove a subscriber
/status_pages/:status_page_id/subscribers/:id.jsonRemoves an email subscriber from a status page so they stop receiving incident and uptime emails. This cannot be undone, but the person can subscribe again on… - GETList subscribers of a status page
/status_pages/:status_page_id/subscribers.jsonLists the email subscribers of a status page, sorted by email. Use confirmed true to see only people who confirmed their address (only they receive emails) or… - GETList status pages
/workspaces/:workspace_id/status_pages.jsonLists the status pages of a workspace sorted by name. Use query to match part of a name or slug. When the caller is limited to some sites, only pages whose… - POSTCreate a status page
/workspaces/:workspace_id/status_pages.jsonCreates a public status page for a workspace that shows chosen uptime checks, incident posts and an email signup. Required is name (max 100 characters). slug… - GETGet a status page
/status_pages/:id.jsonReturns one status page with its settings. Fields are id (sp_...), workspace_id, name, slug, custom_domain (null when none), description, logo_url,… - DELETEDelete a status page
/status_pages/:id.jsonPermanently deletes a status page together with all its incident posts and subscribers. The public page and its custom domain stop working at once and this… - PATCHChange a status page
/status_pages/:id.jsonChanges a status page. Only the inputs you send change, so send just published false to take the page offline or check_ids to replace the shown checks (the…
Subscriptions
- DELETEDisconnect a payment provider and delete its key and subscription data
/sites/:site_id/subscriptions/connections/:provider.jsonDisconnects a payment provider (stripe, paddle, lemon_squeezy, chargebee or polar) from a site and permanently deletes the stored API key and every… - POSTRead subscriptions from a payment provider now
/sites/:site_id/subscriptions/sync.jsonQueues an immediate sync of subscriptions from one connected provider (stripe, paddle, lemon_squeezy, chargebee or polar) instead of waiting for the regular… - GETChurn cohort grid: churn or retention by month of first payment
/sites/:site_id/subscriptions/cohorts.jsonThe churn cohort grid for the site's subscriptions, one row per month of first payment. months is 6, 12 (default) or 24 cohorts. plan keeps only the…
Showing 300 of 400 endpoints. Fork the collection to see all of them.
API details
- Base URL
https://privatusanalytics.com- Authentication
- A bearer token in the Authorization header
- Operations
- 527 operations on 383 pathsGET 217POST 180DELETE 71PATCH 59
- Main resources
- Testimonials 22Site audit 17Sites 16Website 16Email reports 15Status pages 15Billing 14Campaigns 14Testimonial requests 14Analytics 11
- Response formats
application/json- Description format
- OpenAPI 3.1.0, API version
1.0.0 - Links
- OpenAPI document
How to test the Privatus Analytics API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Privatus Analytics API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List API tokens” (GET /workspaces/:workspace_id/api_tokens.json), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Privatus Analytics API?
Every page in Privatus Analytics is also an API endpoint: add .json to the URL and send an API token as a Bearer token. Most of them are MCP tools too. It is listed under Finance & banking and has 527 endpoints.
Who publishes the Privatus Analytics API?
It is listed from Privatus Analytics's public API description (an OpenAPI document), not published by Privatus Analytics on Swastik Codes. Anyone who controls privatusanalytics.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Privatus Analytics API?
Requests go to https://privatusanalytics.com. Endpoint paths are added to this base URL.
How do I authenticate with the Privatus Analytics API?
With A bearer token in the Authorization header.
How many endpoints does the Privatus Analytics API have?
527 operations on 383 paths (217 GET, 180 POST, 71 DELETE, 59 PATCH). The largest groups are Testimonials, Site audit, Sites, Website. This listing's collection holds the first 400.
Is forking the Privatus Analytics API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.