API reference

Analytics and discovery

Site analytics, tracked prompts, AI search readiness and watched questions.

Scopes for this area: analytics:read, analytics:write and analytics:admin.

70 operations

site projects

MethodRouteWhat it doesLevelCommand
GET/analytics/site/projectsThe hosted sites that have analytics, with their hostnames.readrivier analytics site projects list

site overview

MethodRouteWhat it doesLevelCommand
GET/analytics/site/overviewVisits, people, sources, pages, countries, devices and browsers for a period, with the change on the period before and the words that describe it. Small groups are merged into Other.readrivier analytics site overview get

site conversions

MethodRouteWhat it doesLevelCommand
GET/analytics/site/conversionsForms, bookings, orders, reviews and chats that happened, by where the visitor came from and by product, room or article.readrivier analytics site conversions get

site goals

MethodRouteWhat it doesLevelCommand
GET/analytics/site/goalsGoals: pages reached, events and outcomes, with how often and what they were worth.readrivier analytics site goals get

site cohorts

MethodRouteWhat it doesLevelCommand
GET/analytics/site/cohortsWeekly cohorts of visitors who agreed to recognition and how many came back; small cohorts are left out.readrivier analytics site cohorts get

site funnels

MethodRouteWhat it doesLevelCommand
GET/analytics/site/funnelsThe enquiry, booking and order steps: how many reached each step.readrivier analytics site funnels get

site ai

MethodRouteWhat it doesLevelCommand
GET/analytics/site/aiVisits that arrived from AI answers, pages AI answer engines fetched, and what those visits led to.readrivier analytics site ai get

site speed

MethodRouteWhat it doesLevelCommand
GET/analytics/site/speedHow fast pages feel for real visits, in words, from anonymous samples.readrivier analytics site speed get

site fixes

MethodRouteWhat it doesLevelCommand
GET/analytics/site/fixesThings to fix: broken links, slow pages and regions whose rule waits for a review.readrivier analytics site fixes list

site explain

MethodRouteWhat it doesLevelCommand
GET/analytics/site/explainWhy a number changed: ranked causes computed from the counters and from what happened to the site, each with its evidence, and what stays uncertain.readrivier analytics site explain get

site collected

MethodRouteWhat it doesLevelCommand
GET/analytics/site/collectedWhat the site counts and why, region by region, with the rule's status. Guidance, not legal advice.readrivier analytics site collected get

site review

MethodRouteWhat it doesLevelCommand
GET/analytics/site/reviewRegions the site gets visits from and whether each uses a cautious setting because its rule is unconfirmed, stale or under review.readrivier analytics site review get

site processing

MethodRouteWhat it doesLevelCommand
GET/analytics/site/processingThe record-of-processing entry for site analytics.readrivier analytics site processing get

site settings

MethodRouteWhat it doesLevelCommand
GET/analytics/site/settingsThe analytics settings of a site: mode, signals, thresholds, funnels, data region.readrivier analytics site settings get
PUT/analytics/site/settingsChange the analytics settings of a site. Anything that collects more is a person's decision and an agent is refused.writerivier analytics site settings update

site evidence

MethodRouteWhat it doesLevelCommand
GET/analytics/site/evidenceEvidence rows: when the daily secret was destroyed and what each retention run removed.readrivier analytics site evidence list

site share

MethodRouteWhat it doesLevelCommand
GET/analytics/site/sharesRead-only links to the numbers that have been shared.readrivier analytics site share list
POST/analytics/site/sharesMake a read-only link to the numbers of a site. The link is shown once. A person's decision.writerivier analytics site share create
POST/analytics/site/shares/removeRemove a shared link.writerivier analytics site share remove

site import

MethodRouteWhat it doesLevelCommand
POST/analytics/site/importBring in daily page-view totals from another tool for days before today that have nothing counted here.writerivier analytics site import run

site retention

MethodRouteWhat it doesLevelCommand
POST/analytics/site/retention/runRun the retention schedule now: remove what has outlived it and record the evidence.writerivier analytics site retention run

site transaction

MethodRouteWhat it doesLevelCommand
POST/analytics/site/transactionsRecord an outcome from the project's own records (a form, booking, order, review or chat) with the source class that travelled with it. Used by the modules that hold those records.writerivier analytics site transaction record

business model

MethodRouteWhat it doesLevelCommand
GET/business-modelThe maintained model of how the business behaves: what is on record, the weekly series fitted with their expected course and band, when it last changed and when it was last checked.readrivier analytics business model get
POST/business-model/refreshBring the business model up to date with the project's records now.writerivier analytics business model refresh

whatif

MethodRouteWhat it doesLevelCommand
POST/whatifTry a decision in simulation before making it: a question and two or three options, run on the same seeds.writerivier analytics whatif start
GET/whatifThe what-if runs of the project, newest first.readrivier analytics whatif list
GET/whatif/{id}One what-if: each option's share holding at the end with its spread across seeds, and which option is clearly ahead, if any.readrivier analytics whatif get
POST/whatif/{id}/decideRecord which option a person will go with, or none. It does not carry the option out.writerivier analytics whatif decide

predictions

MethodRouteWhat it doesLevelCommand
POST/predictions/runScore current leads or bookings from the project's own historywriterivier analytics predictions run

insights

MethodRouteWhat it doesLevelCommand
GET/predictions/insightsPrediction insights, highest likelihood firstreadrivier analytics insights list
POST/predictions/insights/{id}/decideA person keeps or sets aside an insightwriterivier analytics insights decide

analysis

MethodRouteWhat it doesLevelCommand
GET/workspace/analysisHow the business is doing.readrivier analytics analysis get
GET/workspace/analysis/forecastThe forecast.readrivier analytics analysis forecast

client

MethodRouteWhat it doesLevelCommand
GET/workspace/analytics/clientsTracked sites and their tags.readrivier analytics client list
POST/workspace/analytics/clientsTrack a site.writerivier analytics client create
DELETE/workspace/analytics/clients/{clientId}Stop tracking a site.writerivier analytics client delete

geo

MethodRouteWhat it doesLevelCommand
POST/geo/auditScore a page's readiness for AI search.writerivier analytics geo audit
POST/geo/metadataGenerate metadata for AI discovery.writerivier analytics geo metadata
POST/geo/simulateSimulate how answer engines would see a page.writerivier analytics geo simulate
POST/geo/discovery/submitSubmit a site for discovery.writerivier analytics geo submit
GET/geo/forecastForecast of AI traffic.readrivier analytics geo forecast
GET/geo/recommendationsWhat to change to be cited more.readrivier analytics geo recommendations
GET/geo/geographyWhere AI traffic comes from.readrivier analytics geo geography
GET/geo/geography.csvThe geography as CSV.readrivier analytics geo geography csv
GET/geo/answer-lossWhere answers cite competitors instead.readrivier analytics geo answer loss
GET/geo/citation-verificationWhether cited claims are verified.readrivier analytics geo citations
GET/geo/trackerTracked prompts and their standing.readrivier analytics geo tracker

telemetry

MethodRouteWhat it doesLevelCommand
GET/geo/telemetryAI crawler visits to a site.readrivier analytics telemetry get
GET/geo/telemetry.csvThe visits as CSV.readrivier analytics telemetry csv

connector

MethodRouteWhat it doesLevelCommand
GET/geo/connectorsCrawler-capture connections.readrivier analytics connector list
POST/geo/connectors/cloudflareConnect Cloudflare for crawler capture.writerivier analytics connector connect
GET/geo/connectors/cloudflare/authorizeBegin connecting Cloudflare by sign-in.readrivier analytics connector authorize
DELETE/geo/connectors/{id}Remove a crawler-capture connection.writerivier analytics connector remove

monitor

MethodRouteWhat it doesLevelCommand
GET/monitorWatched questions.readrivier analytics monitor list
POST/monitorWatch a question and be told when its answer changes.writerivier analytics monitor create
GET/monitor/{id}One watched question.readrivier analytics monitor get
DELETE/monitor/{id}Stop watching.writerivier analytics monitor delete

prompt

MethodRouteWhat it doesLevelCommand
GET/prompt-setsPrompt sets tracked across answer engines.readrivier analytics prompt sets
POST/prompt-setsCreate a prompt set.writerivier analytics prompt create set
DELETE/prompt-sets/{id}Delete a prompt set.writerivier analytics prompt delete set
GET/prompt-sets/{id}/promptsThe prompts of a set.readrivier analytics prompt list
POST/prompt-sets/{id}/promptsAdd a prompt.writerivier analytics prompt add
GET/prompt-sets/{id}/suggestionsSuggested prompts for a set.readrivier analytics prompt suggest
DELETE/prompts/{id}Delete a prompt.writerivier analytics prompt delete
GET/prompt-runsPrompt run results.readrivier analytics prompt runs
GET/prompt-runs.csvThe runs as CSV.readrivier analytics prompt runs csv
GET/prompt-gapsPrompts where the business is not cited.readrivier analytics prompt gaps
GET/prompt-gaps.csvThe gaps as CSV.readrivier analytics prompt gaps csv
GET/prompt-sentimentHow answers describe the business.readrivier analytics prompt sentiment
GET/prompt-sentiment.csvThe sentiment as CSV.readrivier analytics prompt sentiment csv