Dok.
Bla i dokumentasjonen

Analytics REST API

The Privatus Analytics REST API: add .json to any app URL and send a token. Conventions and a reference of every operation, generated from the code.

Vis som Markdown

Every page and action in Privatus Analytics is also an API endpoint (only form pages such as new and edit have no JSON form). There's no separate /api/v1: add .json to a URL and send an API token.

sh
curl https://privatusanalytics.com/sites/pa_7Q2K9XH3AB/stats/aggregate.json?period=7d \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
json
{
  "data": {
    "period": { "from": "2026-09-23T00:00:00Z", "to": "2026-09-30T00:00:00Z" },
    "metrics": {
      "visitors": 1840, "visits": 2310, "pageviews": 5122,
      "views_per_visit": 2.22, "bounce_rate": 41.3,
      "visit_duration": 48000, "revenue": 129900
    }
  }
}

The reference below lists every operation with its method, path, permission, input schema and response schema. It's generated from the running code, as is the OpenAPI 3.1 document, so neither can drift from what the server does. The same operations are MCP tools.

Conventions#

Base URL https://privatusanalytics.com
Format JSON. Add .json to the path (or send Accept: application/json)
Auth Authorization: Bearer pat_… (Authentication)
Ids Public ids with a prefix: ws_… workspaces, pa_… sites, goal_… goals, seg_… segments, wh_… webhooks
Reads GET with query parameters
Writes POST, PATCH, DELETE with a JSON body of flat fields
Success { "data": … }, plus "meta" for lists
Errors { "error": { "code", "message", "details" } } (Errors)
Lists page and per_page (max 100) (Pagination)
Times ISO 8601 in UTC. Date parameters (from, to) are days in the site's timezone
Money Minor units (cents) in the site currency, e.g. revenue: 129900 = 1,299.00
Durations Milliseconds

Common tasks#

Task Operation
List workspaces GET /workspaces.json
List sites GET /workspaces/{workspace_id}/sites.json
Headline metrics GET /sites/{site_id}/stats/aggregate.json
Chart data GET /sites/{site_id}/stats/timeseries.json
Top pages, sources, countries… GET /sites/{site_id}/breakdown/{dimension}.json
Everything on the Overview GET /sites/{site_id}/overview.json
Live visitors GET /sites/{site_id}/live.json
Add a note (e.g. a deploy) POST /sites/{site_id}/notes.json

See Stats endpoints and Examples.

In this section#

Authentication · Errors · Pagination · Rate limits · Filters · Stats endpoints · Examples · Webhooks · Changelog and deprecation

Alle operasjoner

Autentisering

Send Authorization: Bearer pat_…. Opprett tokener under Arbeidsområdeinnstillinger, API-tokener. Autentiseringsguide.

JSON overalt

Legg til .json på en hvilken som helst sti. Svar er { "data": … } og feil er { "error": { "code", "message" } }. Feil.

MCP

Send JSON-RPC med POST til https://privatusanalytics.com/mcp med det samme tokenet. Hver operasjon nedenfor er et verktøy. MCP-guide.

Last ned openapi.json · 527 operasjoner

API-tokener

POST /workspaces/:workspace_id/api_tokens.json Opprett et API-token (tokenet vises bare én gang) api_tokens_create

Oppretter et API-token for medlemmet som kaller i et arbeidsområde, og returnerer hemmeligheten nøyaktig én gang i feltet token. Kopier den med en gang, den kan ikke leses igjen, og et token som er mistet må tilbakekalles og opprettes på nytt. Et token kan bare begrense hva medlemmet kan gjøre. permissions er som standard alle medlemmets egne tillatelser når feltet utelates (en eksplisitt tom liste avvises, og å be om en tillatelse du ikke har er en feil). site_ids tar offentlige nettsted-ID-er (pa_...) og begrenser tokenet til disse nettstedene. Når listen er tom, fungerer tokenet for alle nettsteder medlemmet har tilgang til (eller beholder nettstedslisten til tokenet som utfører dette kallet). expires_at er valgfri ISO 8601, må ligge i fremtiden og høyst 3 år frem i tid. Utelat den for et token som aldri utløper. allowed_ips begrenser tokenet til disse IP-ene eller CIDR-områdene. Et token som utfører dette kallet trenger tokens.manage. Et arbeidsområde som krever tofaktorautentisering avviser token for medlemmer uten egen andre faktor. Returnerer de samme feltene som api_tokens_list pluss token.

Tillatelse: member · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/api_tokens.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /workspaces/:workspace_id/api_tokens/:id.json Tilbakekall et API-token api_tokens_delete

Tilbakekaller et API-token umiddelbart og permanent. Forespørsler som bruker det, feiler fra da av, og et tilbakekalt token kan ikke gjenopprettes. Opprett et nytt i stedet. Tokenposten blir stående i listen med status revoked (bruk api_tokens_list med include_revoked for å se den), og å tilbakekalle et token som allerede er tilbakekalt, endrer ingenting. Hent id-en (en uuid) fra api_tokens_list. Du kan tilbakekalle dine egne token, å tilbakekalle andres krever tokens.manage og tilgang til alle nettsteder tokenet dekker. Et token som kaller dette trenger tokens.manage. Returnerer det tilbakekalte tokenet uten hemmeligheten.

Tillatelse: member · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/workspaces/:workspace_id/api_tokens/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/api_tokens.json List API-tokener api_tokens_list

Lister API-tokenene i et arbeidsområde, nyeste først og med sideinndeling. Uten tillatelsen tokens.manage ser du bare dine egne token, med den ser du alle medlemmers. Tilbakekalte og utløpte token skjules med mindre include_revoked er true. Hvert element har id (uuid, brukes av api_tokens_delete), name, token_prefix (de første tegnene, for å gjenkjenne et token), owner (medlemmets e-post), permissions (navn som analytics.read), site_ids (offentlige nettsted-ID-er pa_..., en tom matrise betyr alle nettsteder eieren har tilgang til), allowed_ips, oauth_client (navnet på den tilkoblede appen når tokenet ble utstedt via OAuth, ellers null), status (active, expired eller revoked), expires_at, last_used_at, revoked_at og created_at. Selve hemmeligheten returneres aldri her, token er alltid null i en liste. Den vises bare én gang av api_tokens_create.

Tillatelse: member

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/api_tokens.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Abonnementer

DELETE /sites/:site_id/subscriptions/connections/:provider.json Koble fra en betalingsleverandør og slett nøkkelen og abonnementsdataene subscriptions_disconnect

Kobler en betalingsleverandør (stripe, paddle, lemon_squeezy, chargebee eller polar) fra et nettsted og sletter den lagrede API-nøkkelen og alle abonnementsrader lest fra den permanent. Dette kan ikke angres, og tall for MRR, frafall og kohorter mister den leverandørens abonnementer umiddelbart. Feiler hvis den leverandøren ikke er tilkoblet. Returnerer den fjernede tilkoblingen. Trenger sites.manage.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/subscriptions/connections/:provider.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/subscriptions/sync.json Les abonnementer fra en betalingsleverandør nå subscriptions_sync

Setter en umiddelbar synkronisering av abonnementer fra én tilkoblet leverandør (stripe, paddle, lemon_squeezy, chargebee eller polar) i kø i stedet for å vente på den vanlige tidsplanen. Den returnerer med en gang (HTTP 202) med tilkoblingen, og synkroniseringen kjører i bakgrunnen. Spør subscriptions_report gjentatte ganger eller sjekk last_synced_at og last_error på tilkoblingen. Rapporter bufres i opptil 15 minutter. Feiler hvis leverandøren ikke er tilkoblet. Trenger sites.manage.

Tillatelse: sites.manage

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/subscriptions/sync.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/subscriptions/cohorts.json Kohortrutenett: frafall eller lojalitet etter måned for første betaling subscriptions_cohorts

Kohortrutenettet for frafall for nettstedets abonnementer, én rad per måned for første betaling. months er 6, 12 (standard) eller 24 kohorter. plan beholder bare abonnementene på én plan (se plans i subscriptions_report). metric er subscriptions (antall) eller mrr (penger). view er churn (andelen som hadde sluttet på det tidspunktet, standard) eller retention (andelen som fortsatt løper). Returnerer metric, view, months, plan (filteret, eller null), currency og cohorts, hver med month (YYYY-MM), size (abonnementer, eller MRR i minste enheter av nettstedets valuta) og cells, der hver celle har offset (måneder siden kohortmåneden, 0 er den første), retained (samme enhet som size) og percent (0 til 100, null for en tom kohort). Prøveperioder som aldri ble betalt, er ikke med i noen kohort. For hovedtall for MRR, ARR og frafall, bruk subscriptions_report. Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/subscriptions/cohorts.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/subscriptions.json Abonnementstall: MRR, ARR, MRR-bevegelser, frafall, inntektsbeholdning, prøveperioder, planer og en prognose subscriptions_report

Abonnementsmetrikker for nettstedet, lest fra den tilkoblede Stripe-, Paddle-, Lemon Squeezy-, Chargebee- eller Polar-kontoen. months er 6, 12 (standard) eller 24. plan beholder bare abonnementene på én plan, med navnet slik plans viser det. Pengefelter er heltall i minste enheter av nettstedets valuta (valutaen i svaret), og andre valutaer er omregnet til dagens kurs. Resultatet har currency, connected (false når ingen leverandør er tilkoblet), plan (plan-filteret, eller null), connections (én per tilkoblet leverandør med provider, account_name, sandbox, status, last_error, last_synced_at og created_at, aldri en nøkkel), skipped_currencies (valutaer uten kurs, hvis penger ikke telles), totals, series, forecast og plans. totals har mrr_minor, arr_minor, previous_mrr_minor (MRR for 30 dager siden), active_subscriptions, arpa_minor (null uten abonnementer), trialing, trial_conversion_rate (prosent av prøveperioder som tok slutt de siste 90 dagene og ble betalt, null når ingen tok slutt), og for de siste 30 dagene new_subscriptions, new_mrr_minor, expansion_mrr_minor, contraction_mrr_minor, churned_subscriptions, churned_mrr_minor, net_new_mrr_minor, quick_ratio (ny pluss utvidet MRR for hver enhet avsluttet pluss redusert MRR, null når ingenting gikk tapt), subscription_churn_rate og mrr_churn_rate (prosent, null uten grunnlag). Den har også net_revenue_retention og gross_revenue_retention (prosent av det abonnementene som betalte for 12 måneder siden betalte da, som de betaler nå, med og uten oppgraderinger, null uten grunnlag) og forecast_mrr_minor (MRR om 12 måneder, null uten prognose). series har én rad per måned (month som YYYY-MM) med mrr_minor, active_subscriptions, de samme bevegelsesfeltene og churn_rate. forecast har én rad per måned for de neste 12 månedene (month, mrr_minor), framskrevet fra de tre siste hele månedene, og er tom uten tre hele måneder som startet med MRR. plans lister opptil 50 planer etter MRR med plan (null for abonnementer som leverandøren ikke ga noe plannavn), mrr_minor, active_subscriptions, churned_subscriptions og subscription_churn_rate (siste 30 dager), alltid for hver plan. Et abonnement teller fra første betaling. Oppgraderinger og nedgraderinger er kjent fra første synkronisering, og før det bruker tidligere måneder prisen et abonnement hadde da det først ble lest. For beholdning etter måned for første betaling, bruk subscriptions_cohorts. Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/subscriptions.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Affiliateprogram

GET /account/affiliate/commissions.json List opp affiliateprovisjonene dine affiliate_commissions_list

Provisjoner, tilbakeføringer etter refusjon eller chargeback og reverseringer, nyeste først. Beløp er i cent.

Tillatelse: member

Eksempel
curl https://privatusanalytics.com/account/affiliate/commissions.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /account/affiliate/signup-box.json Hent koden og resultatene for registreringsboksen din som affiliate affiliate_signup_box_get

Innbyggingskoden for registreringsboksen din (et skript og en enkel iframe) for valgt tema, attributtene som forhåndsutfyller skjemaet, hendelsene skriptet sender på siden din, og tallene for boksen: registreringer som venter på bekreftelse, bekreftede registreringer og betalende kunder. available er false til affiliatesøknaden din er godkjent.

Tillatelse: member

Eksempel
curl https://privatusanalytics.com/account/affiliate/signup-box.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /account/affiliate.json Hent affiliatestatusen din, henvisningslenken og statistikk affiliate_get

Statusen for affiliatesøknaden din, henvisningslenken, registreringer og betalende kunder du har henvist, og saldo per valuta (på vent, kan utbetales, utbetalt). status er none når du ikke har søkt.

Tillatelse: member

Eksempel
curl https://privatusanalytics.com/account/affiliate.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Analyse

GET /sites/:site_id/clicks.json Klikkart: de mest klikkede elementene på nettstedet, eller på én side, med andelen av besøkene på siden som klikket på hvert element clicks_list

Klikk per element fra klikkmodulen i sporeren. Et element er en kort CSS-velger (tagg, id og opptil to klasser, på høyst fire nivåer), eller [data-privatus-click="name"] når nettstedet har gitt det et navn. Send path (begynner med en skråstrek, slik den er lagret) for én side: da er elements {selector, clicks, visits, visit_share}, og page_visits er antall besøk som så siden. visit_share er prosenten av dem (0 til 100) som klikket på elementet. Uten path er elements {path, selector, clicks, visits} for hele nettstedet. visits teller besøk som klikket minst én gang. Returnerer period, path, page_visits og elements, med det mest klikkede først. Ingen tekst på elementer, ingen koordinater og ingen musebevegelser blir noen gang samlet inn. Bruk pages_detail for resten av en side.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/clicks.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/overview.json Nettstedsoversikt: målinger, diagramserier, toppanel, besøkende nå og notater stats_overview

Ett kall som returnerer alt oversiktssiden for nettstedet viser: bruk det til å svare på et bredt spørsmål som hvordan det går med et nettsted, i stedet for å kalle flere verktøy. Returnerer period, metrics (visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration, revenue), interval, series (ett element per tidsintervall), panels, notes og live_visitors. Med compare legger det til comparison_period, comparison, change og comparison_series, som i stats_aggregate og stats_timeseries. Enhetene er de samme som i disse verktøyene: bounce_rate er en prosent fra 0 til 100, visit_duration er median engasjert tid i millisekunder, revenue er et heltall i minste enheter (cent). panels er et objekt med dimensjonsnavn som nøkler, hver med de 10 øverste radene og andelen deres, i samme radform som stats_breakdown for den dimensjonen. Som standard returnerer det channel, referrer, page, entry_page, country, device, browser, os, utm_campaign, event og goal. Send panels for å velge andre dimensjoner (alle dimensjonsnavn unntatt prop-nøkler). notes lister merknader i perioden som {id, date, end_date, title, url, color}. live_visitors teller besøkende de siste 5 minuttene. For mer enn 10 rader av en dimensjon, bruk stats_breakdown, og for ett enkelt tall, bruk stats_aggregate. Tar de felles inputene period, compare, filters og segment.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/overview.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/experiments/external.json Eksperimentrapport: konverteringsrate per variant, forbedring mot kontroll og signifikans (to-proporsjons z-test) experiments_report

Rapporterer en A/B-test ved hjelp av hendelsesdata. Besøk tildeles varianten som finnes i en hendelsesegenskap (den første verdien sett i besøket, for eksempel egenskapen variant med verdiene control og b), og en konvertering er et besøk som fullførte et mål. Påkrevde inputer er property (liten bokstav, opptil 64 tegn) og goal_id (et aktivt mål, fra goals_list). Returnerer period, property, goal {id, name}, control, confidence (0.95) og variants. Hver variant har visits, conversions, conversion_rate (prosent, 0 til 100), control (true for grunnlinjen), uplift (prosentvis endring i konverteringsraten mot kontrollen, null for kontrollen eller når kontrollens rate er 0), z, p_value og significant (true når p_value er under 0.05, med en z-test for to proporsjoner). Kontrollen er varianten du sender i control, ellers en som heter control, ellers varianten med flest besøk. Maksimalt 20 varianter, de travleste først. Sørg først for at nettstedet sender varianten som en hendelsesegenskap. Tar de felles inputene period og filters. For en vanlig målkonverteringsrate, bruk goals_get. Krever planen Business eller Enterprise (ellers 402 plan_limit).

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/experiments/external.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/insights.json Merkbare endringer mot forrige periode, på vanlig språk (største endringer, endringer i målkonvertering) insights_get

Merkbare endringer for et nettsted i klartekst, sammenlignet med forrige periode av samme lengde. Returnerer period, comparison_period og insights. Perioden dekker hele dager til og med i går, valgt med period (7d, 14d, 28d eller 30d, standard 7d). Hver innsikt har dimension (total, channel, page, country eller goal), metric, value, previous, current, change og sentence. change er en prosent for antall og prosentpoeng for målkonverteringsrate, og sentence er en ferdig lesbar setning på engelsk. Det omfatter totalt antall besøkende og sidevisninger, de to største endringene per dimensjon (endringer på 20 prosent eller mer med minst 10 besøk eller visninger) og mål der konverteringsraten endret seg med et halvt poeng eller mer. Viktigst først, begrenset av limit (standard 8, maks 20). Resultatene beholdes for dagen. For eksakte tall, bruk stats_aggregate og stats_breakdown, og bruk denne for å finne ut hva som har endret seg.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/insights.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/journeys.json Reiser: de 3-trinns stiene som oftest følger etter en side (eller et hvilket som helst inngangspunkt), eller som går før en side eller et mål journeys_explore

Utforsker de vanligste sidestiene i tre trinn inni besøk. I forward-modus (standard) viser den stiene etter en startside oppgitt i path, eller etter en hvilken som helst inngang når path er tom. I reverse-modus viser den stiene som fører til en sluttside (path) eller til et mål (goal_id, som bytter til reverse automatisk). reverse trenger path eller goal_id. path må begynne med en skråstrek. Returnerer period, mode, path, goal, sampled, sample_rate (prosent), total_visits og stigrafen med nodes og links per trinn, begrenset til limit sider per trinn (2 til 12, standard 6). Over 100 000 besøk utvalgsprøves dataene. Sidefiltre ignoreres fordi de ville kuttet stiene. Stiene bygges per besøk, siden ingen besøkende-ID lagres. Tar de felles inputene period, filters og segment. For én sides naboer, bruk pages_detail, og for trinnkonvertering, bruk funnels_get.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/journeys.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/pages/detail.json Sidedetaljer: målinger, forrige og neste sider, kilder, Web Vitals, hendelser og klikkart for én sti pages_detail

Én side i dybden. Send path (må begynne med en skråstrek, for eksempel /pricing), nøyaktig slik den er lagret (uten spørrestreng eller vert). Returnerer period, path, url, metrics, previous_pages, next_pages, sources, vitals, events, clicks, goals og notes. metrics har visitors, visits, pageviews, entrances, exits, entry_rate, exit_rate og bounce_rate (prosent, 0 til 100), time_on_page (median millisekunder) og scroll_depth (median prosent), de to siste er null uten engasjementsdata. previous_pages og next_pages er sidene sett før og etter i samme besøk, som {value, count, share}, med (entrance) og (exit) som spesialverdier. sources har de øverste kanalene og henviserne for besøk som kom inn på denne siden. vitals har p75-verdier per Web Vital med vurderinger. events er egendefinerte hendelser utløst på siden, clicks er de mest klikkede elementvelgerne, goals er mål fullført på den og notes er merknader som nevner den. Bruk stats_breakdown med dimension page for å rangere sider og referrers_detail for et henvisende nettsted.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/pages/detail.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/referrers.json Henvisere: nettstedene som lenker til dette nettstedet, med besøkende, engasjement, trafikktype og antall lenkende sider referrers_list

Rangerer de eksterne nettstedene som sendte besøkende, med det hvert av dem sendte. Direktebesøk (uten henviser) utelates. Returnerer period, summary, channels, page, limit, has_more og rows. summary har visitors, visits, pageviews, bounce_rate (prosent), visit_duration (median engasjerte millisekunder), revenue (minste enheter, cent), sites (antall henvisende nettsteder) og share (prosent av alle besøk som kom fra henvisere). channels viser typene trafikk som {value, visitors, visits}. Hver rad har value (henviserverten), visitors, visits, pageviews, bounce_rate, visit_duration, revenue, channel (vanlig kanal), linking_pages (hvor mange ulike sider på det nettstedet som lenker hit) og share (prosent av henviste besøkende). Sorter med sort (visitors, visits, pageviews eller revenue, standard visitors), avgrens med search (tekst som finnes i verten), og blar med page og limit (maks 100) så lenge has_more er true. Bruk referrers_detail for ett nettsted. Tar de felles inputene period, compare, filters og segment.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/referrers.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/referrers/detail.json Henvisningsdetaljer: nøkkeltall og trend for ett henvisende nettsted, dets lenkende sider, landingssider, land, enheter, kampanjer og konverteringer referrers_detail

Ett henvisende nettsted i dybden. Send referrer som verten uten www og uten sti (for eksempel news.ycombinator.com), samme verdi som i referrers_list. Returnerer period, referrer, url, channel (den vanligste kanalen), metrics, share (prosent av alle besøk), interval, series (trafikken over tid), linking_pages, landing_pages, channels, countries, devices, campaigns, goals og, med compare, comparison, change og comparison_series. metrics og series bruker samme felter og enheter som stats_aggregate og stats_timeseries. linking_pages er henviserens sider som sendte besøkende, som rader med path, url, visitors og share (spørrestrenger lagres aldri). landing_pages er der de besøkende kom inn. channels, countries, devices og campaigns er toppverdier med metrikker, og goals lister mål de fullførte med conversions og conversion_rate. Bruk referrers_list for å rangere henvisende nettsteder og stats_breakdown med dimension referrer for en enkel liste.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/referrers/detail.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/stats/aggregate.json Hovedmålinger for en periode (med sammenligning) stats_aggregate

Hovedtall for én periode, som ett objekt. Returnerer period {from, to} og metrics {visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration, revenue}. Med compare returnerer det også comparison_period, comparison (de samme metrikkene for det andre tidsrommet) og change (prosentvis endring per metrikk, null når den tidligere verdien var 0). Enheter: bounce_rate er en prosent fra 0 til 100 (10.9 betyr 10,9 %). visit_duration er median engasjert tid i et besøk i millisekunder. revenue er et heltall i minste enheter (cent) i nettstedets valuta. views_per_visit er et desimaltall. Besøkende telles per dag fordi ingen vedvarende besøkende-ID lagres, så den som kommer tilbake en annen dag, telles på nytt. Bruk denne for totaler og endring fra periode til periode. Bruk stats_timeseries for et diagram over tid, stats_breakdown for toppverdier av en dimensjon og stats_overview for alt i ett kall. Avgrens alle med filters (se filters for dimensjonsnavn og operatorer).

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/stats/aggregate.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/breakdown/:dimension.json De øverste verdiene for en dimensjon (sider, kilder, land …) stats_breakdown

Toppverdier for én dimensjon med metrikkene deres, viktigste først og med sideinndeling. Dimensjonen er siste del av banen og må være et eksakt navn fra beskrivelsen (for eksempel country, page, channel, utm_campaign, prop:plan). Returnerer period, dimension, label, page, limit, has_more og rows. Be om neste side så lenge has_more er true. Hver rad har value og share (prosent av periodens total). De andre feltene i en rad avhenger av dimensjonen. Besøksdimensjoner (channel, referrer, referrer_url, utm_*, ref, hostname, country, language, device, browser, browser_version, os, os_version, screen, entry_page, exit_page, interaction, bot_score) gir visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration og revenue. page gir pageviews, visits, time_on_page (millisekunder) og scroll_depth (prosent), uten visitors. event og prop:<key> gir completions, visits, revenue og conversion_rate. goal gir goal_id, completions, conversions, conversion_rate og revenue. Enheter: bounce_rate og conversion_rate er prosent (0 til 100), varigheter er millisekunder, revenue er i minste enheter (cent). En feil dimensjon gir en 422 som lister de gyldige navnene. Bruk search for å lete etter en verdi i alle rader, og filters for å avgrense dataene først (for eksempel sider besøkt av ett land). For én side eller én henviser i dybden, bruk pages_detail eller referrers_detail. Dimensjonene interaction og bot_score krever planen Business eller Enterprise: som oppdeling svarer de med 402 plan_limit på andre planer, og et filter på en av dem utelates.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/breakdown/:dimension.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/stats/timeseries.json Målinger per tidsintervall for diagrammer stats_timeseries

Metrikker per tidsintervall, for diagrammer og trender. Returnerer period, interval (intervallet som faktisk ble brukt) og series, en liste av {date, visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration, revenue}, ett element per intervall med date som ISO 8601-starten på intervallet. Med compare returnerer det også comparison_series for det andre tidsrommet, intervall for intervall. Enhetene er de samme som i stats_aggregate: bounce_rate er en prosent (0 til 100), visit_duration er median engasjerte millisekunder, revenue er i minste enheter (cent). interval er som standard auto, som velger minutt, time, dag, uke eller måned etter tidsrommet. Sett den for å tvinge en bestemt intervallstørrelse. Bruk stats_aggregate for én enkelt total og stats_breakdown for å dele opp etter en dimensjon som country eller page.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/stats/timeseries.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Analyse av uttalelser

GET /sites/:site_id/testimonials/analytics/breakdown.json Del ett uttalelsesmål etter skjema, forespørsel, widget, vegg, uttalelse, kanal, side, land eller kilde testimonial_stats_breakdown

Returnerer rader, størst først, hver med key, label, value og share (en prosent av totalen), eller numerator og denominator for en rate. En rad for en post (skjema, forespørsel, widget, vegg, uttalelse) har id-en sin. Hver dimensjon tar bare noen mål: form og channel tar skjemamålene, request forespørselsmålene, widget og wall sine egne visninger, klikk, klikkrate og video_plays, testimonial tar testimonial_views og video_plays, page og country tar visnings- og klikkmålene, og source tar new_testimonials. Et par som ikke passer, svarer med 422 og navngir målene som passer.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/analytics/breakdown.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/analytics/export.json Sett en fil med én del av uttalelsesanalysen i kø testimonial_stats_export

Oppretter en eksport av typen testimonial_stats for perioden og returnerer den i kø. Spør exports_get til status er complete, deretter exports_download. section velger radene: days (én rad per dag, uke eller måned med hvert mål), forms, channels, requests, widgets, walls, pages, testimonials, sources eller countries. Filen beholdes i 7 dager. Svarer med 422 in_progress når for mange eksporter allerede står i kø.

Tillatelse: analytics.export

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/analytics/export.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/analytics.json Les uttalelsesanalysen til et nettsted i ett kall testimonial_stats_overview

Returnerer alt Analyse-fanen under Uttalelser viser for en periode: cards (form_views, submissions, completion_rate, answer_rate, widget_views, wall_views, hver med previous og change når compare er satt), chart (ett mål over tid), en rad per skjema, forespørsel, widget og vegg, channels (hvordan skjemaer ble åpnet), pages (hvor widgeter og vegger ble sett), top_testimonials, new_testimonials (etter kilde og etter nåværende status) og countries. Rater er prosent fra 0 til 100 og er null når det ikke er noe å dele på. blank er true så lenge nettstedet aldri har telt noe, og recorded lister målene det noen gang har telt. Dette er daglige totaler for uttalelsesfunksjonen, ikke nettanalyse: bruk stats_overview for besøkende og sidevisninger.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/analytics.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/analytics/timeseries.json Les ett uttalelsesmål per dag, uke eller måned testimonial_stats_timeseries

Returnerer punkter med date, to, value og, når compare er satt, previous og previous_date, pluss total, previous_total og change. En rate (completion_rate, answer_rate, widget_click_rate, wall_click_rate) regnes ut fra totalene i hver bøtte og er null for en bøtte uten noe å dele på. new_testimonials telles fra selve uttalelsene etter dagen hver ble lagt til.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/analytics/timeseries.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Angreliste for uttalelser

GET /sites/:site_id/testimonials/settings/undo.json List hva som ble endret de siste 7 dagene og kan angres testimonial_undo_records_list

Nyeste først. Hver post sier hva som kjørte, hvem som kjørte det, hvor mange den endret og hoppet over og hvorfor, og til når det kan angres.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/settings/undo.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/settings/undo/:id.json Les én angrepost testimonial_undo_records_get

For en kjøring i bakgrunnen er state running, og processed sier hvor langt den har kommet.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/settings/undo/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/settings/undo/:id/undo.json Angre en massehandling eller en enkelt endring innen 7 dager testimonial_undo_records_undo

Setter den tidligere verdien tilbake på alt kjøringen endret. Det som er endret igjen siden, blir latt i fred og telt i left. En sammenslåing av personer eller av duplikater angres på samme måte. Over MCP kjøres ikke en angring som ville slette eller flytte til papirkurven (angring av en gjenoppretting, av en oversettelseskjøring og av en kjøring som lager bilder): verktøyet svarer med human_only og siden i appen der en person gjør det.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/settings/undo/:id/undo.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Annonsemotiv

POST /sites/:site_id/experiments/ads/:ad_placement_id/creatives.json Legg til et annonsemotiv i en annonseplassering ad_creatives_create

Legger til et bilde med plasseringens form (minst like stort, det dobbelte ser skarpest ut) og adressen et klikk går til. Send bildet som en multipart-fil, eller image_url for å få det lastet ned. Det behandles i bakgrunnen, så poll ad_creatives_get til state er ready. Tidsplan, enheter og stier er Pro og høyere. Krever content.write.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/experiments/ads/:ad_placement_id/creatives.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/experiments/ads/:ad_placement_id/creatives/:id.json Slett et annonsemotiv og bildet ad_creatives_delete

Sletter et annonsemotiv og bildet permanent. Et som et eksperiment sammenligner kan ikke slettes: slå det av i stedet. MCP-verktøyet kjører det ikke og responderer med human_only og siden der en person sletter det. Krever content.write.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/experiments/ads/:ad_placement_id/creatives/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/experiments/ads/:ad_placement_id/creatives/:id.json Hent ett annonsemotiv med status ad_creatives_get

Et annonsemotiv er processing til bildet er laget, deretter ready (eller failed, med årsaken i error). Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/experiments/ads/:ad_placement_id/creatives/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/experiments/ads/:ad_placement_id/creatives/:id.json Endre et annonsemotiv ad_creatives_update

Endrer lenken, vekten, tidsplanen eller målrettingen, slår det av (active false) eller bytter bildet. Bare oppgitte verdier endres. Et nytt bilde erstatter det gamle når det er klart. Krever content.write.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/experiments/ads/:ad_placement_id/creatives/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Annonseplasseringer

POST /sites/:site_id/experiments/ads.json Opprett en annonseplassering ad_placements_create

Oppretter en plass av én størrelse på nettstedet. Send size (en vanlig størrelse som medium_rectangle eller leaderboard) eller width og height i piksler. key er navnet koden på nettstedet bruker, og lages av navnet hvis den utelates. Legg deretter til annonsemotiv med ad_creatives_create og legg koden fra ad_placements_embed på nettstedet. Krever content.write.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/experiments/ads.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/experiments/ads/:id.json Slett en annonseplassering med annonsemotivene ad_placements_delete

Sletter en plassering permanent med annonsemotivene og bildene deres, annonseeksperimentene og resultatene deres, og sponsorlenkene. Koden på nettstedet tegner da ingenting. MCP-verktøyet kjører det ikke og responderer med human_only og siden der en person sletter det. Krever content.write.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/experiments/ads/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/experiments/ads/:id/embed.json Hent koden som viser en plassering på nettstedet ad_placements_embed

Lasterskriptet (én gang per side) og plassen for denne plasseringen, som html til å lime inn. Plassen beholder størrelsen sin før lasteren kjører. Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/experiments/ads/:id/embed.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/experiments/ads.json List et nettsteds annonseplasseringer med de siste 30 dagene ad_placements_list

Hver plassering med nøkkel, størrelse, antall annonsemotiv og statistikk (impressions, viewable impressions, clicks og ctr, klikkraten per synlig visning) for de siste 30 dagene. Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/experiments/ads.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/experiments/ads/:id.json Hent en plassering med tallene for hvert annonsemotiv ad_placements_get

Plasseringen, annonsemotivene med statistikk for perioden (7d, 30d eller 90d) og plasseringens tall dag for dag. humans_only beholder det botscoren kaller sannsynlige mennesker (Pro og høyere). Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/experiments/ads/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/experiments/ads/:id.json Endre en annonseplassering ad_placements_update

Endrer navn, nøkkel, størrelse eller etikett. Bare oppgitte verdier endres. En ny nøkkel krever den nye koden på nettstedet. Krever content.write.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/experiments/ads/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Arbeidsområder

GET /workspaces/:workspace_id/white_label.json Hent white label-merkevaren white_label_get

Returnerer arbeidsområdets white label-merkevarebygging. Feltene er workspace_id (ws_...), brand_name, brand_logo_url og brand_color (en hex-farge som #06755b), hver null når den ikke er satt, hide_branding, available (true når planen inkluderer white label, som er Business og høyere) og active (true når merkevarebyggingen er satt og gjelder). Merkevarebyggingen erstatter Privatus Analytics på delte dashbord, innbygginger, statussider og e-postrapporter. Krever workspace.manage.

Tillatelse: workspace.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/white_label.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/white_label.json Angi white label-merkevaren for delte dashbord og e-postrapporter (Business) white_label_update

Setter arbeidsområdets white label-merkevarebygging. Bare Business-planen, ellers feiler den med en planfeil. Bare verdiene du sender, endres, og en tom streng tømmer brand_name, brand_logo_url eller brand_color. brand_logo_url må være en https-URL til et bilde og brand_color en hex-farge som #06755b. hide_branding true fjerner Privatus Analytics-lenken fra delte dashbord, innbygginger og statussider og logoen fra e-postrapporter. Endringen gjelder umiddelbart for eksisterende delingslenker. Krever workspace.manage. Returnerer merkevarebyggingen (se white_label_get).

Tillatelse: workspace.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/workspaces/:workspace_id/white_label.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/security.json Hent sikkerhetsinnstillingene for arbeidsområdet workspace_security_get

Returnerer sikkerhetspolicyen for arbeidsområdet. Feltene er workspace_id (ws_...), enforce_2fa (medlemmer må bruke tofaktorautentisering), login_methods (de tillatte blant password, magic_link, passkey, google, github og sso), session_ttl_hours (utlogging etter så mange timer, null for ingen grense), app_ip_allowlist (IP-er eller CIDR-områder som har lov til å bruke appen og API-et, tom betyr hvor som helst) og support_access_until (ISO 8601-tidspunkt frem til når støtten hos Privatus Analytics kan se arbeidsområdet, null når ingen tilgang er gitt). Krever workspace.manage.

Tillatelse: workspace.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/security.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/security.json Oppdater sikkerhetsinnstillingene for arbeidsområdet (2FA, innloggingsmetoder, øktlevetid, IP-tillatelsesliste, støttetilgang) workspace_security_update

Endrer sikkerhetspolicyen for arbeidsområdet, bare inputene du sender. enforce_2fa true krever at alle medlemmer bruker tofaktorautentisering og trenger Business-planen. login_methods erstatter den tillatte listen med verdier fra password, magic_link, passkey, google, github og sso, og å fjerne en metode logger ut medlemmenes husket innlogginger, så de må logge inn på nytt. session_ttl_hours logger medlemmer ut etter så mange timer (0 fjerner grensen). app_ip_allowlist erstatter listen over IP-er eller CIDR-områder som har lov til å nå appen og API-et (Business-planen, en tom liste betyr hvor som helst) og avvises hvis den ville utelatt IP-en til den som kaller, slik at du ikke kan låse deg selv ute. support_access true lar støtten hos Privatus Analytics se arbeidsområdet i 7 dager, og false trekker tilbake den tilgangen. Krever workspace.manage. Returnerer policyen (se workspace_security_get).

Tillatelse: workspace.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X PATCH https://privatusanalytics.com/workspaces/:workspace_id/security.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces.json Opprett et arbeidsområde (du blir eier) workspaces_create

Tillatelse: member · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /workspaces/:id.json Slett et arbeidsområde og alle nettstedene i det (kun eieren, sier opp abonnementer) workspaces_delete

Sletter et arbeidsområde sammen med alle nettstedene. Det er en myk sletting, alt forsvinner med en gang og fjernes permanent etter 7 dager, så behandle det som uopprettelig. Bare eieren kan gjøre det, og confirm må være arbeidsområdets nøyaktige navn (skiller mellom store og små bokstaver). Et aktivt betalt abonnement sies opp umiddelbart først, og hvis oppsigelsen feiler, slettes ingenting. Ventende nettstedsoverføringer fra arbeidsområdet avbrytes. Medlemmer mister tilgangen. Bruk workspaces_get for å lese navnet. Krever workspace.manage og rollen owner. Returnerer arbeidsområdet.

Tillatelse: workspace.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/workspaces/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces.json List arbeidsområdene dine workspaces_list

Lister arbeidsområdene den som kaller tilhører, ordnet etter navn. Et API-token eller en MCP-tilkobling ser bare det ene arbeidsområdet det ble utstedt for. Hvert element har id (ws_..., brukt som workspace_id av de fleste verktøy), name, timezone, currency, plan, plan_events, subscription_status og role (den som kallers rolle). Kall sites_list med en arbeidsområde-ID ved siden av for å finne nettsted-ID-er. Å opprette et arbeidsområde er bare mulig i appen.

Tillatelse: member

Eksempel
curl https://privatusanalytics.com/workspaces.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /workspaces/:id.json Hent et arbeidsområde workspaces_get

Returnerer ett arbeidsområde etter den offentlige id-en (ws_..., fra workspaces_list). Feltene er id, name, timezone (IANA-navn), currency (ISO 4217), plan (free, pro, business eller enterprise), plan_events (planens månedlige hendelseskvote), subscription_status (none, trialing, active, past_due, paused eller canceled), role (rollen til den som kaller i det) og created_at. Bruk billing_get for fulle faktureringsdetaljer og billing_usage for bruken denne måneden. Ethvert medlem kan lese det.

Tillatelse: member

Eksempel
curl https://privatusanalytics.com/workspaces/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:id.json Oppdater innstillingene for arbeidsområdet workspaces_update

Endrer et arbeidsområdes navn, standard tidssone eller standardvaluta, bare inputene du sender. timezone er et IANA-navn som Europe/Berlin og currency er en ISO 4217-kode på 3 bokstaver. Dette er standarder for nye nettsteder, de endrer ikke eksisterende nettsteder (bruk sites_update for dem). Krever workspace.manage. Returnerer arbeidsområdet (se workspaces_get).

Tillatelse: workspace.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/workspaces/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Assistent

POST /sites/:site_id/ask.json Still et spørsmål i en ny samtale (teller mot den månedlige grensen for AI-spørsmål) assistant_ask

Starter en ny Spør-samtale for ett nettsted og svarer på det første spørsmålet ved hjelp av nettstedets analyser. Bruk den for et spørsmål i klartekst om et nettsted. Bruk assistant_ask_followup for å fortsette en eksisterende samtale og statistikkverktøyene når du allerede vet den eksakte spørringen. Svaret lages av en AI-modell som kjører skrivebeskyttede analysespørringer på egen hånd, så kallet kan ta mange sekunder. Det teller som ett AI-spørsmål mot arbeidsområdets månedlige kvote (5 på Free, 20 på Pro, 100 på Business) og feiler med en grensefeil når kvoten er brukt opp. Spørsmålet kan være på høyst 2000 tegn. Samtaler er private for medlemmet som startet dem og slettes 30 dager etter siste melding. Returnerer samtalen (id, site_id, title hentet fra spørsmålet, created_at, updated_at, expires_at) med en messages-matrise. Hver melding har role (user eller assistant), content (svarteksten), queries (de eksakte analysespørringene assistenten kjørte), chart (diagramdefinisjon som kan være null), goal_draft (foreslått mål som kan være null), antall tokens og created_at. Hvis svaret feiler, fjernes samtalen og ingen spørsmål telles. Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/ask.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/ask/:id.json Slett en Spør-samtale og meldingene i den assistant_conversations_delete

Sletter én Spør-samtale og alle meldingene i den permanent og umiddelbart. Dette kan ikke angres. Hent samtale-ID-en fra assistant_conversations_list. Bare medlemmet som startet en samtale, kan se og slette den. Krever analytics.read og en site_id. Returnerer sammendraget av den slettede samtalen (id, site_id, title, tidsstempler). Det refunderer ikke AI-spørsmålene som allerede er telt for måneden.

Tillatelse: analytics.read

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/ask/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/ask.json List Spør-samtalene dine for et nettsted assistant_conversations_list

Lister det innloggede medlemmets Spør-samtaler for ett nettsted, sist oppdaterte først. Andre medlemmers samtaler vises aldri. Bruk den for å finne en samtale-ID til assistant_conversations_get, assistant_ask_followup eller assistant_conversations_delete. Hvert element har id, site_id, title (det første spørsmålet, kortet ned til 80 tegn), created_at, updated_at og expires_at, men ingen meldinger. Har sideinndeling med page og per_page (maksimum 100). Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/ask.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/ask/:id.json En Spør-samtale: spørsmål, svar, spørringene bak dem og diagrammer assistant_conversations_get

Returnerer én Spør-samtale med hele meldingshistorikken. Hent samtale-ID-en fra assistant_conversations_list eller fra resultatet av assistant_ask. Feltene er id, site_id, title, created_at, updated_at, expires_at (30 dager etter siste melding, deretter slettes samtalen) og messages. Hver melding har role (user eller assistant), content, queries (analysespørringene assistenten kjørte), chart (kan være null), goal_draft (kan være null) og input_tokens og output_tokens (heltall som kan være null). Bare medlemmet som startet samtalen, kan lese den. Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/ask/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/ask/:ask_conversation_id/messages.json Still et oppfølgingsspørsmål i en samtale (teller mot den månedlige grensen for AI-spørsmål). Returnerer svaret. assistant_ask_followup

Stiller et oppfølgingsspørsmål i en eksisterende Spør-samtale, slik at assistenten beholder de tidligere spørsmålene og svarene som kontekst. Bruk assistant_ask for å starte en ny samtale i stedet. Hent conversation_id fra assistant_conversations_list. Kallet kan ta mange sekunder fordi assistenten kjører skrivebeskyttede analysespørringer. Hvert spørsmål teller mot arbeidsområdets månedlige kvote for AI-spørsmål (5 på Free, 20 på Pro, 100 på Business) og feiler med en grensefeil når den er brukt opp. Spørsmålet kan være på høyst 2000 tegn. Returnerer bare den nye assistentmeldingen (ikke hele samtalen) med id, role, content (svaret), queries (de eksakte spørringene som ble kjørt), chart (kan være null), goal_draft (kan være null), input_tokens, output_tokens og created_at. Krever analytics.read og fungerer bare på dine egne samtaler.

Tillatelse: analytics.read

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/ask/:ask_conversation_id/messages.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Belønninger

POST /sites/:site_id/testimonials/settings/rewards/:id/copy.json Kopier et skjemas belønning til andre skjemaer på samme nettsted testimonial_rewards_copy

Kopierer tittelen, teksten, koden og på- eller av-tilstanden til dette skjemaets belønning til hvert skjema i form_ids (1 til 100 skjemaer på samme nettsted, ikke i papirkurven). En belønning målskjemaet allerede har, erstattes. Serveren svarer med 422 og koden unknown_ids når en id ikke er et skjema på nettstedet, og da kopieres ingenting.

Tillatelse: sites.manage

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/settings/rewards/:id/copy.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/settings/rewards.json List belønningen for hvert skjema på et nettsted testimonial_rewards_list

Én rad per skjema. Et skjema uten belønning satt har enabled false.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/settings/rewards.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/settings/rewards/:id.json Sett belønningen et skjema viser på takketrinnet testimonial_rewards_update

Id-en er skjemaets id. Koden er tekst du oppgir. Privatus Analytics oppretter, kontrollerer eller utløper den ikke.

Tillatelse: sites.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/settings/rewards/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Bilder av uttalelser

POST /sites/:site_id/testimonials/images/bulk.json Lag bilder for hver godkjente uttalelse i en samling testimonial_images_bulk_create

Opptil 200 uttalelser per kjøring, ett bilde per størrelse for hver. En tekst som er for lang for bildet tegnes fra uthevingen, eller ellers fra åpningssetningene (excerpted sier hvor mange). Svaret lister bildene som er startet, uttalelsene som er utelatt med årsaken, og export_id: én zip med PNG-ene vises på Eksporter-siden når de er tegnet.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/images/bulk.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/images.json Lag bilder av én godkjent uttalelse, ett per størrelse testimonial_images_create

Bare en godkjent uttalelse kan tegnes, fordi PNG-en får en offentlig adresse: enhver annen avvises med not_approved. Hvert bilde starter som rendering og tegnes i bakgrunnen. Svaret er listen over bilder som er startet. Spør testimonial_images_get etter file_url. En 422 med text_too_long betyr at ordene ikke får plass: bruk text_mode highlight eller excerpt, eller en høyere størrelse.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/images.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/images/:id.json Slett et bilde og filen testimonial_images_delete

PNG-en slettes fra mediavverten, og adressen slutter å fungere. Et bilde har ingen papirkurv. Det kan lages på nytt fra uttalelsen med testimonial_images_create. Over MCP endrer verktøyet ingenting og svarer med siden i appen der en person gjør det.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/images/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/images.json List bildene til et nettsted testimonial_images_list

Bilder laget av godkjente uttalelser, nyeste først, 25 per side. Filtrer etter status, template, size eller testimonial_id. Hvert bilde har file_url når det er klart.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/images.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/images/:id.json Hent ett bilde, med status og adressen til PNG-en testimonial_images_get

status er rendering, ready eller failed. file_url settes når det er klart. Spør dette etter testimonial_images_create til status ikke lenger er rendering.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/images/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/images/:id.json Endre hvordan et bilde tegnes og tegn det på nytt testimonial_images_update

Send bare det som endres. Uten noe sendt tegnes det samme bildet på nytt fra uttalelsen slik den er nå, som også er måten å prøve en mislykket på nytt. En ny tegning har en ny file_url, og den gamle filen slettes.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/images/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Dashbord

GET /workspaces/:workspace_id/dashboards/:id/cards/:index.json Data for ett kort i et egendefinert dashbord dashboards_card

Returnerer live-dataene for ett kort på et egendefinert dashbord. Dashbord er lister over kort (se dashboards_get for kortlisten), og hvert kort lastes for seg, så kall denne én gang per kort med posisjonen i index, talt fra 0. Returnerer index, type, title, site_id, site_name, params, status og data. status er ok, not_available (kortet har ingenting å vise, for eksempel et trakt-kort på et nettsted uten trakter eller et oppetidskort uten kontroller) eller no_access (kortet tilhører et nettsted tokenet eller rollen din ikke kan åpne, og da er title, params og data tomme). Formen på data avhenger av type. metric gir {metric, value, previous, change, period} sammenlignet med forrige periode. chart gir {metric, interval, period, series: [{date, value}]}. breakdown gir {dimension, label, rows}. goal gir {rows} med målfullføringer. live gir {visitors}. funnel gir {funnel_id, name, overall_conversion_rate, steps}. uptime gir {checks: [{name, status, uptime}]}. vitals gir {scorecard}. subscriptions gir {currency, mrr_minor, previous_mrr_minor (for 30 dager siden), change (prosent, null uten MRR for 30 dager siden), active_subscriptions, subscription_churn_rate (siste 30 dager)} og er not_available mens nettstedet ikke har noen betalingsleverandør tilkoblet. Kortparametere er som standard period 30d, metric visitors, dimension page og 5 rader (limit er begrenset til 10). En index utenfor listen gir 404. Bruk dashboards_get først for å se hvor mange kort det er.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/dashboards/:id/cards/:index.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /workspaces/:workspace_id/dashboards.json Opprett et egendefinert dashbord dashboards_create

Oppretter et egendefinert dashbord i et arbeidsområde. Et egendefinert dashbord er en navngitt, ordnet liste med opptil 40 kort, og kortene kan komme fra ulike nettsteder i arbeidsområdet. Send name (opptil 100 tegn) og cards, en liste av objekter med type (metric, chart, breakdown, goal, live, funnel, uptime, vitals eller subscriptions), site_id (pa_..., fra sites_list) og eventuelt title (opptil 80 tegn) og params. Parametere som brukes per type er metric (period, metric), chart (period, metric, interval), breakdown (period, dimension, limit), goal (period, limit), funnel (period, funnel_id), uptime (limit) og vitals (period). live og subscriptions tar ingen. Andre parametere forkastes. Perioden må være en forhåndsinnstilling som 30d (ikke custom) og metric en av visitors, visits, pageviews, views_per_visit, bounce_rate eller visit_duration. Hvert kort må peke til et nettsted tokenet ditt har tilgang til, og et token som er begrenset til noen nettsteder, må ha minst ett kort. Returnerer dashbordet med id (dash_...), name, cards og tidsstempler. Les det med dashboards_get og last tallene for hvert kort med dashboards_card. Trenger tillatelsen content.write. Planen avgjør hvor mange dashbord et arbeidsområde har: 1 på Free, 3 på Pro, ubegrenset på Business. Ett over antallet avvises med en valideringsfeil.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/dashboards.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /workspaces/:workspace_id/dashboards/:id.json Slett et egendefinert dashbord dashboards_delete

Sletter et egendefinert dashbord permanent. Bare dashbordoppsettet fjernes, ingen analysedata berøres, og det finnes ingen angrefunksjon. Du trenger tilgang til alle nettsteder som har et kort på dashbordet, og dashbordet må ha minst ett kort fra et nettsted du har tilgang til. Returnerer det slettede dashbordet. Bruk dashboards_update for å endre et dashbord i stedet. ID-er (dash_...) kommer fra dashboards_list. Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X DELETE https://privatusanalytics.com/workspaces/:workspace_id/dashboards/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/dashboards.json List egendefinerte dashbord dashboards_list

Lister de egendefinerte dashbordene i et arbeidsområde, ordnet etter navn. Hvert element har id (dash_...), name, cards og tidsstempler, samme form som dashboards_get. Et token som er begrenset til noen nettsteder, ser bare dashbord som inneholder et kort fra et av nettstedene sine, og kort fra andre nettsteder blankes til {type, status: no_access}. Har sideinndeling med page og per_page (maks 100). Bruk dashboards_card for å laste dataene til et kort og dashboards_create for å legge til et dashbord. For ett enkelt nettsted gir stats_overview samme slags tall uten et dashbord.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/dashboards.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /workspaces/:workspace_id/dashboards/:id.json Hent et egendefinert dashbord og kortene det inneholder dashboards_get

Returnerer ett egendefinert dashbord: id (dash_...), name, cards og created_at og updated_at. Hvert kort er {type, site_id, title, params} (type er metric, chart, breakdown, goal, live, funnel, uptime, vitals eller subscriptions). Et kort på et nettsted du ikke har tilgang til, returneres som {type, status: no_access} uten andre felter. Dette returnerer bare oppsettet, ikke tallene. Last tallene for et kort med dashboards_card, med kortets posisjon talt fra 0. ID-er kommer fra dashboards_list. Et dashbord utover planens antall (1 på Free, 3 på Pro) beholdes og låses: det svarer 402 plan_limit til arbeidsområdet oppgraderes eller sletter et annet.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/dashboards/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/dashboards/:id.json Gi et egendefinert dashbord nytt navn eller erstatt kortene dashboards_update

Gir et egendefinert dashbord nytt navn og/eller erstatter hele kortlisten. Bare feltene du sender, endres, og name blir værende når den er tom. Å sende cards erstatter alle kortene, så send hele listen i den rekkefølgen du vil ha, hentet fra dashboards_get og redigert. Kortformat og parametere per type er de samme som i dashboards_create (maks 40 kort). Et kort vist som {type, status: no_access} tilhører et nettsted du ikke kan åpne. Send det tilbake uendret for å beholde det, det kan ikke redigeres, og det siste kortet fra et slikt nettsted kan ikke fjernes. Et token som er begrenset til noen nettsteder, kan ikke la dashbordet bli tomt. Returnerer det oppdaterte dashbordet. Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/workspaces/:workspace_id/dashboards/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Datavarehussynkronisering

POST /workspaces/:workspace_id/warehouses.json Legg til en datavarehusmottaker warehouse_destinations_create

Legger til en lagermål som mottar hver dags rå hendelser (bare Business-planen). Daglig kl. 02:00 UTC lastes forrige UTC-dag opp, den første kjøringen er neste 02:00 UTC, og en mislykket kjøring forsøkes på nytt en time senere. kind må oppgis og avgjør de påkrevde innstillingene. s3 (også GCS, R2 og MinIO via endpoint) trenger bucket, access_key_id og secret_access_key, med valgfri region, prefix og endpoint (bare https, offentlige verter). bigquery trenger service_account_json, dataset og table, med valgfri project_id. snowflake trenger account, user, private_key (PEM RSA), database, schema og table, med valgfri warehouse og role. azure trenger sas_url (en https SAS-lenke til en blob-container med skrivetillatelse), med valgfri prefix. Hemmeligheter (secret_access_key, service_account_json, private_key, sas_url) er skrivebeskyttede og returneres aldri. site_ids begrenser nettstedene (pa_...-ID-er), tom betyr alle nettsteder, og et medlem eller token som er begrenset til noen nettsteder, må navngi dem. Hendelsesegenskaper sendes bare når de er merket trygge å eksportere (se event_properties_list). Trenger tillatelsen workspace.manage. Returnerer målet med id (whd_...), et maskert mål og configured (navnene på de utfylte innstillingene).

Tillatelse: workspace.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/warehouses.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /warehouses/:id.json Slett en datavarehusmottaker warehouse_destinations_delete

Sletter et lagermål slik at ingenting mer sendes. Data som allerede er lastet opp, blir værende i bucketen eller lageret ditt, og dette kan ikke angres, selv om du kan legge til målet igjen (historikk sendes ikke på nytt automatisk). En manuell synkronisering som fortsatt er i kø, kalles ikke tilbake. id kommer fra warehouse_destinations_list. Trenger tillatelsen workspace.manage. Returnerer det slettede målet.

Tillatelse: workspace.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/warehouses/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/warehouses.json List datavarehusmottakere warehouse_destinations_list

Lister lagermålene i et arbeidsområde sortert etter navn, eventuelt bare én type (s3, bigquery, snowflake eller azure). Et medlem eller token som er begrenset til noen nettsteder, ser bare mål der alle nettstedene er blant deres, og mål som sender alle nettsteder, er skjult for dem. Har sideinndeling med page og per_page (opptil 100). Hvert element har feltene beskrevet i warehouse_destinations_get. Trenger workspace_id fra workspaces_list og tillatelsen workspace.manage.

Tillatelse: workspace.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/warehouses.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /warehouses/:id.json Hent en datavarehusmottaker (uten hemmeligheter) warehouse_destinations_get

Returnerer ett lagermål uten legitimasjon. Feltene er id (whd_...), kind (s3, bigquery, snowflake eller azure), name, target (en maskert oppsummering som s3://bucket/prefix), configured (navn på innstillingene som er fylt ut, hemmeligheter vises bare med navn), site_ids (tom betyr alle nettsteder), schedule (daily), schema_version (radoppsettet som sendes), last_run_at, next_run_at, last_error (null når siste kjøring virket) og created_at. id kommer fra warehouse_destinations_list. Sjekk last_error etter warehouse_destinations_sync for å se hvordan en synkronisering gikk.

Tillatelse: workspace.manage

Eksempel
curl https://privatusanalytics.com/warehouses/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /warehouses/:id/sync.json Legg en synkronisering av én dag i kø nå warehouse_destinations_sync

Setter en umiddelbar opplasting av én UTC-dag med rå hendelser til et mål i kø, utenfor den daglige tidsplanen. Bare Business-planen. date (YYYY-MM-DD) må ligge før i dag i UTC og er som standard i går. Den laster opp den dagen for hvert nettsted i målet, så unngå å synkronisere en dag som allerede er sendt, og manuelle synkroniseringer er frekvensbegrenset til 30 i timen per arbeidsområde. Kallet returnerer 202 med målet med en gang, og opplastingen kjører i bakgrunnen. Spør warehouse_destinations_get gjentatte ganger og les last_run_at og last_error for å se resultatet. id kommer fra warehouse_destinations_list. Trenger tillatelsen workspace.manage.

Tillatelse: workspace.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/warehouses/:id/sync.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
PATCH /warehouses/:id.json Oppdater en datavarehusmottaker (tomme hemmeligheter beholdes) warehouse_destinations_update

Endrer et lagermål (bare Business-planen). Bare verdiene du sender, endres, og kind kan ikke endres. En tom hemmelighet beholder den lagrede verdien, så du kan redigere andre innstillinger uten å sende legitimasjon på nytt. Innstillinger valideres for målets kind som i warehouse_destinations_create. Å sende site_ids erstatter listen over nettsteder. Når målet endres (en annen bucket, dataset, tabell, database eller lignende), starter fremdriften for uferdige dager på nytt, så disse dagene sendes igjen til det nye stedet. id kommer fra warehouse_destinations_list. Trenger tillatelsen workspace.manage. Returnerer det oppdaterte målet.

Tillatelse: workspace.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X PATCH https://privatusanalytics.com/warehouses/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Deling

GET /badge/:site_id.json Besøkstellermerke (SVG) for et offentlig nettsted badges_get

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/badge/:site_id.json
GET /share/:token/breakdown/:dimension.json De øverste verdiene for en delt dimensjon shares_breakdown

Toppverdier for én dimensjon bak en delingslenke, den delte motparten til stats_breakdown. Banen tar token (siste del av delings-URL-en) og dimension, som må tilhøre en seksjon lenken deler, for eksempel sources deler channel, referrer og referrer_url, pages deler page, entry_page, exit_page og hostname, campaigns deler utm_-dimensjonene, locations deler country og language, technology deler device, browser, os og screen, conversions deler goal og events deler event. En dimensjon utenfor lenkens seksjoner avvises med en valideringsfeil. limit er 1 til 100 rader (standard 10). Rader har de samme feltene og enhetene som stats_breakdown for den dimensjonen. Lenkens låste periode og filtre vinner over period, from, to og filters, og filtre fra den som kaller, ignoreres når lenken ikke tillater dem. En passordlenke trenger X-Share-Password-headeren.

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/share/:token/breakdown/:dimension.json
GET /share/:token.json Oversikt over delt dashbord for et delingstoken shares_overview

Leser dashbordet bak en delingslenke for folk som ikke har en konto. Bane-token er siste del av en delings-URL (/share/<token>) og er den eneste legitimasjonen, en passordlenke trenger også X-Share-Password-headeren, og en sso-lenke trenger et innlogget medlem. Den godtar også en nettsted-ID (pa_...) når nettstedet har sitt offentlige dashbord slått på. Returnerer de samme dataene som stats_overview, begrenset til det lenken deler. Det er period, metrics (visitors, visits, pageviews, views_per_visit, bounce_rate som prosent, visit_duration i millisekunder, revenue i minste enheter), diagramserien for interval, sammenligningsdata når compare er satt, og panels med toppverdier bare for de delte seksjonene. Den legger til site (id, name, domain, timezone), sections og locked_period. live_visitors vises bare når lenken deler live. En låst periode og låste filtre på lenken overstyrer period, from, to og filters. Bruk shares_breakdown for flere rader av én dimensjon. For dine egne nettsteder, bruk stats_overview.

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/share/:token.json

Dokumentasjon

GET /docs/api.json List alle API-operasjoner og MCP-verktøy docs_api

Returnerer hele katalogen over alle API-operasjoner, som også er alle MCP-verktøy. Bruk den for å finne ut hvilket verktøy eller endepunkt som finnes og nøyaktig hva det tar imot. Hvert element har tool_name, summary, description (kan være null), group, verb (HTTP-metode), path (mal med plassholdere), permission (tillatelsen et medlem eller token trenger, null for offentlige verktøy), input_schema (JSON Schema for inputene) og response_schema (JSON Schema for svaret). Svaret er stort. For ett verktøy du allerede kjenner, bruk helst dokumentasjonssidene (docs_search). docs_openapi returnerer den samme informasjonen som et OpenAPI-dokument. Offentlig, krever ingen autentisering.

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/docs/api.json
GET /docs.json List dokumentasjonssider docs_list

Lister alle dokumentasjonssider med tittel, beskrivelse, path (som /docs/api/authentication), seksjon og uten innhold. Bruk den for å bla gjennom det som finnes. For å finne en side etter tema, bruk docs_search, og for å lese en, bruk docs_get med seksjon og side. Har sideinndeling med page og per_page (maksimum 100). Offentlig, krever ingen autentisering.

Tillatelse: public

Eksempel
curl https://privatusanalytics.com/docs.json
GET /openapi.json OpenAPI 3.1-dokument for hele API-et docs_openapi

Returnerer OpenAPI 3-dokumentet som beskriver hele det offentlige API-et som rå JSON (ikke pakket inn i et data-felt). Bruk det når du trenger en maskinlesbar spesifikasjon for kodegenerering. For en bla-bar liste over operasjoner med input- og responsskjemaer er docs_api lettere å lese. Den beskriver de samme operasjonene som er tilgjengelige som MCP-verktøy. Offentlig, krever ingen autentisering.

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/openapi.json
GET /docs/:section/:page.json Les en dokumentasjonsside (Markdown og HTML) docs_get

section og page kommer fra sidestien /docs/<section>/<page>. Bruk page "index" for en oversikt over en seksjon.

Tillatelse: public

Eksempel
curl https://privatusanalytics.com/docs/:section/:page.json

Domain Rating

GET /sites/:site_id/domain-rating.json Domain Rating-rapport: siste rating, innkommende og utgående lenker, endringen siden forrige utgivelse og historikken per måned domain_rating_report

Returnerer nettstedets Domain Rating, et estimat fra 0 til 100 på hvor sterke lenkene som peker til domenet er, pluss antall innkommende og utgående lenker og historikken deres. Dette er Privatus Analytics sin egen score, ikke en Google-metrikk. Rangeringer oppdateres én gang i måneden per utgivelse, så endringer vises månedlig. months (1 til 120, standard 12) angir hvor mange månedlige punkter med historikk som skal tas med. Resultatet har domain, checked_at (når nettstedet sist ble sjekket, null hvis aldri), release (måneden for de nyeste dataene som YYYY-MM), rating, inbound_links, outbound_links (hver null hvis de ikke er kjent ennå), changes (de samme tre metrikkene som differansen mot forrige utgivelse, null når en av dem er ukjent) og history (én rad per måned med month, rating, inbound_links, outbound_links, eldste først). Et nytt nettsted kan være uvurdert i noen minutter. Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/domain-rating.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Duplikater av uttalelser

POST /sites/:site_id/testimonials/duplicates/dismiss.json Si at en gruppe ikke er duplikater. Den kommer aldri tilbake i køen testimonial_duplicates_dismiss

testimonial_ids må være hver kopi av én åpen gruppe i duplikatkøen som ikke er i papirkurven, slik testimonial_duplicates_list returnerer dem. Ingenting slås sammen eller endres på uttalelsene, og de grupperes aldri sammen igjen. For å dele en gruppe på tre, slå først sammen de to som er like. Serveren svarer med 422 når id-ene ikke er nøyaktig én åpen gruppe.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/duplicates/dismiss.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/duplicates.json List gruppene med uttalelser som sannsynligvis er den samme to ganger testimonial_duplicates_list

Eksakte treff kommer først. Hver gruppe har kopiene sine i sin helhet og keeper_id, kopien som ville bli beholdt. meta.exact_groups er hvor mange grupper testimonial_duplicates_merge_exact ville slå sammen.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/duplicates.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/:id/merge.json Slå kopier av en uttalelse sammen med den i stien testimonials_merge

Beholderen beholder statusen og den verifiserte tilstanden, og ordene sine med mindre body_from navngir en annen kopi. Den får etikettene, de manuelle samlingene, plasseringene og de egendefinerte egenskapene den mangler. Kopiene går til papirkurven merket som sammenslått, og å gjenopprette en angrer sammenslåingen for den kopien. En kopi som kom inn denne måneden slutter å telle som en ny uttalelse. Svaret inneholder meta.undo_id.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/:id/merge.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/duplicates/merge_exact.json Slå sammen alle eksakte treff i køen på én gang testimonial_duplicates_merge_exact

Send først dry_run for antallene, deretter confirm_count med totalen den ga. Opptil 100 grupper slås sammen per kall. Svaret inneholder meta.undo_id, og én angring tar hele kjøringen tilbake.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/duplicates/merge_exact.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

E-postinnstillinger

POST /email/preferences/:token/unsubscribe.json Stopp alle e-poster til en adresse som kan slås av, med token fra lenken til e-postinnstillinger email_preferences_unsubscribe_all

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/email/preferences/:token/unsubscribe.json \
  -H "Content-Type: application/json" -d '{…}'
POST /email/preferences/:token.json Slå e-poster til en adresse av eller på med token fra lenken til e-postinnstillinger email_preferences_update

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/email/preferences/:token.json \
  -H "Content-Type: application/json" -d '{…}'

E-postrapporter

DELETE /recipients/:id.json Fjern en mottaker fra en e-postrapport email_report_recipients_delete

Fjerner én adresse fra en e-postrapport (id til mottakeren, fra email_report_recipients_list). Adressen slutter å motta rapporter og raden slettes. Hvis adressen hadde meldt seg av selv, forblir avmeldingen registrert, så å fjerne den gjør det ikke mulig for noen å invitere den igjen. For å endre mange adresser samtidig, send hele listen via email_reports_update i stedet. Returnerer den fjernede mottakeren.

Tillatelse: content.write

Eksempel
curl -X DELETE https://privatusanalytics.com/recipients/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /reports/:report_id/recipients.json List opp mottakerne av en e-postrapport med status email_report_recipients_list

Statuser: active (får rapporter), pending (invitert, ikke akseptert ennå), declined eller unsubscribed. Legg til eller fjern adresser via rapportens mottakerliste.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/reports/:report_id/recipients.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /recipients/:id/resend.json Send en ventende rapportinvitasjon på nytt email_report_recipients_resend

Sender invitasjonen på nytt med nye lenker. Tillatt én gang hver 7. dag per adresse per rapport.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/recipients/:id/resend.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/reports.json Opprett en e-postrapport email_reports_create

Oppretter en planlagt analyserapport på e-post som dekker ett eller flere nettsteder (banen tar workspace_id). Påkrevd er name og site_ids (pa_...-ID-er). frequency er daily, weekly (standard, sendes på ukedag) eller monthly (den 1. i måneden), hour er klokketimen 0 til 23 i arbeidsområdets tidssone (standard 8), og weekday er 0 for søndag til 6 for lørdag (standard 1, brukes bare av ukentlige rapporter). blocks velger innholdet blant kpis, chart, pages, sources, goals, campaigns, vitals, uptime, testimonials og subscriptions (standard kpis, chart, pages, sources, goals, testimonials, subscriptions). subscriptions viser MRR og hva som flyttet den i perioden, for et nettsted med en betalingsleverandør tilkoblet. recipients er en liste med e-postadresser (opptil 50). Medlemmer av arbeidsområdet er aktive med en gang, enhver annen adresse er pending og får en invitasjons-e-post, og mottar rapporter først etter å ha godtatt den. Adresser som har meldt seg av, avvises. Hvis recipients utelates, legges brukeren som kaller til. En aktivert rapport trenger minst én mottaker. Free-planen tillater 3 rapporter, betalte planer er ubegrenset. Returnerer rapporten med next_run_at. Bruk email_reports_send_test for å forhåndsvise den.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/reports.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /reports/:id/deliveries.json Leveringslogg for en e-postrapport email_reports_deliveries

Lister sendeloggen for én e-postrapport, nyeste først og med sideinndeling. Hver oppføring har status (sent for en planlagt sending, test, failed eller skipped), recipients_count, error (årsaken til en feil, ellers null) og sent_at. Filtrer med status. Bruk den for å bekrefte at en planlagt rapport gikk ut eller for å se hvorfor den feilet. Bruk email_reports_send_test for å utløse en test-e-post.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/reports/:id/deliveries.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
DELETE /reports/:id.json Slett en e-postrapport email_reports_delete

Sletter en e-postrapport permanent sammen med mottakerne og leveringsloggen. Dette kan ikke angres, og ingen flere e-poster sendes. For å slutte å sende men beholde rapporten, bruk email_reports_update med enabled false. id (rep_...) kommer fra email_reports_list. Returnerer den slettede rapporten.

Tillatelse: content.write

Eksempel
curl -X DELETE https://privatusanalytics.com/reports/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/reports.json List e-postrapporter email_reports_list

Lister de planlagte e-postrapportene i et arbeidsområde (banen tar workspace_id), sortert etter navn og med sideinndeling. Hver rapport har id (rep_...), name, site_ids, frequency, hour, weekday, recipients (alle adresser på rapporten), recipient_details (id, email, status, invited_at, expires_at, confirmed_at for hver), blocks, attach_pdf, intro, enabled, last_sent_at, next_run_at og created_at. Filtrer etter frequency (daily, weekly eller monthly). En bruker som er begrenset til noen nettsteder, ser bare rapporter der alle nettstedene er deres. Bare mottakere med status active mottar faktisk rapporter. Bruk email_reports_deliveries for sendeloggen.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/reports.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /reports/:id/send_test.json Send en e-postrapport nå som en test email_reports_send_test

Sender rapporten til én adresse akkurat nå som en test, uten å endre tidsplanen eller last_sent_at. Sender en ekte e-post, så bruk den bare når brukeren vil det. recipient er som standard brukeren som kaller og kan bare være den som kaller, et annet medlem av arbeidsområdet eller en aktiv mottaker av rapporten. For enhver annen adresse går testen til den som kaller i stedet. Testsendinger har frekvensbegrensning per arbeidsområde og per ekstern adresse, og en avvist sending returnerer en frekvensgrensefeil. Returnerer leveringen med status (test, eller failed med årsaken i error), recipients_count og sent_at. Bruk email_reports_deliveries for hele loggen.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/reports/:id/send_test.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /reports/:id.json Hent en e-postrapport email_reports_get

Returnerer én e-postrapport etter id (rep_..., fra email_reports_list). Svaret har name, site_ids, frequency, hour, weekday, recipients, recipient_details med hver adresse og påmeldingsstatusen, blocks, attach_pdf, intro, enabled, last_sent_at og next_run_at (UTC-tidsstempler). recipients lister alle adresser, også ventende, bare adresser med status active i recipient_details mottar rapporter. Bruk email_reports_deliveries for det som ble sendt.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/reports/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /reports/:id.json Oppdater en e-postrapport email_reports_update

Endrer en e-postrapport (id fra email_reports_list). Bare verdiene du sender, endres. Å sende recipients erstatter hele listen. Adresser du tar bort, fjernes, nye følger de samme påmeldingsreglene som email_reports_create (medlemmer er aktive med en gang, andre får en invitasjons-e-post), og adresser som allerede står på rapporten, beholder statusen sin. Å endre frequency, hour, weekday eller enabled beregner next_run_at på nytt. Sett enabled false for å pause. Bruk email_report_recipients_list for å se påmeldingsstatus og email_report_recipients_resend eller email_report_recipients_delete for å håndtere enkeltadresser.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/reports/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /reports/invites/:token/accept.json Godta en rapportinvitasjon report_invites_accept

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/reports/invites/:token/accept.json \
  -H "Content-Type: application/json" -d '{…}'
POST /reports/invites/:token/decline.json Avslå en rapportinvitasjon report_invites_decline

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/reports/invites/:token/decline.json \
  -H "Content-Type: application/json" -d '{…}'
POST /reports/resubscribe/:token.json Motta rapporter igjen etter å ha meldt deg av report_resubscribes_confirm

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/reports/resubscribe/:token.json \
  -H "Content-Type: application/json" -d '{…}'
POST /reports/unsubscribe/:token/resubscribe.json Send en adresse en lenke på e-post for å motta rapporter igjen report_resubscribes_create

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/reports/unsubscribe/:token/resubscribe.json \
  -H "Content-Type: application/json" -d '{…}'
POST /reports/unsubscribe/:token.json Avmeld en adresse fra en e-postrapport report_unsubscribes_create

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/reports/unsubscribe/:token.json \
  -H "Content-Type: application/json" -d '{…}'

Egendefinerte egenskaper for uttalelser

POST /sites/:site_id/testimonials/settings/properties.json Legg til en egendefinert egenskap på et nettsted testimonial_properties_create

Et nettsted har opptil 20 aktive egenskaper. Nøkkelen er fast når den er laget, fordi skjemalenker, regler og API-et bruker den. Utelat den, så foreslås den ut fra etiketten.

Tillatelse: sites.manage

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/settings/properties.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/settings/properties/:id.json Slett en egendefinert egenskap og verdiene for godt testimonial_properties_destroy

Dette kan ikke angres. Det fjerner egenskapen og verdien fra hver uttalelse. confirm er nøkkelen. En egenskap som brukes av en smart samling eller en autoetikettregel kan ikke slettes så lenge de bruker den. Arkivering er den vanlige måten å pensjonere en på.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/settings/properties/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/settings/properties.json List egendefinerte egenskaper for et nettsted, i visningsrekkefølge testimonial_properties_list

Hver sier nøkkelen, typen og valgene, hvor mange uttalelser som har en verdi (filled), om typen fortsatt kan endres, og hvilke smarte samlinger og autoetikettregler som bruker den.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/settings/properties.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/settings/properties/:id.json Endre, omorganiser, arkiver eller hent tilbake en egendefinert egenskap testimonial_properties_update

Bare inndataene du sender endrer noe. Å gi et valg nytt navn gir det nytt navn på hver uttalelse som har det. En egenskap som brukes av en smart samling eller en autoetikettregel kan ikke arkiveres så lenge de bruker den.

Tillatelse: sites.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/settings/properties/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Eksperimenter

POST /sites/:site_id/experiments.json Opprett et eksperiment som utkast experiments_create

Oppretter en A/B-test eller en test med delte URL-er for et nettsted. Den lagres som utkast og sender ingen besøkende noe sted før en person starter den i appen. Påkrevd er name, path (den opprinnelige siden, for eksempel /pricing), goal_id (fra goals_list) og variants: en liste med { name, path, weight } der første rad er den opprinnelige siden (path ignoreres) og hver andre rad er en side på samme nettsted. La alle weight være tomme for en jevn fordeling, eller send vekter som til sammen er 100. Gratisplanen tillater ett eksperiment om gangen med den opprinnelige siden og én variant. Pro og høyere legger til flere varianter, automatisk fordeling, målretting, en * i path, sekundære mål, planlagt start og eksklusive grupper. Krever content.write. Returnerer eksperimentet.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/experiments.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/experiments/:id.json Slett et eksperiment med resultatene experiments_delete

Sletter et eksperiment permanent med variantene og resultatene. Dette kan ikke angres. Bruk experiments_pause for å stoppe det og beholde resultatene. MCP-verktøyet kjører det ikke, men svarer med human_only og siden der en person sletter det. Krever content.write.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/experiments/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/experiments/:id/duplicate.json Kopier et eksperiment som et nytt utkast experiments_duplicate

Oppretter et utkast med samme sider, andeler, mål og regler som et eksisterende eksperiment, og uten noen av resultatene. Bruk det for å endre en test som allerede har startet. Teller mot plangrensen som et nytt eksperiment. Krever content.write. Returnerer det nye eksperimentet.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/experiments/:id/duplicate.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/experiments/:id/end.json Avslutt et eksperiment for godt experiments_end

Avslutter et kjørende eksperiment eller et eksperiment på pause. Det kan ikke startes igjen, resultatene beholdes, og det teller ikke lenger mot plangrensen. MCP-verktøyet kjører det ikke, men svarer med human_only og siden der en person avslutter det. API-et kjører det. Krever content.write.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/experiments/:id/end.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/experiments.json List et nettsteds eksperimenter experiments_list

Lister A/B-testene og testene med delte URL-er for et nettsted, nyeste først. Filtrer med status (draft, scheduled, running, paused, ended eller all, standard all). Paginert med page og per_page (standard 25, opptil 100). Hvert eksperiment har id (exp_...), name, status, path (den opprinnelige siden), goal_id, variants (id, name, path, weight, control), reglene for å avslutte det og locked (true når planen ikke lenger dekker det). Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/experiments.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/experiments/:id/pause.json Sett et eksperiment på pause og behold resultatene experiments_pause

Setter et kjørende eller planlagt eksperiment på pause. Alle besøkende får den opprinnelige siden igjen med en gang, og resultatene så langt beholdes. experiments_start gjenopptar det. Krever content.write. Returnerer eksperimentet.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/experiments/:id/pause.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/experiments/:id.json Hent ett eksperiment med resultatene experiments_get

Returnerer ett eksperiment etter id (exp_..., fra experiments_list) med resultatene: per variant besøkene, konverteringene og konverteringsraten på målet, og mot den opprinnelige siden økningen, det sannsynlige området for forskjellen, p-verdien, om den er signifikant ved valgt konfidensnivå og sjansen for at den slår den opprinnelige. results.progress sier hvor langt det er igjen til en vinner kan kåres, og results.mismatch.found true betyr at besøkene ikke er fordelt slik vektene sier, så resultatet bør ikke stoles på. split bryter resultatene ned etter enhet, kanal eller land (Pro og høyere), og humans_only beholder besøk som robotscoren kaller sannsynlig menneskelige (Business). Et besøk telles for en variant når det så den varianten, og en konvertering teller først etter det. Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/experiments/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/experiments/:id/start.json Start et eksperiment experiments_start

Starter et utkast eller et eksperiment på pause, slik at besøkende på den opprinnelige siden begynner å bli sendt til variantene. Med starts_at i fremtiden venter det til det tidspunktet. Fordi det omdirigerer ekte besøkende, kjører ikke MCP-verktøyet det, men svarer med human_only og siden der en person starter det. API-et kjører det. Krever content.write.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/experiments/:id/start.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
PATCH /sites/:site_id/experiments/:id.json Oppdater et eksperiment experiments_update

Endrer et eksperiment. Bare feltene du sender endres, og variants erstatter hele listen. Når et eksperiment har startet kan bare name og send_to_winner endres, fordi nye sider, andeler eller mål midt i testen ville ødelagt resultatet: bruk experiments_duplicate og rediger kopien. Krever content.write. Returnerer eksperimentet.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/experiments/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Eksporter

POST /workspaces/:workspace_id/exports.json Legg en eksport i kø (bygges i bakgrunnen) exports_create

Setter en dataeksport i kø som bygges i bakgrunnen og returnerer den med en gang med status queued. Velg den når du trenger en fil (CSV, JSON, XLSX, NDJSON eller en ZIP av dashbordpaneler), og bruk exports_preview først for å sjekke kolonner og størrelse uten å opprette noe. For enkle tall, bruk statistikkverktøyene i stedet. Påkrevde inputer er workspace_id (bane), site_id, from og to (YYYY-MM-DD, inklusive, i eksporttidssonen). kind avgjør hva som eksporteres og hvilke alternativer som gjelder. aggregated (standard) gir besøksmetrikker per tidsintervall og bruker grouping, dimensions (opptil 6), metrics, filters og segment_id. pageviews, events og raw gir én rad per treff og bruker fields, filters og segment_id, krever Pro-planen eller høyere, og er begrenset til 400 dager (raw til 93 dager). imported gir importert daglig statistikk og bruker bare dimensions. dashboard gir en ZIP av oversiktspanelene (bare format zip). Tillatt file_format per kind er csv, json eller xlsx for aggregated, pageviews, events og imported, csv eller ndjson for raw, og zip for dashboard. Alternativer som ikke gjelder for den valgte kind, ignoreres. Et arbeidsområde kan ha høyst 5 eksporter i kø eller under kjøring samtidig. Svaret er eksporten med id (exp_...), status, row_count og expires_at (null til den er bygget). Spør exports_get gjentatte ganger til status er complete, og kall deretter exports_download. Brukeren som ba om den, får en e-post når den er klar, en webhook export.ready sendes, og handlingen skrives til revisjonsloggen. Hendelsesegenskaper i props-kolonnen inneholder bare egenskaper merket som trygge å eksportere (se event_properties_list).

Tillatelse: analytics.export

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/exports.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /exports/:id.json Slett en eksport og filen exports_delete

Sletter en eksport og den genererte filen permanent. Nedlastingslenken slutter å virke med en gang og dette kan ikke angres, men du kan opprette eksporten på nytt. Bruk den for å fjerne en ferdig eller mislykket eksport du ikke trenger lenger, siden filer også slettes automatisk 7 dager etter at de er bygget. id kommer fra exports_list. Returnerer det slettede eksportobjektet slik det var før slettingen.

Tillatelse: analytics.export · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/exports/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /exports/:id/download.json Få en signert lenke til filen (gyldig i 10 minutter) exports_download

Returnerer en kortvarig nedlastingslenke for en ferdig eksport. Velg den etter at exports_get viser status complete. Svaret har url (en signert lenke som er gyldig i 10 minutter, hent den med en gang), expires_at (når lenken slutter å virke, ISO 8601), filename og byte_size (byte). Den feiler med feilkoden ikke funnet expired når eksporten er eldre enn 7 dager, og med en valideringsfeil når eksporten fortsatt er i kø eller under kjøring eller når den feilet (feilmeldingen sier hvorfor). Kall den på nytt for å få en fersk lenke så lenge selve eksporten ikke har utløpt. id kommer fra exports_list.

Tillatelse: analytics.export

Eksempel
curl https://privatusanalytics.com/exports/:id/download.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /workspaces/:workspace_id/exports.json List eksporter (jobbkøen) exports_list

Lister eksportene i et arbeidsområde for nettstedene du har tilgang til, nyeste først. Bruk den for å finne en eksport-ID, sjekke hvilke eksporter som fortsatt kjører eller se hva som har utløpt. Filtrer med site_id, status (queued, running, complete, failed eller expired) og kind (aggregated, pageviews, events, imported, raw eller dashboard). Har sideinndeling med page og per_page (opptil 100), og returnerer data (en liste med eksporter, se exports_get for feltene) pluss meta for sideinndeling. Trenger workspace_id fra workspaces_list.

Tillatelse: analytics.export

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/exports.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /workspaces/:workspace_id/exports/preview.json Forhåndsvis en eksport: de første 20 radene og det anslåtte antallet rader exports_preview

Prøvekjøring av en eksport som ikke oppretter noe. Den tar de samme inputene som exports_create og returnerer kind, file_format, columns (kolonnenavnene i rekkefølge), rows (opptil 20 eksempelrader som objekter med kolonne som nøkkel) og estimated_rows (et omtrentlig radantall for hele filen). For dashboard-typen lister eksempelradene hvert filnavn med radantallet. Bruk den for å validere dimensjoner, felter, filtre og datoperioden, og for å se hvor stor eksporten ville blitt før du kaller exports_create. Den kjører synkront, så hold datoperioden rimelig. Valideringsfeil er de samme som for exports_create, inkludert kravet om Pro-planen for typer på radnivå. Ingenting lagres og ingen e-post sendes.

Tillatelse: analytics.export

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/exports/preview.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /exports/:id.json Hent en eksport og statusen exports_get

Returnerer én eksport, inkludert fremdriften. Bruk den for å spørre gjentatte ganger om en eksport startet med exports_create til status er complete eller failed. Statuser er queued, running, complete, failed og expired. Feltene omfatter id (exp_...), site_id (pa_...), kind, format, status, params (den lagrede definisjonen av eksporten), row_count (null til den er ferdig), error (satt når den feilet), completed_at, expires_at (filer beholdes 7 dager etter fullføring), download_url (satt bare mens filen kan lastes ned, bruk exports_download for å få en signert lenke) og created_at. id kommer fra exports_create eller exports_list.

Tillatelse: analytics.export

Eksempel
curl https://privatusanalytics.com/exports/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Etiketter for uttalelser

POST /sites/:site_id/testimonials/tags/:id/apply_rules.json Kjør en etiketts regler over uttalelsene som allerede er lagret testimonial_tags_apply_rules

dry_run true (standard) endrer ingenting og svarer med antallene: hvor mange som ville bli merket, av hvor mange, og hvor mange som allerede har etiketten. dry_run false merker dem som én massehandling og svarer med undo_id, som testimonials_bulk_undo tar i 7 dager. Mer enn 100 kjøres i bakgrunnen, og svaret har state running.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/tags/:id/apply_rules.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/tags.json Opprett en etikett, med autoetikettregler hvis du sender dem testimonial_tags_create

En regel er { match, conditions }. En uttalelse som oppfyller en hvilken som helst regel får etiketten i det øyeblikket den kommer inn. Regler legger bare til en etikett. For å merke det som allerede er lagret, kall testimonial_tags_apply_rules etterpå.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/tags.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/tags/:id.json Flytt en etikett til papirkurven i 30 dager testimonial_tags_destroy

Den forlater hver uttalelse, hvert filter og hver velger. Å gjenopprette den med testimonial_trash_restore setter den tilbake på hver uttalelse som hadde den. En smart samling hvis regler navngir den, treffer ingenting inntil da. Over MCP endrer verktøyet ingenting og svarer med siden i appen der en person gjør det.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/tags/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/tags.json List etikettene til et nettsted med reglene deres testimonial_tags_list

Hver etikett kommer med hvor mange uttalelser som har den, autoetikettreglene som strukturerte betingelser og på vanlig norsk, og når en regel sist brukte den. Etiketter i papirkurven utelates.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/tags.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/tags/:id/merge.json Slå en etikett sammen med en annen testimonial_tags_merge

Hver uttalelse som hadde denne etiketten får den andre, hver regel flyttes til den andre, hver smart samling, lagrede visning, widget og vegg som navnga denne etiketten navngir den andre, og denne etiketten går til papirkurven, tom. Svarer med etiketten som beholdes.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/tags/:id/merge.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
PATCH /sites/:site_id/testimonials/tags/:id.json Endre en etiketts navn, farge eller regler testimonial_tags_update

Bare det som sendes endres. Å sende rules erstatter hver regel på etiketten, og en tom liste fjerner dem alle.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/tags/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Fakturering

POST /workspaces/:workspace_id/billing/badge.json Meld deg på eller av merkebonusen (gratisplan) billing_badge

Melder et Free-arbeidsområde på eller av bonusen for Privatus Analytics-merket, som øker den månedlige hendelseskvoten. Sett enabled til true for å melde på. En bakgrunnskontroll ser deretter etter merket på arbeidsområdets nettsteder og verifiserer det, noe som kan ta litt tid, så les billing_get etterpå og se på badge.verified_at. Sett enabled til false for å melde av, noe som fjerner kontroll- og verifiseringsdatoene og tar bort bonusen. Å melde på i et Pro- eller Business-arbeidsområde avvises fordi betalte planer ikke har noen bonus. Returnerer faktureringsobjektet for arbeidsområdet som billing_get. Krever billing.manage.

Tillatelse: billing.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/billing/badge.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/billing/cancel.json Si opp ved slutten av faktureringsperioden billing_cancel

Sier opp det betalte abonnementet ved slutten av inneværende betalte periode. Ingenting refunderes, og planen forblir aktiv til current_period_ends_at, deretter går arbeidsområdet over til Free-planen. Bruk billing_resume for å angre før den tid. Feiler når arbeidsområdet ikke har noe abonnement eller en oppsigelse allerede er planlagt. Den valgfrie reason (en av enum-verdiene) og comment er en avgangsundersøkelse. En kommentar, hvis oppgitt, sendes på e-post til Privatus Analytics-teamet som en tilbakemelding fra medlemmet og lagres ikke. Returnerer faktureringsobjektet med cancel_at_period_end true. Krever billing.manage.

Tillatelse: billing.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/billing/cancel.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/billing/change_plan.json Endre plan, nivå eller intervall (forholdsmessig) billing_change_plan

Flytter det eksisterende abonnementet til en annen plan, hendelsesnivå eller faktureringsintervall. Dette belaster penger. Endringen trer i kraft umiddelbart og Paddle beregner forholdsmessig, så en belastning eller kreditt gjelder betalingsmåten som er registrert, med en gang. Kjør billing_preview først med de samme inputene for å se de eksakte beløpene. Feiler hvis arbeidsområdet ikke har noe abonnement (bruk billing_checkout for det), hvis målet er gjeldende plan, nivå og intervall, eller hvis det ikke finnes noen pris for kombinasjonen av plan og hendelser. Verdien for events må være ett av nivåene fra plans_list. Returnerer det oppdaterte faktureringsobjektet. Krever billing.manage.

Tillatelse: billing.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/billing/change_plan.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/billing/checkout.json Start en Paddle-kasse for en betalt plan billing_checkout

Starter en Paddle-betaling for et arbeidsområde som ikke har noe abonnement ennå, og returnerer en vertsbasert betalings-URL. Ingenting belastes før en person fullfører betalingen i en nettleser, så gi url til personen. Bruk billing_change_plan i stedet når arbeidsområdet allerede har et abonnement. Inputene er plan (pro eller business), events (et nivå for hendelser i måneden fra plans_list) og interval (month eller year, standard month). Prisene inkluderer MVA eller salgsskatt. Et godkjent rabattprogram brukes automatisk og rapporteres i discount_id. Returnerer transaction_id, url (kan være null), price_id, plan, events, interval, amount (hele USD for intervallet), client_token og environment (sandbox eller production, brukes av Paddle-overlegget), custom_data og discount_id (kan være null). Feiler hvis arbeidsområdet allerede har et abonnement. Krever billing.manage.

Tillatelse: billing.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/billing/checkout.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/billing/discount.json Søk om rabatt for ideelle organisasjoner, utdanning eller åpen kildekode billing_discount

Søker om et rabattprogram for arbeidsområdet. Dette sender inn en søknad til vurdering av ansatte og sender e-post til Privatus Analytics-teamet, det gir ikke rabatt i seg selv. Programmene er nonprofit, education, open_source (50 prosent rabatt), open_source_free (gratis Pro opptil 1 million hendelser i måneden) og agency (20 prosent rabatt på alle arbeidsområder du eier). Bare én åpen søknad (pending, approved eller active) er tillatt per arbeidsområde, og du kan søke på nytt etter en avvisning eller tilbakekalling. license beholdes bare for de to åpen kildekode-programmene. Returnerer søknaden med program, status, percent, comp_events (kan være null), organization_name, website, proof_url, license, note, rejection_reason, created_at, reviewed_at, applied_at og revoked_at (tidsstempler som kan være null). Sjekk fremdriften senere i discount-feltet i billing_get. Krever billing.manage.

Tillatelse: billing.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/billing/discount.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/billing/payment_method.json Få en lenke for å oppdatere betalingsmåten billing_payment_method

Returnerer en Paddle-lenke der en person kan oppdatere abonnementets betalingsmåte. Selve kallet endrer ingenting. Gi url til personen som skal åpne den i en nettleser. Resultatet har kind (payment_method) og url. Feiler når arbeidsområdet ikke har noe aktivt abonnement. For fakturaer, adresser og alle andre faktureringsdetaljer, bruk billing_portal. Krever billing.manage.

Tillatelse: billing.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/billing/payment_method.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/billing/portal.json Få en lenke til Paddle-kundeportalen billing_portal

Returnerer en lenke til Paddles kundeportal, der en person kan se fakturaer, betalingsmåter og adresser. Selve kallet endrer ingenting. Gi url til personen som skal åpne den i en nettleser. Resultatet har kind (portal) og url. Feiler hvis arbeidsområdet ikke har noen Paddle-kunde ennå (det har aldri betalt) eller når kunden deles med andre arbeidsområder som brukeren ikke har tilgang til, fordi portalen viser alle kundens data. Bruk billing_payment_method for bare kortet. Krever billing.manage.

Tillatelse: billing.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/billing/portal.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/billing/preview.json Forhåndsvis en planendring med forholdsmessig beregning billing_preview

Viser hva det ville kostet akkurat nå å flytte abonnementet til en annen plan, et annet nivå eller intervall, uten å endre noe. Kjør den alltid før billing_change_plan med de samme inputene plan, events og interval. Feiler hvis arbeidsområdet ikke har noe abonnement eller målet er lik gjeldende pris. Returnerer plan, events, interval, price_id, amount (hele USD i listepris for intervallet), currency, charge_minor (hva som ville blitt belastet nå), credit_minor (kreditt for ubrukt tid) og result_minor (nettobeløp), alle i minste valutaenheter, result_action (charge eller credit, kan være null), next_billed_at (kan være null) og warnings (strenger, for eksempel at forrige måneds bruk overstiger det nye nivået, eller plangrenser som nettsteder eller medlemmer som den nye planen ville brutt). Krever billing.manage.

Tillatelse: billing.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/billing/preview.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /workspaces/:workspace_id/billing/resume.json Angre en planlagt oppsigelse eller gjenoppta en pause billing_resume

Angrer en planlagt oppsigelse, eller gjenopptar et pauset abonnement, slik at planen fortsetter å fornyes. Bruk den etter billing_cancel og før current_period_ends_at. Et pauset abonnement gjenopptas umiddelbart. Feiler når det ikke finnes noen planlagt oppsigelse og abonnementet ikke er pauset. Returnerer det oppdaterte faktureringsobjektet. Krever billing.manage.

Tillatelse: billing.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/billing/resume.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/billing.json Hent planen, abonnementet og forbruket billing_get

Returnerer arbeidsområdets plan og faktureringstilstand. Bruk den før du endrer noe i faktureringen, og for å se om abonnementet er aktivt eller sies opp. Feltene omfatter workspace_id, plan (free, pro, business eller enterprise), plan_events (det solgte nivået for hendelser i måneden), allowance (hendelser i måneden som faktisk er tillatt, inkludert eventuell merkebonus), billing_interval (month eller year, kan være null), price (hele USD for intervallet, kan være null), subscription_status, current_period_ends_at, cancel_at_period_end (true når en oppsigelse er planlagt), canceled_at, auto_upgrade, discount (den siste rabattsøknaden, kan være null), discount_percent, billing_emails (matrise), tax_id, badge (opted_in, verified_at, checked_at og bonusstørrelsen) og usage (samme objekt som billing_usage returnerer). Krever billing.manage. Fakturaer finnes i billing_invoices_list, og en måned-for-måned-visning av bruk er billing_usage.

Tillatelse: billing.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/billing.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/billing.json Oppdater faktura-e-poster, avgiftsnummer og automatisk oppgradering billing_update

Oppdaterer arbeidsområdets faktureringsinnstillinger. Bare verdiene du sender, endres. billing_emails er en matrise med opptil 5 ekstra adresser for fakturaer og faktureringsvarsler og erstatter hele listen. tax_id lagres på arbeidsområdet og legges ikke til på fakturaer, så den må også oppgis i betalingen. auto_upgrade er false som standard. Når den er true, flytter arbeidsområdet seg til neste nivå og belaster differansen når den månedlige hendelsesgrensen nås, i stedet for at innsamlingen pauses. Hvis du slår den på mens innsamlingen allerede er pauset ved grensen, oppgraderes og belastes det umiddelbart og en bekreftelses-e-post sendes, og hvis Paddle avviser oppgraderingen, lagres ingenting. Returnerer faktureringsobjektet som billing_get. Krever billing.manage.

Tillatelse: billing.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X PATCH https://privatusanalytics.com/workspaces/:workspace_id/billing.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/billing/usage.json Hent forbruket denne måneden, prognosen og fordelingen per nettsted billing_usage

Returnerer arbeidsområdets hendelsesbruk for én måned. Bruk den for å sjekke hvor nær arbeidsområdet er den harde månedlige grensen. Input er month (en hvilken som helst dag i måneden, standard er inneværende måned). Bare sidevisninger og egendefinerte hendelser teller. Feltene er month, events, bots (samlet antall roboter, faktureres ikke), allowance, percent (0 til 100 og høyere, ett desimal), forecast og forecast_percent (lineær fremskriving til månedsslutt, null for tidligere måneder), days_left, status (ok, warning ved 80 prosent, over ved 100 prosent, paused eller locked), sites (per nettsted site_id, domain, name, events og share i prosent, størst først), history (tidligere måneder som month og events), access_locked_at, collection_paused (true når nye hendelser forkastes), pause_reason (limit eller staff, kan være null), collection_paused_at og resumes_at (den 1. neste måned når pauset av grensen). Krever billing.manage.

Tillatelse: billing.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/billing/usage.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /workspaces/:workspace_id/billing/invoices.json List fakturaer billing_invoices_list

Lister arbeidsområdets faktureringstransaksjoner, nyeste først. Hvert element har id (bruk den med billing_invoices_get), invoice_number (kan være null), status, amount_minor (heltall i minste valutaenheter, så 900 betyr 9,00), currency (ISO-kode som USD) og billed_at (ISO 8601, kan være null). Har sideinndeling med page og per_page (maksimum 100). Den lister bare transaksjoner. For å hente PDF-en, kall billing_invoices_get, og for å oppdatere kortet, bruk billing_payment_method. Krever billing.manage.

Tillatelse: billing.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/billing/invoices.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /workspaces/:workspace_id/billing/invoices/:id.json Hent PDF-lenken for en faktura billing_invoices_get

Returnerer en lenke til PDF-fakturaen for én fakturert transaksjon. Hent faktura-ID-en fra billing_invoices_list (id-feltet, en Paddle-transaksjons-ID). Resultatet har kind (invoice) og url, som er en lenke til PDF-en fra Paddle, så hent eller del den like etter kallet. Feiler hvis ID-en ikke tilhører dette arbeidsområdet eller Paddle ikke har noen faktura for den. Krever billing.manage.

Tillatelse: billing.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/billing/invoices/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Fjerningsforespørsler

POST /sites/:site_id/testimonials/removal_requests/:id/dismiss.json Avvis en fjerningsforespørsel testimonial_removal_requests_dismiss

Lukker forespørselen med et notat og lar uttalelsen bli vist der den vises. Ingenting slettes, og ingen e-post sendes til personen som spurte. Notatet er påkrevd. En forespørsel som allerede er avgjort, svarer med 422.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/removal_requests/:id/dismiss.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/removal_requests.json List fjerningsforespørslene til et nettsted testimonial_removal_requests_list

Åpne forespørsler med mindre en annen status etterspørres. E-posten giveren skrev returneres bare til en kaller som kan endre innhold.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/removal_requests.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/removal_requests/:id/resolve.json Avgjør en fjerningsforespørsel testimonial_removal_requests_resolve

trash flytter uttalelsen til papirkurven, som tar den av hver widget, vegg og offentlig side med en gang og kan angres i 30 dager. dismiss lar den bli stående og krever et notat.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/removal_requests/:id/resolve.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/removal_requests/:id.json Hent én fjerningsforespørsel testimonial_removal_requests_get

Én forespørsel med uttalelsen den gjelder, notatet personen la igjen, om e-posten de skrev stemmer med e-posten på uttalelsen, hvor mange ganger de spurte og avgjørelsen når det finnes en. Selve e-posten returneres bare til en kaller med content.write.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/removal_requests/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Flyttinger av uttalelser

POST /sites/:site_id/testimonials/imports/migrations/:id/discard.json Forkast det en flytting leste testimonial_migrations_discard

Oppgi item_ids (id-er fra testimonial_migrations_review) eller all true for alt som fortsatt venter, aldri begge. Et forkastet element forlater gjennomgangstrinnet, og det som ble lest om personen slettes. Ingen uttalelse slettes. Ellers svarer serveren med 422 og koden selection eller unknown_ids.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/imports/migrations/:id/discard.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/imports/migrations.json List flyttingene til et nettsted testimonial_migrations_list

Nyeste først. En flytting er én eksportfil fra et annet verktøy for uttalelser. Hver har verktøyet den kom fra, statusen og hvor mange uttalelser som ble funnet, beholdt, duplikater og mislyktes.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/imports/migrations.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/imports/migrations/:id/keep.json Behold det en flytting leste som uttalelser testimonial_migrations_keep

Oppgi item_ids (opptil 100 per kall, fra testimonial_migrations_review) eller all true, aldri begge. Hvert beholdte element blir en uttalelse med status pending eller approved, og keep_approval true beholder godkjenningen den hadde i det andre verktøyet. Med all utelates sannsynlige duplikater med mindre include_likely_duplicates er true. Ingenting beholdt teller mot de månedlige uttalelsene. Det som ikke beholdes, blir værende i gjennomgangstrinnet i 30 dager.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/imports/migrations/:id/keep.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/imports/migrations/:id/review.json List det en flytting leste og som ikke er avgjort ennå testimonial_migrations_review

Lister elementene som fortsatt venter på en avgjørelse, nyeste kjøring først. show er new, duplicates eller all (standard), og rating beholder bare de oppførte stjernevurderingene. Send element-id-ene til testimonial_migrations_keep eller testimonial_migrations_discard.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/imports/migrations/:id/review.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/imports/migrations/:id.json Hent fremdriften og antallene til en flytting testimonial_migrations_get

Returnerer verktøyet filen kom fra, statusen, hvor mange uttalelser som ble funnet, beholdt, duplikater og mislyktes, hvor mange mediefiler den bringer og når den startet og ble ferdig. Spør den jevnlig mens statusen sier at filen fortsatt leses.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/imports/migrations/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Forespørsler om eget domene for uttalelser

POST /sites/:site_id/testimonials/settings/custom_domain.json Be om eget domene på en vegg eller på skjemaer testimonial_custom_domain_requests_create

Egne domener for uttalelser settes opp for hånd av teamet i Privatus Analytics. Dette lagrer forespørselen og gir teamet beskjed, som sender DNS-oppføringen som skal legges til på e-post. Vertsnavnet fungerer ikke før forespørselens status er active. Business og oppover: andre planer får 402 plan_limit.

Tillatelse: sites.manage

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/settings/custom_domain.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/settings/custom_domain.json Trekk tilbake en forespørsel om eget domene, ut fra vertsnavnet testimonial_custom_domain_requests_delete

Bare en forespørsel teamet ikke har begynt på (status requested) kan trekkes tilbake. En som er under arbeid svarer med wrong_state. Over MCP endrer verktøyet ingenting og svarer med siden i appen der en person gjør det.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/settings/custom_domain.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/settings/custom_domain.json List forespørslene om eget domene for et nettsted testimonial_custom_domain_requests_list

Hver forespørsel om et vertsnavn på en vegg eller på skjemaer, nyeste først, med statusen. Vertsnavnet fungerer først når status er active. Fungerer på alle planer, så tidligere forespørsler kan fortsatt leses.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/settings/custom_domain.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Forespørsler om uttalelser

POST /requests/resubscribe/:token.json Bekreft at du vil motta forespørsler om uttalelser igjen testimonial_request_resubscribes_confirm

POST-kallet bak knappen på bekreftelsessiden. Det opphever avmeldingen, så adressen kan spørres igjen.

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/requests/resubscribe/:token.json \
  -H "Content-Type: application/json" -d '{…}'
POST /requests/resubscribe.json Be om e-posten som lar en adresse motta forespørsler igjen testimonial_request_resubscribes_create

Sender en bekreftelses-e-post til selve adressen, når den hadde meldt seg av. Svaret er det samme enten den hadde det eller ikke.

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/requests/resubscribe.json \
  -H "Content-Type: application/json" -d '{…}'
POST /requests/unsubscribe/:token.json Meld en adresse av forespørsler om uttalelser testimonial_request_unsubscribes_create

POST-kallet bak knappen på avmeldingssiden, og det en e-postapps egen avmeldingsknapp kaller. Tokenet kommer fra lenken i e-posten.

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/requests/unsubscribe/:token.json \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/requests.json Start en forespørsel som utkast testimonial_requests_create

Oppretter et utkast med e-posten og mottakerne. Ingenting sendes før testimonial_requests_send. Alt som utelates starter fra en standard: e-posten, én oppfølging etter 5 dager, nettstedets navn som avsender og deg som svaradresse. Hver mottaker lagres som queued, eller som skipped med årsaken.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/requests.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/requests/:id.json Slett et utkast testimonial_requests_delete

Bare en forespørsel som aldri er sendt kan slettes. En sendt forespørsel beholdes som oversikt over e-post som ble sendt. Over MCP endrer verktøyet ingenting og svarer med siden i appen der en person gjør det.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/requests/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/requests/:id/duplicate.json Kopier en forespørsel til et nytt utkast testimonial_requests_duplicate

Kopien har samme skjema og e-post, og ingen mottakere ennå.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/requests/:id/duplicate.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/requests.json List forespørslene til et nettsted testimonial_requests_list

Nyeste først, hver med e-posten og trakttallene. Filtrer etter status, skjema eller periode.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/requests.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/requests/:id/preview.json Se én e-post fra en forespørsel slik den første mottakeren får den testimonial_requests_preview

Avsenderen, emnet og innholdet med flettefeltene fylt ut. Ingenting sendes. step 0 er den første e-posten, 1 til 3 oppfølgingene.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/requests/:id/preview.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/requests/:id/resume.json Gjenoppta en stoppet forespørsel testimonial_requests_resume

Fortsetter der den stoppet. En oppfølging som forfalt mens den var stoppet, får ny tid fra nå, så ingenting går ut i en klump. Dette sender e-post til personer utenfor arbeidsområdet, så medlemmet får en e-post om at en assistent gjenopptok den.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/requests/:id/resume.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/requests/:id/send.json Send en forespørsel, nå eller på et tidspunkt testimonial_requests_send

Krever confirm_relationship: true. De køede mottakerne kontrolleres én gang til, deretter går de første e-postene ut (eller venter på send_at). Oppfølginger går til de som ikke har svart. Forespørsels-e-poster sendes gjennom nettstedets egen e-posttjeneste (Innstillinger > E-postsending, Business og oppover), så et nettsted uten fungerende tilkobling får 422 no_email_connection eller email_connection_paused, og en annen plan får 402 plan_limit. Hver e-post teller mot nettstedets månedlige tak for forespørsels-e-poster (10 000 med mindre vi setter et annet). Ved taket slippes ingenting: personene blir stående i kø, og sendingen fortsetter den 1. Dette sender e-post til personer utenfor arbeidsområdet, så medlemmet får en e-post om at en assistent sendte det.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/requests/:id/send.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/requests/:id/send_test.json Send én e-post fra en forespørsel til din egen adresse testimonial_requests_send_test

Går bare til kallerens egen adresse, gjennom nettstedets egen e-posttjeneste som de ekte (422 no_email_connection uten). Den har ingen personlig lenke og ingen åpningsteller, og teller ikke mot nettstedets månedlige tak.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/requests/:id/send_test.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/requests/:id.json Hent én forespørsel med e-post, oppfølginger og trakttall testimonial_requests_get

Returnerer e-posten, oppfølgingene, statusen og trakttallene (sent, opened, clicked, submitted, bounced, unsubscribed) for én forespørsel.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/requests/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/requests/:id/stop.json Stopp en forespørsel testimonial_requests_stop

Avbryter hver e-post som ikke er sendt ennå, med en gang. Ingenting som allerede er sendt påvirkes, og testimonial_requests_resume fortsetter der den stoppet.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/requests/:id/stop.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
PATCH /sites/:site_id/testimonials/requests/:id.json Endre en forespørsels navn, skjema eller e-post testimonial_requests_update

Tillatt når som helst. En endring gjelder hver e-post som ikke er sendt ennå. Å endre forsinkelsen til en oppfølging setter ny tid på oppfølgingene som venter.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/requests/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Hendelser

GET /sites/:site_id/events/properties.json List egenskapsnøkler for hendelser sett de siste 30 dagene event_properties_list

Lister egenskapsnøklene som egendefinerte hendelser hadde de siste 30 dagene, med visningsinnstillinger. Returnerer en liste av {key, events, display_name, hidden, export_safe}. events er hvor mange egendefinerte hendelser som hadde nøkkelen (0 for en nøkkel som har innstillinger men ikke ble sett nylig), display_name er det nye navnet (null når det ikke finnes), hidden sier at nøkkelen er skjult fra rapporter, og export_safe sier at den er merket som uten personopplysninger. Maksimalt 200 nøkler returneres, mest brukte først. Send event for å se bare nøkler sett på ett rått hendelsesnavn. Egenskapsverdier returneres aldri her, bruk stats_breakdown med dimension prop:<key> eller events_get for verdier. Endre innstillinger med event_properties_update.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/events/properties.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/events/properties.json Gi en egenskapsnøkkel for hendelser nytt navn eller skjul den event_properties_update

Gir nytt navn til, skjuler eller merker som eksporttrygg én hendelsesegenskapsnøkkel, for hele nettstedet. Bare verdiene du sender, endres. key må være nøkkelen slik den er lagret (små bokstaver, sifre og understreker, opptil 64 tegn, for eksempel plan). display_name er en etikett på opptil 64 tegn (send den tom for å fjerne det nye navnet). hidden fjerner nøkkelen fra rapporter og hendelsesdetaljens pivot mens dataene beholdes. export_safe erklærer at nøkkelen aldri inneholder personopplysninger, noe som tar med verdiene i rå eksporter og lagersynkroniseringer, så sett den bare når det er sant. Nye navn og skjuling gjelder når rapporter leses og skriver ikke om lagrede data. Returnerer {key, display_name, hidden, export_safe}. Trenger tillatelsen sites.manage. List nøklene med event_properties_list.

Tillatelse: sites.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/events/properties.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/events.json Slett en hendelse og historikken (kjører i bakgrunnen, bekreft ved å skrive navnet) events_delete

Sletter en egendefinert hendelse og hele historikken permanent. Dette kan ikke angres. Det rå hendelsesnavnet må sendes to ganger, i name og igjen i confirm, som en sikkerhetskontroll. Returnerer {name, status: queued} med HTTP 202 fordi radene fjernes i bakgrunnen i partier, så tallene fortsetter å endre seg til det er ferdig. Hendelsen skjules også med en gang, og slettingen registreres i revisjonsloggen. Sidevisninger påvirkes ikke. Hvis du bare vil slutte å vise en hendelse, bruk events_update med hidden true, som beholder dataene. Trenger tillatelsen sites.manage. Navn kommer fra events_list (bruk feltet raw_names hvis hendelsen har fått nytt navn eller er slått sammen).

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/events.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/events.json List hendelser med fullføringer, besøk, konverteringsrate og første/siste gang sett events_list

Hendelsesutforskeren: alle egendefinerte hendelser i perioden. Returnerer period, events og hidden. Hver hendelse har name (visningsnavnet etter nye navn og sammenslåinger), raw_names (navnene trackeren sendte), completions, visits, conversion_rate (prosent av besøk, 0 til 100), revenue (minste enheter, cent), first_seen og last_seen (ISO 8601-tidsstempler innenfor perioden) og currency (inntektsvalutaen, null når den ikke er satt). hidden lister hendelser du skjulte som {name, display_name}. Bruk search for å beholde hendelser der navnet inneholder en tekst. Sidevisninger er ikke hendelser her. Bruk events_get for én hendelse i dybden og stats_breakdown med dimension event for en rangert liste med sideinndeling. Tar de felles inputene period, compare, filters og segment.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/events.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/events/merge.json Slå sammen flere hendelser til ett visningsnavn events_merge

Slår sammen flere rå hendelsesnavn til ett visningsnavn, for eksempel signup_click og signup_button til Signup. Rapporter viser da én enkelt hendelse med de samlede tallene. Det virker når rapporter leses, og de lagrede hendelsene endres eller slettes ikke. Send names (de rå navnene, minst ett) og into (visningsnavnet). Returnerer ett innstillingsobjekt per sammenslått navn, hver {name, display_name, hidden, currency, updated_at}. For å angre, kall events_update for et navn med tom display_name. Trenger tillatelsen sites.manage. Navn kommer fra events_list (raw_names).

Tillatelse: sites.manage

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/events/merge.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/events/detail.json Én hendelse: diagram, egenskapspivot, aggregater for tallegenskaper, sider og kilder events_get

Detaljer for én egendefinert hendelse. Send name nøyaktig slik den vises i events_list (visningsnavnet etter nye navn og sammenslåinger). Returnerer period, name, raw_names (de lagrede navnene bak den), interval, totals, setting, series, property_keys, pivot, numeric, pages, channels og referrers. totals har completions, visits (besøk som utløste den), revenue (minste enheter, cent) og conversion_rate (prosent av alle besøk i perioden). series er fullføringer per tidsintervall. setting har display_name, hidden og currency. property_keys lister egenskapsnøklene som er sett. Send properties (opptil 3 nøkler) for å få pivot, rader av {values, completions, visits} for hver kombinasjon av verdier, de 100 øverste. numeric gir sum, gjennomsnitt og andre tall for egenskaper som inneholder tall. pages, channels og referrers er de 10 øverste stedene hendelsen ble utløst, som {value, completions, visits}. Bruk events_list for alle hendelser, stats_breakdown med dimension prop:<key> for én egenskap på tvers av nettstedet, og events_update for å gi den nytt navn.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/events/detail.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/events/settings.json Gi en hendelse nytt navn, skjul eller vis den, eller angi valutaen events_update

Endrer hvordan én egendefinert hendelse vises: gi den nytt navn med display_name, skjul eller vis den med hidden, eller sett inntektsvalutaen. name er det rå hendelsesnavnet slik trackeren sendte det (se raw_names i events_list). Bare verdiene du sender, endres. En tom display_name fjerner det nye navnet. hidden fjerner hendelsen fra lister og rapporter mens dataene beholdes. currency er en ISO 4217-kode på tre bokstaver som USD, lagret med store bokstaver. Dette virker når rapporter leses, og ingen lagrede hendelser skrives om. Returnerer {name, display_name, hidden, currency, updated_at}. For å kombinere flere hendelser, bruk events_merge, og for å slette data, bruk events_delete. Trenger tillatelsen sites.manage.

Tillatelse: sites.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/events/settings.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Hjelp og tilbakemelding

POST /help.json Send et spørsmål eller en tilbakemelding til teamet i Privatus Analytics support_message_send

Meldingen sendes på e-post til teamet med opplysninger om kontoen, arbeidsområdet og planen din vedlagt. Svaret og en kvittering sendes til e-postadressen på kontoen din. Opptil 10 meldinger per dag.

Tillatelse: member

Eksempel
curl -X POST https://privatusanalytics.com/help.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Importer

DELETE /sites/:site_id/imports/google/connection.json Koble fra Google Analytics-kontoen din og slett de lagrede tilgangstokenene imports_google_disconnect

Fjerner den lagrede Google Analytics-tilkoblingen til medlemmet som kaller for dette nettstedets arbeidsområde, slik at GA4-importer ikke lenger kan lese fra Google før den kobles til igjen i appen. Data som allerede er importert, blir værende og fjernes bare ved å slette importen med imports_delete. Tilgangen tilbakekalles ikke på Google-siden. Den feiler med en valideringsfeil når det ikke finnes noen tilkobling, eller mens en av medlemmets GA4-importer er i kø eller under kjøring. Returnerer et objekt med disconnected true. Tilkobling gjøres i appen (Google-innloggingsskjermen), det finnes ikke noe verktøy for det.

Tillatelse: sites.manage

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/imports/google/connection.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/imports/google/properties.json List Google Analytics 4-egenskaper som kan importeres imports_google_properties

Lister Google Analytics 4-egenskapene som det tilkoblede Google-kontoen til medlemmet som kaller, kan lese. Kall den før imports_create med source ga4 for å få property_id som skal brukes. Returnerer en liste av objekter med id (som properties/123456789, send den som property_id), name og account. Den feiler med en valideringsfeil når medlemmet ikke har koblet til Google for dette arbeidsområdet (gjøres i appen, det finnes ikke noe verktøy for det) eller når Google avviser forespørselen. Den gjør et live-kall til Google og endrer ingenting.

Tillatelse: sites.manage

Eksempel
curl https://privatusanalytics.com/sites/:site_id/imports/google/properties.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/imports.json Start en import (GA4-egenskap eller CSV-opplasting) imports_create

Starter en import av historiske data fra et annet analyseverktøy til et nettsted, behandlet i bakgrunnen, og returnerer importen med status queued. Velg source ga4 for å hente fra Google Analytics 4 API-et, som trenger en Google-tilkobling laget i appen, property_id (fra imports_google_properties) og date_from. date_to er som standard dagen før nettstedets første sporede hendelse, eller i går. Andre kilder (universal_analytics, fathom, simple_analytics, plausible, matomo, umami, clicky) tar en CSV-eksport lastet opp som file-input (multipart-skjemaopplasting, opptil 50 MB), noe som gjør dem upraktiske å starte via MCP og best gjort i appen. dimension trengs bare for å overstyre gjenkjenningen av hva CSV-radene deles opp etter, for eksempel Matomo Label-eksporter. Importerte rader teller aldri mot hendelseskvoten og vises bare i statistikk når du sender include_imported true. Et arbeidsområde kan ha høyst 5 importer i kø eller under kjøring samtidig. Spør imports_get gjentatte ganger til status er complete eller failed. Trenger tillatelsen sites.manage.

Tillatelse: sites.manage

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/imports.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/imports/:id.json Slett en import og alle importerte data imports_delete

Sletter en import permanent sammen med alle radene den tok med og den opplastede filen. Statistikk som inkluderte de importerte dataene, endres med en gang når include_imported er på, og dette kan ikke angres, selv om du kan importere på nytt. id kommer fra imports_list og trenger site_id. Returnerer den slettede importen. Trenger tillatelsen sites.manage. Data samlet inn av trackeren berøres ikke.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/imports/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/imports.json List importer for et nettsted imports_list

Lister importene for et nettsted, nyeste først. Bruk den for å finne en import-ID eller sjekke om en fortsatt kjører. Filtrer eventuelt etter status (queued, running, complete eller failed). Har sideinndeling med page og per_page (opptil 100). Hvert element har id, site_id, source, status, date_from, date_to, rows_imported, error, completed_at og created_at. Se imports_get for detaljer og imports_create for å starte en.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/imports.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/imports/:id.json Hent en import og statusen imports_get

Returnerer én import for et nettsted, brukt til å spørre gjentatte ganger om en import startet med imports_create. Feltene er id (imp_...), site_id, source, status (queued, running, complete eller failed), date_from og date_to (YYYY-MM-DD, null når ukjent), rows_imported (antall importerte daglige rader), error (satt når den feilet), completed_at og created_at. id kommer fra imports_create eller imports_list. Importerte rader vises bare i statistikk når statistikkallet setter include_imported true.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/imports/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Importkilder for uttalelser

POST /sites/:site_id/testimonials/imports/sources.json Legg til en importkilde fra en lenke og start den første kjøringen testimonial_import_sources_create

Plattformen oppdages fra lenken. Det kjøringen finner, venter i gjennomgangstrinnet (testimonial_import_sources_review), og ingenting lagres før testimonial_import_sources_keep. Ingenting importert teller mot de månedlige uttalelsene. Free-planen henter 1 import i måneden fra et anmeldelsesnettsted eller en side. Utover det er svaret 402 plan_limit.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/imports/sources.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/imports/sources/:id.json Slett en kilde. Uttalelsene den brakte inn blir værende testimonial_import_sources_delete

Sletter kilden med kjøringshistorikken, det som venter i gjennomgangstrinnet og den opplastede filen. Uttalelser som allerede er beholdt fra den blir værende på nettstedet. En person gjør dette på kildens side, så verktøyet kjører ingenting og returnerer den siden.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/imports/sources/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/imports/sources/:id/discard.json Forkast funnede elementer testimonial_import_sources_discard

Oppgi item_ids (id-er fra testimonial_import_sources_review) eller all true for alt som fortsatt venter, aldri begge. Et forkastet element forlater gjennomgangstrinnet, og det som ble lest om personen slettes. Ingen uttalelse slettes. Ellers svarer serveren med 422 og koden selection eller unknown_ids.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/imports/sources/:id/discard.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/imports/find.json Finn uttalelser på nettstedets eget nettsted testimonial_import_sources_find

Leser nettstedets domene og sidene det lenker til som ser ut til å inneholde uttalelser, én gang per nettsted. Det er gratis: det er ikke en av Free-planens hentede importer. Det den finner, venter i gjennomgangstrinnet til kilden den returnerer.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/imports/find.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/imports.json List importkildene til et nettsted testimonial_import_sources_list

meta inneholder fetched_imports (used, limit og resets_on for måneden, limit null er ubegrenset) og sync (tempoet planen tillater).

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/imports.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/imports/sources/:id/keep.json Behold funnede elementer som uttalelser testimonial_import_sources_keep

Oppgi item_ids (opptil 100) eller all. Hvert beholdte element lagres gjennom samme rute som enhver annen uttalelse, så duplikater lagres aldri to ganger. Ingenting beholdt teller mot de månedlige uttalelsene. meta sier hvor mange som ble beholdt.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/imports/sources/:id/keep.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/imports/platforms.json List plattformene en import kan lese testimonial_import_platforms_list

Registeret over testede kilder. En plattform listes først når importen er bevist mot en ekte side. Hver oppføring sier hvilken lenke som skal limes inn.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/imports/platforms.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/imports/sources/:id/review.json List det en kilde fant og som ikke er avgjort ennå testimonial_import_sources_review

meta inneholder antall per merke (new, already_here, likely_duplicate).

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/imports/sources/:id/review.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/imports/sources/:id/run.json Les en kilde på nytt nå testimonial_import_sources_run

En kjøring for hånd er en hentet import og teller som en av månedens på Free-planen (402 plan_limit utover det). Avvises mens en kjøring er aktiv (422 in_progress) og etter 3 kjøringer av kilden på 24 timer på alle planer (422 too_many_runs). På en kilde med feil nullstiller den tellingen av feil.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/imports/sources/:id/run.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/imports/sources/:id.json Hent én importkilde med status og antall testimonial_import_sources_get

Returnerer plattformen, navnet, adressen som leses, hvor ofte den leses på nytt, statusen, hvor mange elementer som venter i gjennomgangstrinnet, hvor mange som ble beholdt, feilene på rad og når den sist kjørte og kjører neste gang.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/imports/sources/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/imports/sources/:id.json Endre en kildes lenke, navn, synkronisering, automatisk godkjenning, eller sett den på pause testimonial_import_sources_update

En synkronisering over planen (noen som helst på Free, ukentlig på Pro) avvises med 402 plan_limit.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/imports/sources/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Importkjøringer for uttalelser

GET /sites/:site_id/testimonials/imports/sources/:import_source_id/runs.json List kjøringene til en kilde, nyeste først testimonial_import_runs_list

Hver kjøring har nummeret sitt, hva som startet den, statusen, sidene som ble lest og hvor mange uttalelser den fant, hvor mange som var nye, duplikater, mislyktes og ble beholdt, med tidspunktene den startet og ble ferdig.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/imports/sources/:import_source_id/runs.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Innsamling

POST /embed/ads/e.json Registrer at et annonsemotiv ble vist, sett eller klikket, kalt av annonselasteren ad_serving_event

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/embed/ads/e.json \
  -H "Content-Type: application/json" -d '{…}'
GET /embed/ads/:site.json Et nettsteds annonseplasser og annonsemotivene hver av dem viser, kalt av annonselasteren ad_serving_slots

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/embed/ads/:site.json
POST /api/overlay.json Klikkene på én side til klikklaget, hentet av pa.overlay.js med adgangsnøkkelen sin click_overlays_read

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/api/overlay.json \
  -H "Content-Type: application/json" -d '{…}'
POST /api/logs.json Send servertilgangslogger for rapportering om AI-roboter (JSON {lines: [...]} eller kombinert logtekst, med nettstedets nøkkel for crawlerlogger som Bearer-token) crawler_logs_create

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/api/logs.json \
  -H "Content-Type: application/json" -d '{…}'
POST /api/event.json Samle inn et nettlesertreff (brukes av /js/pa.js) ingest_event

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/api/event.json \
  -H "Content-Type: application/json" -d '{…}'
GET /api/experiment.json Om et eksperiment sender denne besøkende til en variantside, kalt av eksperimentenes head-skript ingest_experiment

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/api/experiment.json
GET /js/exp/:site.json Skriptet som den valgfrie head-taggen for eksperimenter laster for et nettsted ingest_experiment_script

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/js/exp/:site.json
POST /api/survey.json Registrer at et undersøkelseskort ble vist, avvist eller besvart ingest_survey

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/api/survey.json \
  -H "Content-Type: application/json" -d '{…}'
GET /api/surveys.json Hvilken undersøkelse som skal vises på en side, kalt av spørremodulen i sporeren ingest_surveys

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/api/surveys.json

Kampanjer

POST /sites/:site_id/campaigns/costs.json Angi utgiftene for en kampanje i en måned campaign_costs_create

Registrerer annonseforbruk for én kampanje i én måned, slik at campaigns_list kan vise kostnad per ervervelse og avkastning på annonseforbruk. Hvis en oppføring for samme kampanje og måned allerede finnes, erstattes den og dupliseres ikke, så det er også trygt å kalle den to ganger. campaign er utm_campaign-verdien slik den står i sporede lenker, month er YYYY-MM (en full dato som 2026-09-15 godtas og avrundes til den første i måneden), og amount er i hovedenheter som et tall (1250.50, ikke minste enheter). currency er en valgfri ISO-kode på 3 bokstaver og er som standard nettstedets valuta. Svaret returnerer den lagrede oppføringen med amount_minor i minste enheter. For mange rader samtidig, bruk campaign_costs_import. Trenger content.write. Krever planen Business eller Enterprise (ellers 402 plan_limit).

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/campaigns/costs.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/campaigns/costs/:id.json Slett en kampanjekostnad campaign_costs_delete

Sletter én forbruksoppføring permanent, funnet med id fra campaign_costs_list. Dette kan ikke angres, og CPA og ROAS for den kampanjen og måneden slutter umiddelbart å inkludere forbruket. Andre måneder og kampanjer berøres ikke. Returnerer den slettede oppføringen. Trenger content.write. Krever planen Business eller Enterprise (ellers 402 plan_limit).

Tillatelse: content.write

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/campaigns/costs/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/campaigns/costs/import.json Importer kampanjekostnader fra CSV (campaign,month,amount[,currency]) campaign_costs_import

Importerer annonseforbruk i bulk fra CSV, den raske måten å laste inn mange kampanjer og måneder på. Send CSV-teksten i csv (best for verktøy og API-kall) eller last opp en fil i file (bare multipart). Første rad må være en overskrift som inneholder campaign, month og amount, med en valgfri kolonne currency, for eksempel campaign,month,amount,currency og deretter spring_sale,2026-09,1250.50,USD. Month er YYYY-MM, amount er i hovedenheter, currency er som standard nettstedets valuta. Rader oppdateres eller opprettes etter kampanje og måned, så å importere samme fil på nytt gir ikke duplikater. Grensene er 1 MB og 5000 rader. En dårlig rad stopper ikke importen. Svaret har imported (antall lagret), failed (antall avvist) og errors (de første 50 meldingene, hver med navn på raden, der rad 2 er den første datarraden). En manglende overskriftskolonne, en for stor fil eller ugyldig CSV får hele forespørselen til å feile. Trenger content.write. Krever planen Business eller Enterprise (ellers 402 plan_limit).

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/campaigns/costs/import.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/campaigns/costs.json List kampanjekostnader campaign_costs_list

Lister annonseforbruksoppføringene registrert for et nettsted, nyeste måned først, deretter etter kampanjenavn. Hver rad er én kampanje i én måned med amount_minor (et heltall i minste valutaenheter, så 125050 betyr 1250,50), currency (ISO 4217, store bokstaver), month som YYYY-MM og oppførings-id (en UUID, bruk den til campaign_costs_update og campaign_costs_delete). Send campaign for å se bare én kampanje (treff uavhengig av store og små bokstaver på utm_campaign-verdien). Har sideinndeling med page og per_page (maks 100). Kostnader mates inn i CPA og ROAS i campaigns_list, så her sjekker du hvilket forbruk en kampanje har. Trenger analytics.read. Krever planen Business eller Enterprise (ellers 402 plan_limit).

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/campaigns/costs.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/campaigns/costs/:id.json Endre en kampanjekostnad campaign_costs_update

Endrer en eksisterende forbruksoppføring, funnet med id fra campaign_costs_list. Bare verdiene du sender, endres, så send bare amount for å rette et tall. amount er i hovedenheter (1250.50) og lagres som minste enheter, month er YYYY-MM, currency er en ISO-kode på 3 bokstaver. Å endre campaign eller month til en kombinasjon som en annen oppføring allerede har, feiler med en valideringsfeil i stedet for å slå sammen. For å rette forbruket for en kampanje og måned uten å kjenne id-en, kall campaign_costs_create, som erstatter den eksisterende oppføringen. Trenger content.write. Krever planen Business eller Enterprise (ellers 402 plan_limit).

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/campaigns/costs/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/campaigns/builder.json Bygg og valider en URL med UTM-koder campaigns_builder

Bygger en UTM-merket URL for en landingsside og kontrollerer verdiene. Ingenting lagres og ingen data leses, så det er trygt å kalle gjentatte ganger. Send destination (en full https://-URL) pluss utm_source, utm_medium, utm_campaign, utm_content og utm_term etter behov, eller velg en forhåndsinnstilling (newsletter, social, paid_search og så videre) for å fylle ut utm_source og utm_medium når du lar dem stå tomme. Returnerer url (null ved feil), valid, destination, preset, de rensede utm_*-verdiene, issues (en liste av {field, level, message}, der level error blokkerer URL-en og warning bare foreslår en rettelse som små bokstaver) og presets (de tilgjengelige verdiene for preset). Verdier renses til små bokstaver uten mellomrom. Bruk campaigns_hygiene for å finne rotete UTM-verdier som allerede finnes i trafikken din og campaigns_list for å rapportere om kampanjer som har kjørt. For å beholde en merket lenke med en kort URL og klikktelling, bruk links_create i stedet.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/campaigns/builder.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/campaigns/hygiene.json UTM-hygiene: nesten like verdier, stilproblemer og ukjente kilder campaigns_hygiene

Finner rotete UTM-verdier i trafikken for en periode, slik at du kan rette merkingen. Returnerer period, duplicates, style_issues og unknown_sources. duplicates grupperer verdier av utm_source, utm_medium eller utm_campaign som bare skiller seg i store og små bokstaver, mellomrom eller tegnsetting (Facebook, facebook og face-book), hver som {field, suggestion, variants: [{value, visits}]} med den mest besøkte skrivemåten foreslått. style_issues lister verdier som bryter konvensjonen om små bokstaver og ingen mellomrom, som {field, value, visits, suggestion} (opptil 50). unknown_sources lister utm_source-verdier som ikke er en gjenkjent kanal, som {value, visits} (opptil 50). Bare de 500 øverste verdiene per felt skannes. Antall er besøk. Forslag er kun råd, og ingenting endres. For å slå sammen varianter til én kanal, bruk channel_rules_create. Tar de felles inputene period og filters. Bruk campaigns_list for ytelse og campaigns_builder for å lage rene merkede URL-er.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/campaigns/hygiene.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/campaigns.json Kampanjeoppsummering med konverteringer, inntekt, kostnad, CPA og ROAS campaigns_list

Kampanjeytelsesrapport bygget på utm_campaign, med kostnad og avkastning på annonseforbruk. Returnerer period, currency (nettstedets valuta), goal_id og goal_name (målet hvis konverteringer telles), campaigns, totals og unconverted_costs. Hver kampanje har visitors, visits, conversions, conversion_rate (prosent fra 0 til 100, konverteringer delt på besøk), revenue og sources (rader per kilde og medium med de samme metrikkene). Når kostnader finnes (fra campaign_costs_list), har en kampanje også cost, cpa (kostnad per konvertering, null når det ikke finnes konverteringer) og roas (inntekt delt på kostnad, et forhold som 2.5, null når det ikke er noen kostnad). Penger (revenue, cost, cpa) er et heltall i minste enheter (cent) i nettstedets valuta. Kostnader kobles til kampanjenavn uavhengig av store og små bokstaver og fordeles forholdsmessig etter dagene i hver måned innenfor perioden. En kampanje med kostnad men uten trafikk blir likevel listet. Maksimalt 100 kampanjer, de travleste først. Bare besøk med utm_campaign er med. goal_id er som standard det første aktive målet, så send den eksplisitt for å måle et bestemt mål (ID-er kommer fra goals_list). Bruk campaigns_hygiene til å rydde opp i navn og stats_breakdown med dimension utm_campaign for en enkel trafikkfordeling.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/campaigns.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Kanalregler

POST /sites/:site_id/channel_rules.json Legg til en kanalregel channel_rules_create

Legger til en egendefinert kanalregel på slutten av listen, så den kjører etter alle eksisterende regler, og den innebygde taksonomien gjelder bare når ingen regel treffer. channel er navnet som skal tildeles (opptil 32 tegn, f.eks. Partners). conditions er en ikke-tom liste av objekter med field (referrer_host, utm_source, utm_medium, utm_campaign, ref eller path), operator (is, contains, starts_with eller regex) og value. Alle betingelser må treffe for at regelen skal gjelde, og treffet er uavhengig av store og små bokstaver. En betingelse med tom verdi fjernes, og en regel uten betingelser avvises. Et regulært uttrykk som ikke kompilerer, avvises. Regelen gjelder for nye besøk i løpet av minutter og endrer ikke historikken. Bruk channel_rules_move for å endre rekkefølgen og channel_rules_preview for å teste den. Trenger sites.manage.

Tillatelse: sites.manage

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/channel_rules.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/channel_rules/:id.json Slett en kanalregel channel_rules_delete

Sletter en egendefinert kanalregel, funnet med id fra channel_rules_list. Besøk den allerede har klassifisert, beholder kanalen sin, og nye besøk faller videre til neste regel som treffer eller den innebygde taksonomien. Gjenværende regler beholder rekkefølgen. Returnerer den slettede regelen. Trenger sites.manage.

Tillatelse: sites.manage

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/channel_rules/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/channel_rules.json List kanalregler i rekkefølge channel_rules_list

Lister et nettsteds egendefinerte kanalregler i evalueringsrekkefølge (position 1 først). Regler kjører ovenfra og ned mot hvert nytt besøk, og den første regelen der alle betingelsene treffer, avgjør kanalen. Et besøk som ikke treffer noen regel, får den innebygde kanalen (direct, organic_search, paid_search, email og så videre). Hver regel har id (en UUID), channel (navnet den tildeler), position (fra 1), conditions (en liste av objekter med field, operator og value, som alle må treffe) og created_at. Regler påvirker bare besøk registrert etter at regelen finnes og skriver aldri om gamle data. Bruk channel_rules_preview for å teste et eksempelbesøk. Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/channel_rules.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/channel_rules/:id/move.json Flytt en kanalregel opp eller ned channel_rules_move

Flytter en kanalregel i evalueringsrekkefølgen, fordi den første regelen som treffer, vinner, og rekkefølgen avgjør hvilken kanal et besøk får. direction er up eller down (ett steg), eller top eller bottom (til endene). En regel som allerede står ytterst, blir stående uten feil. Posisjonene nummereres på nytt fra 1 til n, og den oppdaterte regelen returneres med sin nye posisjon. Bruk channel_rules_list først for å se gjeldende rekkefølge. Trenger sites.manage.

Tillatelse: sites.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/channel_rules/:id/move.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/channel_rules/preview.json Forhåndsvis kanalen for en eksempelhenviser og UTM-koder channel_rules_preview

Prøvekjøring som forteller hvilken kanal et eksempelbesøk ville fått med nettstedets gjeldende regler. Ingenting lagres. Send hvilke som helst av referrer (en URL eller et rent vertsnavn, prefiksene www og m ignoreres), utm_source, utm_medium, utm_campaign, ref, path (landingssti som /pricing) og paid_click (true hvis URL-en hadde en klikk-ID som gclid). Resultatet har channel (navnet på den vinnende kanalen), custom_rule (true når en egendefinert regel avgjorde, false når den innebygde taksonomien gjorde det) og referrer_host (det rensede vertsnavnet som ble brukt til matching). En henviser på nettstedets egne domener regnes som intern. Bruk denne etter channel_rules_create eller channel_rules_move for å bekrefte effekten. Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/channel_rules/preview.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
PATCH /sites/:site_id/channel_rules/:id.json Endre en kanalregel channel_rules_update

Endrer en egendefinert kanalregel, funnet med id fra channel_rules_list. Send channel for å gi nytt navn til kanalen den tildeler og conditions for å erstatte hele betingelseslisten (listen erstattes, den slås ikke sammen, så send hver betingelse du vil beholde). Utelatte inputer blir værende. Betingelsesfelt, operatorer og gyldighet av regulære uttrykk kontrolleres på samme måte som i channel_rules_create. Endringen gjelder bare nye besøk. For å endre rekkefølgen, bruk channel_rules_move. Trenger sites.manage.

Tillatelse: sites.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/channel_rules/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Kjøpstilkoblinger for uttalelser

DELETE /sites/:site_id/testimonials/settings/purchase_connections/:id.json Koble fra en betalingskonto testimonial_purchase_connections_delete

Sletter tilkoblingen og nøkkelen. Kjøpere som fortsatt venter på sin første e-post blir ikke spurt. Den stående forespørselen blir værende som oversikt over hva som ble sendt.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/settings/purchase_connections/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/settings/purchase_connections.json List kjøpstilkoblingene til et nettsted testimonial_purchase_connections_list

Hver med regelen, statusen og den stående forespørselen. Nøkkelen returneres aldri. paused er true på en plan uten forespørsler etter et kjøp: tilkoblingen beholdes, leser ingen betalinger og spør ingen.

Tillatelse: sites.manage

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/settings/purchase_connections.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Konto

GET /account.json Hent profilen og preferansene dine account_get

Returnerer det innloggede medlemmets egen profil og innstillinger. Bruk den til å lese innstillinger før du endrer dem med account_update. Dette gjelder personen, ikke et arbeidsområde. Arbeidsområdets plan og fakturaer finner du under billing_get. Feltene er email, unconfirmed_email (satt mens en e-postendring venter på bekreftelse, ellers null), name (kan være null), theme (system, light eller dark), default_landing (sites eller last_site), locale (språkkode for den innloggede appen), timezone (IANA-navn, kan være null), shortcuts_enabled, reduce_motion, product_emails, site_audit_emails, marketing_emails, newsletter (alle boolske, der true betyr abonnert), two_factor (boolsk), passkeys (antall registrerte passnøkler) og created_at (ISO 8601). En økt som bare er åpnet via en identitetsleverandør for arbeidsområdet, ser kun email og visningsinnstillingene.

Tillatelse: member

Eksempel
curl https://privatusanalytics.com/account.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /account.json Oppdater profilen og preferansene dine account_update

Oppdaterer det innloggede medlemmets egen profil, visningsinnstillinger og e-postabonnementer. Bare verdiene du sender, endres, alt annet forblir som det er. Å endre email trer ikke i kraft med en gang. Det sendes en bekreftelses-e-post til den nye adressen (med frekvensbegrensning), og unconfirmed_email viser den ventende adressen til den er bekreftet. API-token kan ikke endre e-postadressen og kan ikke slå på marketing_emails igjen etter en avmelding, begge deler krever en innlogget nettleser. Å slå av marketing_emails er tillatt. Økter åpnet av en identitetsleverandør for arbeidsområdet kan bare endre visningsinnstillingene (theme, default_landing, locale, timezone, shortcuts_enabled, reduce_motion). Returnerer den oppdaterte kontoen i samme form som account_get. Dette sletter ikke kontoen og kan ikke endre innstillinger for arbeidsområdet.

Tillatelse: member

Eksempel
curl -X PATCH https://privatusanalytics.com/account.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Lagrede visninger av uttalelser

POST /sites/:site_id/testimonials/views.json Lagre et filter, søketekst, sortering og oppsett for innboksen under et navn testimonial_saved_views_create

En personlig visning trenger bare analytics.read. En delt trenger content.write og avvises ellers med koden not_allowed. En festet visning ligger i sidefeltet med antallet. Åpne den med testimonials_list og view_id.

Tillatelse: analytics.read

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/views.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/views/:id.json Slett en lagret visning. Ingen uttalelse berøres testimonial_saved_views_destroy

En lagret visning er et lagret filter, så bare visningen forsvinner. En widget eller vegg som mates av visningen beholder innstillingene sine og har ingenting å vise før den får en annen kilde. En personlig visning slettes av eieren, og en delt trenger content.write. Ellers avvises kallet med koden not_allowed. Over MCP endrer verktøyet ingenting og svarer med siden i appen der en person gjør det.

Tillatelse: analytics.read · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/views/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/views.json List de lagrede visningene til et nettsted som kalleren kan åpne testimonial_saved_views_list

Returnerer kallerens egne visninger og alle delte, festede først i rekkefølgen sin, deretter etter navn. scope er all (standard), mine eller shared. Send en visnings id som view_id til testimonials_list for å lese uttalelsene den inneholder.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/views.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/views/:id.json Gi en lagret visning nytt navn, endre det den lagrer, fest den eller del den testimonial_saved_views_update

Bare inndataene som sendes endres: name, det lagrede søket (q), filters, sort, layout, columns, position, pinned og shared. En personlig visning endres av eieren. Å endre en delt visning, og å dele eller slutte å dele en hvilken som helst visning, krever content.write.

Tillatelse: analytics.read

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/views/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Live

GET /sites/:site_id/live.json Besøkende nå, aktivitetsstrøm og hva som er populært akkurat nå (siste 30 minutter) live_get

Hva som skjer på nettstedet akkurat nå. Returnerer live_visitors (besøkende de siste 5 minuttene), window_minutes (30), sparkline (besøk per minutt de siste 30 minuttene, eldste først, hver {minute, visits}), feed (den siste aktiviteten), top_pages, top_referrers, top_countries (hver opptil 8 rader av {value, visits}) og top_events (opptil 8 av {value, completions}) for de siste 30 minuttene. feed-oppføringer har occurred_at, kind, name, path, channel, referrer_host, country, device og browser. De er anonyme, uten IP, by eller besøkendes spor. feed viser alle treff som standard, eller bare sidevisninger eller hendelser, med limit oppføringer (standard 50, opptil bufferstørrelsen på 100). Tallene bufres ikke og tar ingen period. Send filters (samme format som stats_aggregate) for å avgrense alle tall og feed til treffene som samsvarer. Bruk live_wallboard for en kompakt visning av flere nettsteder og stats_overview for en hel periode.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/live.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/live/wallboard.json Veggtavlekort (live og i dag) for ett eller flere nettsteder live_wallboard

Kompakte kort med store tall for ett eller flere nettsteder, laget for en kontorskjerm. Returnerer rotate_seconds, generated_at og sites. Hvert nettstedskort har id (pa_...), name, domain, live_visitors (siste 5 minutter), sparkline (per minutt, siste 30 minutter), visitors_today, pageviews_today, bounce_rate_today (prosent, 0 til 100), top_pages, top_countries og top_referrers (5 rader hver). I dag betyr nettstedets egen tidssone, og tallene leses fra live-data. site_ids lister nettstedene som skal tas med (opptil 12, bare nettsteder tokenet ditt kan åpne), ellers brukes nettstedet i banen. rotate_seconds begrenses til mellom 5 og 300 og forteller bare en skjerm hvor lenge hvert kort skal vises. For en delbar offentlig skjerm, bruk wallboard_links_create. Bruk live_get for hele live-visningen av ett nettsted.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/live/wallboard.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /wallboard/:token.json Veggtavle for et veggtavletoken (ingen innlogging nødvendig) live_public_wallboard

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/wallboard/:token.json

Medlemmer

POST /workspaces/:workspace_id/invitations.json Inviter personer med e-post invitations_create

Inviterer én eller flere personer til et arbeidsområde på e-post og sender hver en invitasjons-e-post med en lenke som er gyldig i 14 dager. emails er en liste med opptil 50 adresser (en streng skilt med komma, mellomrom eller semikolon fungerer også i appens skjema), og adresser som allerede er medlemmer, hoppes over, men det er en feil når alle er medlemmer. Å invitere en adresse som allerede har en ventende invitasjon, erstatter den invitasjonen og sender en ny e-post. role er en av rollene i members_list (standard viewer, owner kan ikke inviteres). Bruk role custom sammen med custom_role_id (id fra roles_list, Business-planen). Som standard dekker tilgangen alle nettsteder, også fremtidige. For å begrense tilgangen, sett all_sites til false og list site_ids som offentlige nettsted-ID-er (pa_...). Ventende invitasjoner teller med i planens medlemsgrense (Free tillater 3 medlemmer), og kallet feiler når grensen ville blitt overskredet. Invitasjons-e-poster har frekvensbegrensning. Du kan ikke gi en rolle med flere tillatelser eller nettsteder enn dine egne. Krever members.manage. Returnerer de opprettede invitasjonene (se invitations_list for felter).

Tillatelse: members.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/invitations.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /workspaces/:workspace_id/invitations/:id.json Trekk tilbake en ventende invitasjon invitations_delete

Tilbakekaller en ventende invitasjon slik at lenken ikke lenger virker, og frigjør plassen den hadde. Slettingen kan ikke angres, inviter personen på nytt med invitations_create. Hent id (en uuid) fra invitations_list. En bruker som er begrenset til noen nettsteder, kan bare tilbakekalle invitasjoner som ikke gir flere nettsteder enn sine egne. Krever members.manage. Returnerer den tilbakekalte invitasjonen.

Tillatelse: members.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/workspaces/:workspace_id/invitations/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/invitations.json List ventende invitasjoner invitations_list

Lister de ventende teaminvitasjonene i et arbeidsområde, nyeste først og med sideinndeling. Aksepterte og tilbakekalte invitasjoner listes ikke (bruk members_list for folk som har blitt med), og utløpte blir stående til de erstattes eller tilbakekalles. Krever members.manage. En bruker som er begrenset til noen nettsteder, ser bare invitasjoner innenfor sin rekkevidde. Hvert element har id (uuid, brukes av invitations_delete), email, role, custom_role (navnet på den egendefinerte rollen når role er custom, ellers null), all_sites, site_ids (offentlige nettsted-ID-er pa_..., tom når all_sites er true), invited_by (e-posten til den som inviterte), expires_at og created_at.

Tillatelse: members.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/invitations.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
DELETE /workspaces/:workspace_id/members/:id.json Fjern et medlem (eller forlat arbeidsområdet) members_delete

Fjerner et medlem fra et arbeidsområde, eller lar den som kaller forlate det når id-en er vedkommendes eget medlemskap. Dette skjer umiddelbart og kan ikke angres, personen mister tilgangen, API-tokenene for dette arbeidsområdet tilbakekalles og en eventuell SCIM-kobling fjernes. Notatene og tidligere revisjonsoppføringer blir stående. Eieren kan ikke fjernes eller forlate arbeidsområdet, overfør eierskapet først med ownership_transfers_create. Å fjerne noen andre krever members.manage, og du kan ikke fjerne noen med flere tillatelser eller nettsteder enn du har. Å forlate krever ingen tillatelse, men et token som er begrenset i tillatelser eller nettsteder, kan ikke brukes til å forlate. Personen kan inviteres på nytt senere med invitations_create. Hent id (medlemskapets uuid) fra members_list. Returnerer det fjernede medlemmet.

Tillatelse: member · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/workspaces/:workspace_id/members/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/members.json List medlemmer av arbeidsområdet members_list

Lister medlemmene i et arbeidsområde i den rekkefølgen de ble med, med sideinndeling. Bruk query for å søke etter navn eller e-post (delvis, uavhengig av store og små bokstaver) og role for å filtrere etter rolle. Ventende invitasjoner er ikke med (bruk invitations_list). Hvert medlem har id (medlemskapets uuid, brukes av members_update, members_delete og ownership_transfers_create), email, name (kan være null), role, custom_role (navn, null med mindre role er custom), custom_role_id, all_sites, include_future_sites, site_ids (offentlige nettsted-ID-er pa_..., tom når all_sites er true), two_factor (om medlemmet har en autentiseringsapp eller en passnøkkel), last_active_at (kan være null) og created_at. Brukere som er begrenset til noen nettsteder, ser bare medlemmer innenfor sin rekkevidde.

Tillatelse: member

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/members.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/members/:id.json Endre rollen eller nettstedstilgangen til et medlem members_update

Endrer et medlems rolle og/eller nettstedstilgang i et arbeidsområde. Bare verdiene du sender, endres. For å endre rollen, send role (admin, editor, analyst, viewer eller billing, og custom med custom_role_id fra roles_list på Business-planen). Eierens rolle kan ikke endres her, bruk ownership_transfers_create i stedet, og du kan ikke redigere ditt eget medlemskap eller noen som står over deg. For å begrense nettsteder, send all_sites false sammen med site_ids (offentlige nettsted-ID-er pa_...), og legg til include_future_sites true for også å gi tilgang til nettsteder som opprettes senere. Send all_sites true for å gi tilgang til alle nettsteder. En site_ids-liste sendt uten all_sites false er en feil for et medlem som for øyeblikket har alle nettsteder. Du kan ikke gi flere tillatelser eller nettsteder enn du har. Krever members.manage. Hent id fra members_list. Returnerer det oppdaterte medlemmet.

Tillatelse: members.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X PATCH https://privatusanalytics.com/workspaces/:workspace_id/members/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/ownership_transfer.json Overfør eierskapet til arbeidsområdet til et annet medlem (kun eieren, du blir administrator) ownership_transfers_create

Overfører eierskapet til et arbeidsområde til et annet medlem og nedgraderer den som kaller til admin, noe som er vanskelig å angre fordi bare den nye eieren kan overføre det tilbake. Bare den nåværende eieren kan kalle den, og et token må ikke være begrenset til visse nettsteder eller tillatelser. membership_id er den nye eierens medlemskaps-uuid fra members_list (ikke en bruker-ID eller e-post), og personen må allerede være medlem, inviter dem først hvis de ikke er det. Den nye eieren får rollen owner med tilgang til alle nettsteder, og rollen owner kan ikke gis via members_update. Et Free-arbeidsområde kan ikke gis til noen som allerede eier et annet Free-arbeidsområde. Faktureringen blir værende hos arbeidsområdet. Et token som kaller dette, trenger members.manage. Returnerer den nye eierens medlemspost.

Tillatelse: member · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/ownership_transfer.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Merkevarepakke for uttalelser

DELETE /sites/:site_id/testimonials/settings/brand_kit.json Sett merkevarepakken for et nettsteds uttalelser tilbake til standardene til Privatus Analytics testimonial_brand_kit_reset

Fjerner hver farge, skrift, radiusen, vurderingsstilen, logoene og den egendefinerte CSS-en i ett trinn, og hvert skjema, hver widget og vegg endres med den. Det kan ikke angres, så en assistent sendes til siden Merkevarepakke i stedet for å kjøre det.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/settings/brand_kit.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/settings/brand_kit.json Hent merkevarepakken for et nettsteds uttalelser, med alle farger løst for lys og mørk modus testimonial_brand_kit_get

Returnerer fargene, skriftene, hjørneradiusen, vurderingsstilen, logoene, merkebryteren og den egendefinerte CSS-en som hvert skjema, hver widget og vegg på nettstedet tegnes med. En innstilling som aldri er endret, kommer tilbake med standarden til Privatus Analytics.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/settings/brand_kit.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/settings/brand_kit.json Endre merkevarepakken for et nettsteds uttalelser testimonial_brand_kit_update

Bare inndataene du sender endres. Send en tom streng for å sette én innstilling tilbake til standarden til Privatus Analytics. Egendefinert CSS kontrolleres når den lagres, og alt som ikke er tillatt avvises med linjen det står på. Egendefinert CSS krever Business-planen, og å skjule merket krever Business-planen. Uten den svarer serveren med 402 plan_limit.

Tillatelse: sites.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/settings/brand_kit.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Mobilapp

GET /workspaces/:workspace_id/app.json Hent det mobilappen trenger for å åpne et arbeidsområde mobile_bootstraps_get

Returnerer, for ett arbeidsområde (path tar workspace_id), rollen og tillatelsene til den som kaller, features (hvilke begrensede rapporter planen inkluderer: traffic_quality, bot_detection, external_experiments, campaign_costs, status_pages, traffic_rules, experiment_advanced (de avanserte innstillingene for et eksperiment) og survey_ai_themes (temaer for de skrevne svarene i en undersøkelse) som true eller false, og retention_months som et antall måneder eller null for ingen grense), sites_count (nettstedene den som kaller kan åpne) og min_app_version (den eldste versjonen av mobilappen som API-et fortsatt støtter). Mobilappen leser den én gang når den åpner et arbeidsområde, slik at den kan vise en rapport som planen mangler som ikke inkludert i stedet for å be om den. Krever analytics.read.

Tillatelse: analytics.read · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/app.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
DELETE /account/device.json Stopp pushvarsler til mobilappen mobile_devices_delete

Fjerner pushregistreringen til den kallende mobilapp-påloggingen, slik at enheten ikke får flere push-varsler. Selve påloggingen blir værende, og appen kan registrere seg på nytt. Hvis du logger ut (POST /oauth/revoke med refresh-tokenet), fjernes den også. Bare et token fra mobilappen kan kalle den.

Tillatelse: member · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/account/device.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /account/device.json Hent pushregistreringen til mobilappen mobile_devices_get

Returnerer enheten til mobilapp-påloggingen som kaller: registered (false til appen har registrert et push-token), platform, locale, timezone, app_version, kinds (alle typer push som finnes), muted_kinds og muted_site_ids (det personen har slått av). Bare et token fra mobilappen kan kalle den.

Tillatelse: member · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/account/device.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /account/device.json Registrer mobilappen for pushvarsler mobile_devices_update

Registrerer enheten til den kallende mobilapp-påloggingen for pushvarsler, eller endrer hva den får. Bare verdiene du sender endres. Det første kallet trenger platform og push_token. En enhet får en push for uptime (en sjekk gikk ned eller kom tilbake), alert (en varsling ble utløst eller løst), site_audit (en nettstedrevisjon ble ferdig), experiment (et eksperiment har et resultat eller er avsluttet) og usage (månedskvoten er nesten eller helt brukt opp), for alle nettsteder medlemmet kan åpne, på alle planer. muted_kinds og muted_site_ids slår av typer og nettsteder, og hver erstatter hele listen sin. Hvis du registrerer et push-token som en annen pålogging i appen har, flyttes det til denne. Bare et token fra mobilappen kan kalle den. Det er en av de to skriveoperasjonene et slikt token kan utføre.

Tillatelse: member · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X PATCH https://privatusanalytics.com/account/device.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Mottakere av forespørsler om uttalelser

POST /sites/:site_id/testimonials/requests/:request_id/recipients.json Legg til personer i en forespørsel testimonial_request_recipients_create

Opptil 500 i ett kall. Lagt til i et utkast venter de på testimonial_requests_send. Lagt til i en kjørende forespørsel får de sin første e-post med en gang. Svaret sier hvor mange som ble satt i kø og hvor mange som ble hoppet over, etter årsak. Å legge til i en kjørende forespørsel sender e-post til personer utenfor arbeidsområdet, så medlemmet får beskjed på e-post.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/requests/:request_id/recipients.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/requests/:request_id/recipients.json Fjern valgte personer fra en forespørsel testimonial_request_recipients_delete

Bare personer som ingenting ble sendt til (queued eller skipped). Tar opptil 100 adresser i innholdet. Over MCP endrer verktøyet ingenting og svarer med siden i appen der en person gjør det.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/requests/:request_id/recipients.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/requests/:request_id/recipients/import.json Legg til personer i en forespørsel fra en CSV-fil testimonial_request_recipients_import

To kall. Send filen (eller teksten som csv) for å få kolonnene, de første radene og en upload_token. Send deretter koblingen fra kolonnenummer til felt. Opptil 5 MB og 10 000 rader. Å legge til i en kjørende forespørsel sender e-post til personer utenfor arbeidsområdet, så medlemmet får beskjed på e-post.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/requests/:request_id/recipients/import.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/requests/:request_id/recipients.json List personene i en forespørsel testimonial_request_recipients_list

Filtrer etter hvor en person står nå: status opened er «åpnet og ikke klikket eller svart». E-postadressen er null med mindre kalleren kan redigere innhold.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/requests/:request_id/recipients.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/requests/:request_id/recipients/resume.json Gjenoppta valgte personer i en forespørsel testimonial_request_recipients_resume

De fortsetter der de stoppet. Tar opptil 100 adresser i innholdet. Dette sender e-post til personer utenfor arbeidsområdet, så medlemmet får beskjed på e-post.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/requests/:request_id/recipients/resume.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/requests/:request_id/recipients/stop.json Stopp valgte personer i en forespørsel testimonial_request_recipients_stop

De får ingen flere e-poster. Hver beholder statusen sin og får «stopped». Tar opptil 100 adresser i innholdet.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/requests/:request_id/recipients/stop.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Mål

POST /sites/:site_id/goals/:id/archive.json Arkiver et mål (skjult fra rapporter) goals_archive

Arkiverer et mål. Et arkivert mål skjules fra rapporter, teller ikke med i planens målgrense og beholder definisjonen, så det kan gjenopprettes senere med goals_unarchive. Ingen data slettes. Returnerer målet med archived true og archived_at satt. Å arkivere et mål som allerede er arkivert, gjør ingenting. Bruk goals_delete for å fjerne det for godt. Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/goals/:id/archive.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/goals.json Opprett et mål goals_create

Oppretter et konverteringsmål. Mål er definisjoner som brukes når rapporter leses, så et nytt mål teller umiddelbart samsvarende hendelser i all eksisterende historikk. Påkrevd er name og kind. kind avgjør hvilke andre inputer som gjelder. page trenger pattern (en sti, for eksempel /thank-you, med match_type exact, prefix, glob eller regex) og kan bruke hostname. event trenger event_name og kan bruke conditions (egenskapstester som {key: plan, operator: is, value: pro}, alle må treffe, operatorer is, is_not, contains, gt, lt). engagement trenger pattern pluss scroll_threshold (prosent 1 til 100) og/eller time_threshold_seconds (nås når en av dem er oppfylt). outbound matcher lenkedomenet med pattern (for eksempel stripe.com) og download matcher filen med pattern (for eksempel *.pdf). value_mode er none (standard), fixed (bruker fixed_value, et desimalbeløp i nettstedets valuta som 49.5, lagret som fixed_value_minor i cent) eller revenue (hendelsens egen inntekt). count_mode er once_per_visit (standard) eller every. Free-arbeidsområder tillater 10 aktive mål per nettsted, betalte planer er ubegrenset. Returnerer målet med id (goal_...). Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/goals.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/goals/:id.json Slett et mål (dataene beholdes) goals_delete

Sletter en måldefinisjon permanent. Ingen hendelsesdata slettes, men målet forsvinner fra rapporter, og traktrinn, reiser og eksperimenter som peker til det, slutter å virke. Det finnes ingen angrefunksjon. For å skjule et mål og beholde det, bruk goals_archive. Returnerer det slettede målet. ID-er (goal_...) kommer fra goals_list. Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/goals/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/goals/:id/duplicate.json Kopier et mål goals_duplicate

Kopierer et måls definisjon til et nytt aktivt mål. Kopien får navnet name hvis du sender det, ellers det opprinnelige navnet etterfulgt av (copy). Den teller med i planens målgrense (10 aktive mål per nettsted på Free). Returnerer det nye målet med en ny id. Bruk den for å starte en variant av et mål, og endre det deretter med goals_update. Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/goals/:id/duplicate.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/goals.json List mål med fullføringer, konverteringer, rate og verdi for en periode goals_list

Lister målene for et nettsted med resultatene deres for perioden. Hvert mål er definisjonen (id goal_..., name, kind, match_type, pattern, hostname, event_name, conditions, scroll_threshold, time_threshold_seconds, value_mode, fixed_value_minor i cent, count_mode, archived, archived_at) pluss stats {completions, conversions, conversion_rate, value, change}. conversion_rate er en prosent (0 til 100), value er i minste enheter (cent) og change er prosentvis endring i konverteringer mot forrige periode (null når det tidligere antallet var 0). status filtrerer til active (standard), archived eller all. Har sideinndeling med page og per_page (maks 100, standard 25). Bruk goals_get for hele rapporten for ett mål. Tar de felles inputene period, compare og filters.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/goals.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/goals/:id.json Målrapport: målinger, diagram, nedbrytninger og veien fram til konvertering goals_get

Ett mål i dybden for en periode. Returnerer period, goal_id, goal (definisjonen), metrics, interval, series, breakdowns, journey og, med compare, comparison_period, comparison og change. metrics har completions (hver samsvarende hendelse), conversions (besøk med minst én fullføring), conversion_rate (prosent fra 0 til 100) og value (minste enheter, cent). conversion_rate deler på besøk, eller på besøkende når nettstedet er satt opp slik. series er en liste av {date, completions, conversions, conversion_rate} per tidsintervall (sett interval for å endre det). breakdowns har de 10 øverste etter konverteringer for channel, utm_campaign, entry_page, country og device, hver som {value, completions, conversions, conversion_rate}. journey viser converting_visits, median_seconds_to_convert, median_pages_before og pages_before (de 10 øverste sidene sett før konvertering, med visits og share). Bruk goals_list for alle mål samtidig og funnels_get for flyter med flere trinn. Tar de felles inputene period, compare, filters og segment.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/goals/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/goals/:id/unarchive.json Gjenopprett et arkivert mål goals_unarchive

Gjenoppretter et arkivert mål slik at det vises i rapporter igjen. Det teller med i planens målgrense igjen (10 aktive mål per nettsted på Free), så kallet feiler med en plangrensefeil når nettstedet allerede er fullt. Å gjenopprette et mål som ikke er arkivert, gjør ingenting. Returnerer målet med archived false. ID-er kommer fra goals_list med status archived. Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/goals/:id/unarchive.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
PATCH /sites/:site_id/goals/:id.json Oppdater et mål goals_update

Endrer et måls definisjon. Bare verdiene du sender, endres. Den nye definisjonen gjelder hele historikken umiddelbart, så tidligere konverteringstall vil endre seg. Inputene er de samme som i goals_create, og de samme kombinasjonene gjelder, for eksempel betyr event_name og conditions bare noe for hendelsesmål og scroll_threshold og time_threshold_seconds bare for engasjementsmål. fixed_value er et desimalbeløp i nettstedets valuta (lagret i cent). Å sende conditions erstatter alle eksisterende betingelser. Returnerer målet. ID-er kommer fra goals_list. Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/goals/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Nettside

GET /blog.json List blogginnlegg blog_list

Lister innleggene i bloggen til Privatus Analytics, nyeste først, med slug, title, kicker, rubric (sammendraget på én setning), description, path og datoer, og uten innhold. For å lese ett, bruk blog_get med slug-en. Delt opp i sider med page og per_page (maksimum 100). Offentlig, ingen autentisering trengs.

Tillatelse: public

Eksempel
curl https://privatusanalytics.com/blog.json
GET /blog/:slug.json Les et blogginnlegg (Markdown og HTML) blog_get

Returnerer ett blogginnlegg ut fra slug-en (fra blog_list, den siste delen av /blog/<slug>) med overskriftene, Markdown-innholdet og den gjengitte HTML-en. Innleggene er skrevet på engelsk. Offentlig, ingen autentisering trengs.

Tillatelse: public

Eksempel
curl https://privatusanalytics.com/blog/:slug.json
GET /changelog.json List oppføringer i endringsloggen changelog_list

Publiserte produktoppdateringer, nyeste først. Også tilgjengelig som RSS på /changelog.rss.

Tillatelse: public

Eksempel
curl https://privatusanalytics.com/changelog.json
POST /contact.json Send en melding til Privatus Analytics-teamet contact_create

Nettleserklienter sender et Cloudflare Turnstile-token som `cf-turnstile-response`. Forespørsler med et API-token trenger ikke det.

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/contact.json \
  -H "Content-Type: application/json" -d '{…}'
POST /newsletter/confirm.json Bekreft et abonnement på nyhetsbrevet (signert token) newsletter_confirm

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/newsletter/confirm.json \
  -H "Content-Type: application/json" -d '{…}'
POST /newsletter.json Abonner på nyhetsbrevet med en e-postadresse newsletter_subscribe

Nettleserklienter sender et Cloudflare Turnstile-token som `cf-turnstile-response`. Forespørsler med et API-token trenger ikke det.

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/newsletter.json \
  -H "Content-Type: application/json" -d '{…}'
POST /newsletter/unsubscribe.json Avslutt abonnementet med et signert lenketoken newsletter_unsubscribe

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/newsletter/unsubscribe.json \
  -H "Content-Type: application/json" -d '{…}'
GET /pricing.json Hent planer, priser og plangrenser pricing_get

De samme dataene som prissiden: hendelsestrappen, alle plangrenser og hva som teller som en hendelse. Send events for å få det tilsvarende nivået.

Tillatelse: public

Eksempel
curl https://privatusanalytics.com/pricing.json
GET /status.json Hent gjeldende systemstatus status_get

Tilstanden til database, Redis og bakgrunnsjobber, kontrollert maksimalt hvert 15. sekund.

Tillatelse: public

Eksempel
curl https://privatusanalytics.com/status.json
GET /tools/header-checker.json Kontroller Referrer-Policy og CSP for en side med tanke på analyse tools_header_check

Henter én offentlig side og sjekker svarhodene som påvirker analyser. Bruk den når sporingsdata mangler eller henvisere ser feil ut. Den ser på Referrer-Policy, direktivene script-src og connect-src i Content-Security-Policy (om Privatus Analytics kan laste og sende data), Permissions-Policy og antall Set-Cookie-hoder. Returnerer url (den endelige URL-en etter opptil 3 omdirigeringer), status (HTTP-status) og findings, hver med check, value (kan være null), level (ok, warn eller info) og et notat i klartekst. URL-en må være http eller https og offentlig, private og interne adresser avvises, bare den første 1 MB leses og hentingen får tidsavbrudd etter 5 sekunder. Frekvensbegrenset til 10 kall i minuttet per klient. Offentlig, krever ingen autentisering.

Tillatelse: public

Eksempel
curl https://privatusanalytics.com/tools/header-checker.json
GET /tools/privacy-policy-generator.json Lag et utkast til et avsnitt i personvernerklæringen for Privatus Analytics tools_privacy_policy

Lager et utkast til et personvernerklæringsavsnitt som beskriver hvordan Privatus Analytics samler inn data på kundens nettsted (uten informasjonskapsler, ingen personopplysninger lagres, kun land som plassering). Det er et utgangspunkt, ikke juridisk rådgivning. Inputene er site_name (opptil 120 tegn), contact_email (valgfri, legger til en setning om kontakt) og honors_gpc (standard true, legger til en setning om at Do Not Track og Global Privacy Control respekteres). Returnerer site_name, paragraphs (matrise med strenger), text (avsnittene satt sammen med tomme linjer, med adressen til Privatus Analytics i parentes etter navnet) og html (avsnittene som <p>-elementer, med navnet som en vanlig lenke). Teksten skrives på språket til forespørselen, engelsk som standard. Den gjør ingen endringer i noen konto. Offentlig, krever ingen autentisering.

Tillatelse: public

Eksempel
curl https://privatusanalytics.com/tools/privacy-policy-generator.json
GET /tools/qr-code.json Generer en QR-kode som SVG tools_qr_code

Genererer en QR-kode som et SVG-bilde for trykk eller plakater. Bruk den sammen med en lenke med UTM-parametere fra tools_utm_builder. Inputene er text (URL-en eller teksten, opptil 1000 tegn) og level (feilretting l, m, q eller h, standard m, høyere tåler mer skade men trenger en tettere kode). Returnerer text, level, size (moduler per side) og svg (et selvstendig SVG-dokument, svart på hvitt). Tekst som er for lang for det valgte nivået, avvises. For QR-koder til sporede korte lenker, bruk links_qr i stedet. Offentlig, krever ingen autentisering.

Tillatelse: public

Eksempel
curl https://privatusanalytics.com/tools/qr-code.json
GET /tools/tracker-scanner.json List informasjonskapsler og kjente sporere på en side tools_tracker_scan

Henter én offentlig side og lister informasjonskapslene den setter og de kjente sporerne fra tredjeparter den refererer til. Bruk den for en rask sjekk av hva en side laster før du velger en samtykketilnærming. Det er en statisk skanning av bare HTML og svarhoder, den kjører ikke JavaScript, så informasjonskapsler satt av skript og tagger lastet senere av en tag manager, overses. Returnerer url (endelig URL etter opptil 3 omdirigeringer), status, truncated (true når bare den første 1 MB ble lest), cookies (name, domain, path, expires, secure, http_only og same_site, verdier returneres aldri), trackers (name, category, match og evidence, der category er advertising, analytics, session_recording, tag_manager, marketing eller privacy_analytics) og third_party_hosts (sorterte vertsnavn på andre nettsteder). URL-en må være offentlig http eller https, med 5 sekunders tidsavbrudd for henting, og kall er begrenset til 10 i minuttet per klient. Offentlig, krever ingen autentisering.

Tillatelse: public

Eksempel
curl https://privatusanalytics.com/tools/tracker-scanner.json
GET /tools/utm-builder.json Bygg en kampanje-URL med UTM-parametere tools_utm_builder

Bygger en kampanje-URL med UTM-parametere og flagger vanlige feil. Inputene er url (må være http eller https), source, medium og campaign (alle påkrevd) og valgfri term og content. Eksisterende utm_-parametere på URL-en erstattes og andre spørreparametere beholdes. Returnerer url (den ferdige lenken), params (utm_-verdiene som ble lagt til, tomme utelatt) og warnings (strenger for verdier med store bokstaver, mellomrom, eller tekst som ligner en e-postadresse eller et langt tall, som aldri bør stå i en URL). Bruk små bokstaver uten mellomrom slik at den samme kampanjen ikke deles opp i flere rader i rapporter. Den lagrer ingenting. Offentlig, krever ingen autentisering.

Tillatelse: public

Eksempel
curl https://privatusanalytics.com/tools/utm-builder.json
POST /waitlist.json Bli med på en venteliste (EU-hosting) waitlist_join

Nettleserklienter sender et Cloudflare Turnstile-token som `cf-turnstile-response`. Forespørsler med et API-token trenger ikke det.

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/waitlist.json \
  -H "Content-Type: application/json" -d '{…}'

Nettsteder

POST /sites/:site_id/data_reset.json Slett alle hendelser og besøk i et datoområde (kjører i bakgrunnen, kan ikke angres) sites_reset_data

Sletter et nettsteds sidevisninger, egendefinerte hendelser og besøk for et tidsrom uigenkallelig, og det kan ikke angres. Bruk den for å rydde bort testtrafikk eller fjerne en dårlig periode. Den sletter ikke selve nettstedet, målene eller innstillingene (bruk sites_delete for nettstedet). from og to er YYYY-MM-DD-datoer, begge inklusive og lest i nettstedets tidssone, og to må ikke ligge før from. confirm må være nettstedets domene nøyaktig slik sites_get viser det (store og små bokstaver spiller ingen rolle). Forespørselen godtas og returnerer umiddelbart med status queued, site_id, from og to. Slettingen kjører i bakgrunnen i partier, så tallene i statistikkverktøyene kan trenge litt tid på å stabilisere seg, og det finnes ikke noe statusendepunkt å spørre, sjekk statistikkverktøyene til tidsrommet er tomt. Handlingen registreres i revisjonsloggen. Krever tillatelsen sites.manage.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/data_reset.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/filter_stats.json Oppsummering av filtrert trafikk: roboter, trafikkregler eller PII-sladding etter årsak og land (kun antall) sites_filter_stats

Antall treff som ble forkastet eller renset før lagring, over de siste dagene. Bruk den for å se hvor mye robottrafikk, regelblokkert trafikk eller sladding et nettsted har. Velg kind med bot (treff forkastet som roboter), rule (treff forkastet av trafikkregler) eller redaction (verdier sladdet av skrubberen for personopplysninger). Returnerer kind, days, total, by_reason, by_country og by_day. by_reason og by_country er lister av {value, count} (opptil 50, størst først, value null når ukjent) og by_day er en liste av {date, count}. days begrenses til mellom 1 og 395 og er som standard 30. Dette er bare samlede antall. Ingen IP-adresser, user agents eller sladdede verdier lagres, så ingenting kan spores til en person. Disse treffene telles ikke som hendelser for fakturering. Bruk traffic_rules_list for å se eller endre reglene.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/filter_stats.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/access.json List medlemmer og om de kan se dette nettstedet sites_access_list

Viser hvilke medlemmer av arbeidsområdet som kan se ett nettsted. Hvert medlem av arbeidsområdet listes i den rekkefølgen de ble med, uten sideinndeling. Feltene er membership_id (uuid brukt av sites_access_update), email, name, role, access (true når medlemmet kan se dette nettstedet) og locked (true for eiere og administratorer, som alltid har tilgang og ikke kan endres). Andre medlemmer har tilgang når de har alle nettsteder eller en eksplisitt tilgang til dette nettstedet. Bruk members_list for å se et medlems fulle nettstedsliste. Krever members.manage.

Tillatelse: members.manage

Eksempel
curl https://privatusanalytics.com/sites/:site_id/access.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/access.json Gi eller fjern ett medlems tilgang til dette nettstedet sites_access_update

Gir eller fjerner ett medlems tilgang til ett nettsted. membership_id kommer fra sites_access_list (eller members_list), og access er true for å gi eller false for å fjerne. Eiere og administratorer har alltid tilgang og kan ikke endres. Å fjerne tilgang fra et medlem som hadde alle nettsteder, bytter vedkommende til en eksplisitt liste over alle andre nettsteder i arbeidsområdet og slår av include_future_sites, så de ikke får nettsteder som opprettes senere. Å gi tilgang til noen som allerede har alle nettsteder, endrer ingenting. Du kan ikke endre et medlem som har tillatelser du mangler eller nettsteder utover dine. Krever members.manage. Returnerer det medlemmets rad i samme form som sites_access_list.

Tillatelse: members.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/access.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/favorite.json Stjernemerk et nettsted (festes øverst under Alle nettsteder) sites_favorite

Setter stjerne på et nettsted for brukeren som kaller, slik at det listes først av sites_list og på siden Alle nettsteder. Det påvirker bare den som kaller, aldri andre medlemmer, og å stjerne et nettsted som allerede er stjernemerket, endrer ingenting. Kallet trenger ingen input utover nettsted-ID-en. Bruk sites_unfavorite for å fjerne stjernen. Krever analytics.read. Returnerer nettstedet (se sites_get), med favorite true.

Tillatelse: analytics.read

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/favorite.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/favorite.json Fjern stjernen fra et nettsted sites_unfavorite

Fjerner stjernen til brukeren som kaller fra et nettsted, slik at det ikke lenger er festet først i sites_list. Det påvirker bare den som kaller og gjør ingenting hvis nettstedet ikke var stjernemerket. Bruk sites_favorite for å sette stjerne igjen. Krever analytics.read. Returnerer nettstedet (se sites_get), med favorite false.

Tillatelse: analytics.read

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/favorite.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/setup.json Installasjonsstatus og kode for et nettsted sites_setup_get

Returnerer det som trengs for å installere sporing på et nettsted og om data har begynt å komme inn. Feltene er site_id, snippet (den ferdige HTML-script-taggen med alle trackermoduler slått på), receiving_data (true så snart den første hendelsen er mottatt) og first_event_at (ISO 8601, null til da). Spør denne gjentatte ganger etter installasjonen for å se om hendelser kommer inn. Bruk tracking_snippet i stedet når du vil ha en tilpasset snippet (valgte moduler, manuelle sidevisninger, SPA-modus, masker) og tracking_verify for å hente den levende siden og sjekke at skriptet finnes. Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/setup.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /transfers/:token/accept.json Godta en nettstedsoverføring til ett av arbeidsområdene dine site_transfers_accept

Aksepterer en invitasjon til overføring av nettsted og flytter nettstedet inn i et av arbeidsområdene til den som kaller. Banenparameteren token er fra invitasjonslenken, og workspace_id er målarbeidsområdet (ws_...) der den som kaller har sites.manage. Den som kallers egen e-post må samsvare med adressen invitasjonen ble sendt til, og målet kan ikke være arbeidsområdet nettstedet kom fra. Nettstedet beholder id, innstillinger, mål og data, men tilgangene per medlem fjernes og de delte lenkene flyttes til det nye arbeidsområdet. Den feiler når invitasjonen ikke lenger er ventende eller har utløpt, når målet har nådd planens nettstedsgrense, eller når det allerede har et aktivt nettsted med samme domene. Flyttingen kan ikke angres annet enn ved å overføre tilbake. Et token som kaller dette, må tilhøre målarbeidsområdet og ha sites.manage. Returnerer overføringen med status accepted.

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/transfers/:token/accept.json \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/transfer.json Start overføring av et nettsted til et annet arbeidsområde (sender e-post til mottakeren) sites_transfer_start

Starter flytting av et nettsted til et annet arbeidsområde ved å sende mottakeren en invitasjonslenke på e-post som er gyldig i 7 dager. Ingenting flyttes før mottakeren logger inn med den e-posten og aksepterer (site_transfers_accept), så nettstedet blir værende her til da. Å starte en ny overføring avbryter enhver tidligere ventende for samme nettsted. email må være en gyldig adresse, og mottakeren velger målarbeidsområdet. Overføringse-poster har frekvensbegrensning. Bruk sites_transfer_cancel for å trekke den tilbake. Krever sites.manage. Returnerer overføringen med site_id, site_domain, from_workspace, to_email, status pending og expires_at.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/transfer.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/transfer.json Avbryt en ventende nettstedsoverføring sites_transfer_cancel

Avbryter nettstedets ventende overføringsinvitasjon slik at lenken slutter å virke. Den feiler med en valideringsfeil når ingen overføring er ventende. En overføring som allerede er akseptert, kan ikke avbrytes. Krever sites.manage. Returnerer overføringen med status canceled.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/transfer.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /transfers/:token.json Hent en ventende overføring fra tokenet i e-posten site_transfers_get

Viser en invitasjon til overføring av nettsted ut fra tokenet i lenken (banenparameteren token, fra invitasjons-e-posten sendt av sites_transfer_start). Den som kaller, må være innlogget eller bruke et API-token. Returnerer site_id, site_domain, from_workspace (navnet på arbeidsområdet som sender), to_workspace_id (null til den er akseptert), to_email (den inviterte adressen), status (pending, accepted eller canceled) og expires_at. Invitasjoner utløper 7 dager etter at de er sendt. Bruk site_transfers_accept for å akseptere den.

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/transfers/:token.json
POST /workspaces/:workspace_id/sites.json Legg til et nettsted sites_create

Legger til et nettsted i et arbeidsområde og returnerer det, inkludert sporingssnippeten som skal installeres. Arbeidsområdets plan begrenser antall nettsteder (Free tillater 3), og kallet feiler med en plangrensefeil når grensen er nådd. domain er påkrevd og normaliseres (for eksempel reduseres en full URL eller www-prefiks til vertsnavnet). name er som standard domenet, timezone er som standard arbeidsområdets tidssone (et IANA-navn som Europe/Berlin) og currency er som standard arbeidsområdets valuta (en ISO 4217-kode på 3 bokstaver som USD). Bivirkninger er et site.created-varsel til arbeidsområdets varslingskanaler, en første SEO-nettstedsrevisjon og en kontroll av domenerangering som settes i kø, og en e-post med sporingskoden til medlemmet som opprettet det (med påminnelser mens ingen data kommer inn). Medlemmer begrenset til utvalgte nettsteder som har valgt fremtidige nettsteder, får tilgang til det. Krever sites.manage. Følg opp med tracking_snippet eller sites_setup_get for å installere, og tracking_verify for å sjekke.

Tillatelse: sites.manage

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/sites.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:id.json Slett et nettsted (fjernes permanent etter 7 dager) sites_delete

Sletter et nettsted. Det er en myk sletting, nettstedet slutter å samle inn og forsvinner fra lister umiddelbart, og dataene fjernes permanent etter 7 dager, så behandle det som uopprettelig og kontakt støtte raskt hvis det var en feil. confirm må være nettstedets domene (store og små bokstaver spiller ingen rolle). Ventende overføringer for nettstedet avbrytes, og et site.deleted-varsel sendes til arbeidsområdets varslingskanaler. For å tømme bare noe trafikk og beholde nettstedet, bruk sites_reset_data. Krever sites.manage. Returnerer nettstedet.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/sites.json List nettsteder i et arbeidsområde sites_list

Lister nettstedene i et arbeidsområde som den som kaller har tilgang til, med sideinndeling og med stjernemerkede nettsteder først. Bruk query for å søke i domene eller navn (delvis, uavhengig av store og små bokstaver), label for å beholde nettsteder som har én etikett, og sort som position (den lagrede rekkefølgen, standard), name eller visitors (besøkende de siste 30 dagene, flest først). Svarets meta har sideinndeling per side pluss stats, et objekt med nettsted-ID som nøkkel og visitors (nylige unike besøkende), change (prosentvis endring mot forrige periode), sparkline (en liste med daglige verdier) og live (besøkende nå), og totals for siden. Hvert element har de samme feltene som sites_get. Dette er utgangspunktet for å finne nettsted-ID-ene (pa_...) som brukes av alle andre nettstedsverktøy. Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/sites.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:id.json Hent et nettsted og alle innstillingene sites_get

Returnerer ett nettsteds innstillinger og status etter den offentlige id-en (pa_..., fra sites_list). Nøkkelfelt er id, workspace_id (ws_...), domain, name, extra_domains og multi_domain_mode (combined eller separate), timezone (IANA-navn), currency (ISO 4217), labels, personverninnstillinger (honor_dnt, honor_gpc, pii_scrubber, redaction_rules, allowed_params, path_masks), retention_months (null betyr behold alle data), bot_filtering, traffic_rule_modes (et objekt som kobler en regelliste til block eller allow), vitals_sample_rate (en prosent), conversion_denominator (visits eller visitors), public_dashboard og public_indexable, ingest_key_prefix (null når nettstedet ikke har noen nøkkel for crawlerlogger), verified_at, first_event_at og last_event_at (null til data kommer inn), domain_rating (kan være null), snippet (HTML-sporingstaggen), favorite (om den som kaller har stjernemerket det) og created_at. Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:id.json Oppdater nettstedsinnstillinger sites_update

Oppdaterer innstillingene for et nettsted og endrer bare feltene du sender. Navne- og identitetsfelt er name, domain (å endre det kontrollerer domenerangeringen på nytt), extra_domains (en liste med vertsnavn) og multi_domain_mode (combined teller én besøkende på tvers av domener, separate holder dem adskilt). timezone er et IANA-navn og currency en ISO 4217-kode på 3 bokstaver. Personvernfelt er honor_dnt, honor_gpc, pii_scrubber, redaction_rules (en liste med objekter med name og pattern, der pattern er et regulært uttrykk), allowed_params (spørreparametere som skal beholdes), path_masks (en liste med objekter med pattern og replacement) og bot_filtering. Lister erstatter hele den eksisterende listen. retention_months må ikke overstige planens oppbevaring (Free 6 måneder). traffic_rule_modes kobler en regelliste (hostnames, paths, referrers, countries, ip_ranges, user_agents eller events) til block eller allow. vitals_sample_rate er en prosent og planen setter tak på den (10 på Free, 100 på betalte planer). conversion_denominator er visits eller visitors. public_dashboard gjør statistikken synlig for alle med lenken, og public_indexable lar søkemotorer indeksere den siden. Endringer trer i kraft for nye hendelser i løpet av øyeblikk. Krever sites.manage. Returnerer det oppdaterte nettstedet.

Tillatelse: sites.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Nettstedsrevisjon

GET /sites/:site_id/audit/issues.json List problemene i en nettstedsrevisjon, én rad per kontroll site_audit_issues_list

Lister funnene fra én revisjon, én rad per kontroll som flagget noe, verst først (errors, deretter warnings, deretter notices, hver etter antall berørte URL-er). Hver rad har check_key (bruk den med site_audit_issues_get og demper-verktøyene), title, category, severity (error, warning eller notice), affected (URL-er flagget, dempede utelatt), added og fixed (endringer siden forrige revisjon) og pageviews (besøk på berørte sider de 30 dagene før revisjonen). Standard er den siste ferdige revisjonen, eller send audit_id. Filtrer med severity, category og new_only (bare kontroller med URL-er som er nye siden forrige revisjon). Har sideinndeling med page og per_page (maks 100, standard 50). For å se hvilke URL-er en kontroll flagget, bruk site_audit_issues_get. Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/audit/issues.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/audit/issues/:check_key.json Hent én kontroll i nettstedsrevisjonen: hvorfor den er viktig, hvordan den rettes og de berørte URL-ene site_audit_issues_get

Detaljer for én kontroll i en revisjon, etter check_key fra site_audit_issues_list (for eksempel title_missing). Returnerer audit_id, issue (samme rad som i listen), why (hva problemet betyr), fix (hvordan det rettes), muted (true hvis hele kontrollen er dempet for nettstedet) og urls, de flaggede URL-ene med page_id (bruk den med site_audit_pages_get), url, pageviews, detail (ekstra fakta om funnet, kan være tom), is_new og muted. sort er pageviews (standard, travleste først) eller url. Har sideinndeling med page og per_page (maks 100, standard 25). Standard er den siste ferdige revisjonen, eller send audit_id. Dempede URL-er sorteres sist. Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/audit/issues/:check_key.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/audit/mutes/bulk.json Demp en kontroll i nettstedsrevisjonen på flere URL-er, eller flere hele kontroller, i ett kall site_audit_mutes_bulk

Demper mange funn i én forespørsel, alt eller ingenting. Bruk en av to former. Send enten check_key pluss urls (opptil 100 URL-er) for å dempe én kontroll på flere sider, eller send check_keys (opptil 100) for å dempe hele kontroller for nettstedet. Ikke bland urls med check_keys. En ukjent kontroll eller en ugyldig URL får hele forespørselen til å feile og demper ingenting. Elementer som allerede er dempet, returneres som de er. Den siste revisjonens antall og score oppdateres én gang til slutt. Returnerer listen med dempinger. Angre hver med site_audit_mutes_delete. Trenger content.write.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/audit/mutes/bulk.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/audit/mutes.json Demp en kontroll i nettstedsrevisjonen, for hele nettstedet eller én URL site_audit_mutes_create

Demper én kontroll for nettstedet, eller bare for én URL. check_key kommer fra site_audit_issues_list. La url utgå for å dempe kontrollen overalt, eller send en full URL (som https://example.com/old) for å dempe den bare på den siden, der URL-en normaliseres slik gjennomgangen gjør det. Den siste revisjonens antall og score oppdateres med en gang. Å dempe det samme to ganger returnerer den eksisterende dempingen i stedet for en feil. For å dempe mange samtidig, bruk site_audit_mutes_bulk, og for å angre, bruk site_audit_mutes_delete. Trenger content.write.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/audit/mutes.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/audit/mutes/:id.json Opphev dempingen av en kontroll i nettstedsrevisjonen site_audit_mutes_delete

Fjerner en demping, funnet med id fra site_audit_mutes_list, slik at kontrollen eller URL-en teller med i revisjonsscoren igjen. Den siste revisjonen telles opp på nytt umiddelbart. Dette fjerner bare dempingen og sletter ikke revisjonsdata. Returnerer den fjernede dempingen. Trenger content.write.

Tillatelse: content.write

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/audit/mutes/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/audit/mutes.json List kontrollene et nettsted har dempet site_audit_mutes_list

Lister kontrollene som er dempet for nettstedet, nyeste først. En demping skjuler en kontroll enten for hele nettstedet (url er null) eller for én URL, så disse funnene holdes utenfor antall og score selv om revisjoner fortsatt registrerer dem. Hver rad har id (en demping-ID, bruk den med site_audit_mutes_delete), site_id, check_key, title, url (null for en demping for hele nettstedet), muted_by (medlemmets navn, null hvis ukjent) og created_at. Filtrer med check_key. Har sideinndeling med page og per_page (maks 100). Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/audit/mutes.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/audit/notifications.json Slå revisjonssammendraget på e-post for et nettsted av eller på site_audit_notifications_update

Slår den ukentlige sammendrags-e-posten for revisjon på eller av for medlemmet som kaller, på ett nettsted. Det er en personlig preferanse og påvirker ikke andre medlemmer. enabled true sender medlemmet sammendraget etter revisjoner av dette nettstedet, false stopper det. Returnerer site_id, enabled og all_sites_enabled (false når medlemmet har slått av revisjons-e-poster for alle nettsteder i kontoinnstillingene sine, noe som overstyrer dette). Ethvert medlem med analytics.read kan endre sin egen innstilling.

Tillatelse: analytics.read

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/audit/notifications.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/audit/pages.json List og filtrer sidene i en nettstedsrevisjon site_audit_pages_list

Sideutforskeren, som lister URL-ene fra én revisjon (den siste ferdige som standard, eller audit_id). kind er page (standard, HTML-dokumenter), resource (bilder, skript, stilark) eller external (lenker til andre nettsteder). Filtrer etter state (queued, fetched, skipped, blocked, failed), status_class (2xx, 3xx, 4xx eller 5xx), indexable, in_sitemap, has_issues (teller bare udempede funn), depth (klikk fra startsiden) og query (tekst i URL-en eller tittelen). sort er pageviews (standard), inlinks, depth, response_ms (tregeste først) eller word_count (færrest først). Hver rad har id (en UUID for site_audit_pages_get), url, path, kind, state, status, depth, indexable, indexability_reason, title, word_count, response_ms, cache_status, inlinks, pageviews, in_sitemap og issues (antall). Har sideinndeling med page og per_page (maks 100). Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/audit/pages.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/audit/pages/:id.json Hent én revidert side: metadata, problemer, innkommende og utgående lenker site_audit_pages_get

Alt revisjonen lagret om én URL, etter id (en UUID fra site_audit_pages_list eller fra urls i site_audit_issues_get). Returnerer id, audit_id, page (url, status, redirect_to, content_type, bytes, response_ms, title, meta_description, h1, canonical, robots_meta, indexable og indexability_reason, word_count, lang, hreflang, schema_types, sosiale tagger, images_count, images_missing_alt, lenkeantall, link_score, in_sitemap, has_tracker, pageviews og search_clicks, fetched_at og mer), redirect_target_id (siden den omdirigerer til innenfor revisjonen, eller null), issues (check_key, title, category, severity, detail, is_new, muted), og inlinks og outlinks (opptil 100 hver med page_id, url, status, kind, anchor, nofollow, count). Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/audit/pages/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/audit/settings.json Hent revisjonsinnstillingene til et nettsted site_audit_settings_get

Returnerer nettstedets revisjonsinnstillinger. Feltene er site_id, enabled (planlagte revisjoner på eller av, på som standard), include_subdomains, check_external_links, exclude_paths, ignored_params, extra_start_urls, next_run_at (når neste planlagte revisjon skal gå, null hvis ingen), page_limit (sider per revisjon på gjeldende plan, null når ubegrenset) og interval_days (dager mellom planlagte revisjoner på planen). Et nettsted som aldri har endret innstillingene, returnerer standardene. Endre dem med site_audit_settings_update. Trenger sites.manage.

Tillatelse: sites.manage

Eksempel
curl https://privatusanalytics.com/sites/:site_id/audit/settings.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/audit/settings.json Endre revisjonsinnstillingene til et nettsted site_audit_settings_update

Endrer hvordan nettstedet revideres. Bare verdiene du sender, endres. enabled slår planlagte og manuelle revisjoner på eller av (å slå på planlegger neste revisjon ett planintervall frem i tid). include_subdomains og check_external_links er boolske. De tre listene erstatter den lagrede listen, de slås ikke sammen, så send hele listen. exclude_paths er stiprefikser gjennomgangen hopper over, og hver må begynne med en skråstrek (opptil 50). ignored_params er navn på spørreparametere som aldri gir en annen side, som utm_source eller sessionid (opptil 50, bokstaver, sifre, punktum, bindestrek, understrek). extra_start_urls er fulle http- eller https-URL-er som skal gjennomgås i tillegg til hjemmesiden (opptil 20). En liste kan også sendes som tekst med én oppføring per linje. Returnerer de oppdaterte innstillingene. Trenger sites.manage.

Tillatelse: sites.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/audit/settings.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /audit/unsubscribe/:token.json Avmeld sammendragene fra nettstedsrevisjonen på e-post med tokenet fra en e-post site_audit_unsubscribes_create

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/audit/unsubscribe/:token.json \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/audit/cancel.json Avbryt nettstedsrevisjonen som pågår site_audit_cancel

Stopper revisjonen som kjører eller er i kø for nettstedet. Revisjonen merkes canceled, og ingenting fra den uferdige gjennomgangen rapporteres. En avbrutt revisjon bruker ikke opp Free-planens månedlige kvote. Feiler med en valideringsfeil hvis ingen revisjon er aktiv. Returnerer den avbrutte revisjonen. Trenger content.write.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/audit/cancel.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/audit/compare.json Sammenlign to nettstedsrevisjoner: URL-er lagt til og rettet per kontroll site_audit_compare

Sammenligner to revisjoner av nettstedet, kontroll for kontroll. audit_id er den nyere revisjonen og base_id den eldre. Begge har fornuftige standarder (den siste ferdige revisjonen mot den ferdige revisjonen før den), og verktøyet bytter dem hvis du sender dem i feil rekkefølge. Returnerer audit og base (hver et revisjonssammendrag, base null hvis det ikke finnes noe tidligere) og checks, ett objekt per kontroll der URL-ene endret seg, med check_key, title, category, severity, base_affected, affected, added og fixed (antall URL-er), sortert med errors først. Kontroller uten endring utelates. For to påfølgende revisjoner er added og fixed eksakte, for revisjoner lenger fra hverandre er de nettoendringen. Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/audit/compare.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/audit.json Start en nettstedsrevisjon nå site_audit_run

Starter en ny gjennomgang og SEO-revisjon av nettstedet nå. Den går gjennom nettstedets offentlige sider i bakgrunnen, så dette returnerer umiddelbart med den nye revisjonen i status queued. Spør site_audit_get (live-feltet) eller site_audit_history gjentatte ganger til statusen er complete. Avvises med en valideringsfeil når revisjonen er slått av i site_audit_settings_update, når en annen revisjon allerede er i kø eller kjører, når en manuell revisjon ble startet de siste 24 timene, og på Free-planen når en revisjon har kjørt de siste 30 dagene (mislykkede og avbrutte teller ikke). Uverifiserte nettsteder uten hendelser er også begrenset til én revisjon om dagen per domene. Antall sider som gjennomgås, begrenses av planen (Free 100, Pro 1000, Business 10 000). Sjekk can_run i site_audit_get først. Trenger content.write.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/audit.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/audit/history.json List revisjonene til et nettsted, nyeste først site_audit_history

Lister nettstedets revisjoner, nyeste først, hver med id (aud_...), status (queued, running, analyzing, complete, partial, failed eller canceled), trigger (first, scheduled eller manual), score (0 til 100, null til den er ferdig), score_band, page_limit, pages_crawled, urls_discovered, errors, warnings, notices, new_issues, fixed_issues, failure (årsak når den feilet, ellers null) og tidsstemplene. Filtrer med status. Har sideinndeling med page og per_page (maks 100). Bruk ID-ene med site_audit_get, site_audit_compare og verktøyene for funn og sider. For gjeldende tilstand for én revisjon, bruk site_audit_get. Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/audit/history.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/audit.json Hent oversikten over nettstedsrevisjonen: poengsum, antall, de viktigste problemene etter trafikk og revisjonen som pågår nå site_audit_get

Oversikten over SEO-nettstedsrevisjonen, det beste første kallet for revisjonsspørsmål. Som standard beskriver den den siste ferdige revisjonen, eller send audit_id (aud_..., fra site_audit_history) for en eldre. Resultatet har audit (den ferdige revisjonen med score 0 til 100, score_band, score_delta, antall errors, warnings og notices, pages_crawled, page_limit, capped, summary og robots-detaljer, eller null hvis ingen er ferdig), live (revisjonen som kjører nå, eller null), enabled og next_run_at (tidsplanen), can_run med run_blocked (live, disabled eller too_soon) og run_allowed_at (når site_audit_run er tillatt igjen), changes (antall nye og rettede URL-er per alvorlighetsgrad), trend (opptil 30 nylige score som id, finished_at, score), top_issues (opptil 10 kontroller rangert etter alvorlighetsgrad og deretter sidevisninger på berørte sider) og email_enabled (din egen preferanse for sammendrags-e-post). Følg opp med site_audit_issues_list for hvert funn og site_audit_pages_list for URL-er. Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/audit.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Notater

POST /sites/:site_id/notes.json Legg til et notat på et nettsted (bruk kilden "deploy" for webhooks ved utgivelser) notes_create

Legger til en merknad på diagrammene til ett nettsted, for eksempel en lansering, en kampanje eller en utgivelse. Bruk workspace_notes_create i stedet for et notat som vises på alle nettsteder. date er som standard i dag i nettstedets tidssone, og end_date markerer et tidsrom (YYYY-MM-DD). title vises på diagrammet, body er ren tekst og url kan peke til en PR eller endringslogg. color er en av neutral, brand, blue, amber, red eller violet, standard neutral. source er manual som standard. Utrullingsintegrasjoner sender source deploy, og da er title som standard en tekst bygget fra version (en utgivelsesversjon eller commit) og color er som standard blue. Krever content.write. Returnerer det opprettede notatet (se notes_list for felter).

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/notes.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/notes/:id.json Slett et notat notes_delete

Sletter et nettstedsnotat permanent, som forsvinner fra diagrammene og ikke kan gjenopprettes. Notatet må tilhøre dette nettstedet, notater for hele arbeidsområdet slettes med workspace_notes_delete. Hent id (note_...) fra notes_list. Krever content.write. Returnerer det slettede notatet.

Tillatelse: content.write

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/notes/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/notes.json List notater for et nettsted (inkludert notater for hele arbeidsområdet) notes_list

Lister merknadene (notatene) som vises på et nettsteds diagrammer, nyeste dato først og med sideinndeling. Den returnerer nettstedets egne notater pluss notater for hele arbeidsområdet som gjelder alle nettsteder. Filtrer med from og to (YYYY-MM-DD, et notat treffer når datoen ligger i tidsrommet), source (manual, deploy, system, import eller incident) og query (et søk i title, body og url uavhengig av store og små bokstaver). Bruk workspace_notes_list for arbeidsområdevisningen på tvers av alle nettsteder. Hvert notat har id (note_...), site_id (den offentlige nettsted-ID-en pa_..., null for et notat for hele arbeidsområdet), date, end_date (null for én enkelt dag), title, body (ren tekst som kan være null), url (kan være null), color (neutral, brand, blue, amber, red eller violet), source og created_at. Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/notes.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/notes/:id.json Hent et notat notes_get

Returnerer ett notat etter id (note_..., fra notes_list) for et nettsted, inkludert notater for hele arbeidsområdet som gjelder nettstedet. Et notat er en datert merknad vist på diagrammer, for eksempel en lansering, en kampanje eller en utrulling. Feltene er id, site_id (null når det gjelder hele arbeidsområdet), date og end_date (YYYY-MM-DD, end_date null for én enkelt dag), title, body (kan være null), url (kan være null), color (neutral, brand, blue, amber, red eller violet), source (manual, deploy, system, import eller incident) og created_at. Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/notes/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/notes/:id.json Rediger et notat notes_update

Redigerer et nettstedsnotat og endrer bare feltene du sender (date, end_date, title, body, url, color). source kan ikke endres. Å sende en tom url fjerner lenken, og en date med null ignoreres. Notatet må tilhøre dette nettstedet, notater for hele arbeidsområdet redigeres med workspace_notes_update. Hent id (note_...) fra notes_list. Krever content.write. Returnerer det oppdaterte notatet.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/notes/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/notes.json Legg til et notat for hele arbeidsområdet (vises på alle nettsteder) workspace_notes_create

Legger til en merknad for hele arbeidsområdet som vises på diagrammene til alle nettsteder i arbeidsområdet, for eksempel en lansering for hele selskapet eller et driftsavbrudd. Den opprettes uten nettsted (site_id er null). Bruk notes_create for et notat på ett enkelt nettsted. date er som standard i dag i arbeidsområdets tidssone, end_date markerer et tidsrom (YYYY-MM-DD), color er en av neutral, brand, blue, amber, red eller violet. Krever content.write, og en bruker som er begrenset til noen nettsteder, kan ikke opprette notater for hele arbeidsområdet. Returnerer det opprettede notatet.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/notes.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /workspaces/:workspace_id/notes/:id.json Slett et arbeidsområdenotat workspace_notes_delete

Sletter et notat for hele arbeidsområdet permanent slik at det forsvinner fra alle nettstedenes diagrammer, og det kan ikke gjenopprettes. Bare notater uten nettsted kan slettes her, bruk notes_delete for et nettstedsnotat. Hent id (note_...) fra workspace_notes_list. Krever content.write, og en bruker som er begrenset til noen nettsteder, kan ikke slette notater for hele arbeidsområdet. Returnerer det slettede notatet.

Tillatelse: content.write

Eksempel
curl -X DELETE https://privatusanalytics.com/workspaces/:workspace_id/notes/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/notes.json List notater på tvers av et arbeidsområde workspace_notes_list

Lister merknadene på tvers av et arbeidsområde, nyeste dato først og med sideinndeling. Den returnerer notater for hele arbeidsområdet (som vises på alle nettsteder) pluss notatene for hvert nettsted brukeren har tilgang til, så sjekk site_id på hvert element (null betyr hele arbeidsområdet). Bruk notes_list for ett nettsted. Filtrer med from og to (YYYY-MM-DD), source (manual, deploy, system, import eller incident) og query (søker i title, body og url). Feltene er id (note_...), site_id, date, end_date, title, body, url, color (neutral, brand, blue, amber, red eller violet), source og created_at. Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/notes.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/notes/:id.json Rediger et arbeidsområdenotat workspace_notes_update

Redigerer et notat for hele arbeidsområdet og endrer bare feltene du sender (date, end_date, title, body, url, color). Bare notater uten nettsted kan redigeres her, bruk notes_update for et nettstedsnotat. Hent id (note_...) fra workspace_notes_list. Krever content.write, og en bruker som er begrenset til noen nettsteder, kan ikke redigere notater for hele arbeidsområdet. Returnerer det oppdaterte notatet.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/workspaces/:workspace_id/notes/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Omtaler i uttalelser

GET /sites/:site_id/testimonials/mentions.json List ordene og frasene som gjentas i et nettsteds uttalelser testimonial_mentions_list

Hvert begrep kommer med hvor mange uttalelser som inneholder det, andelen, gjennomsnittsvurderingen for disse, og de siste 90 dagene mot de 90 før. Sorter etter rating_asc for å lese hva folk klager på, eller etter rising for hva som er nytt. meta.refreshed_at sier når begrepene sist ble bygget på nytt. Send et begrep til testimonials_list som mention for å lese uttalelsene.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/mentions.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/mentions/tag.json Merk hver uttalelse som nevner et ord eller en frase testimonial_mentions_tag

Én massehandling på hele resultatet, med angring. Begrepet er et hvilket som helst ord eller en frase på to ord, matchet med ordstamming slik Omtaler telles. En etikett som navngis for første gang opprettes. Svarer med en angre-id som testimonials_bulk_undo tar i 7 dager. Mer enn 100 kjøres i bakgrunnen.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/mentions/tag.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
PATCH /sites/:site_id/testimonials/mentions.json Skjul et begrep som bare er støy, eller vis det igjen testimonial_mentions_update

Et skjult begrep forlater Omtaler-listen og innboksens Omtaler-facet, og forblir skjult når begrepene bygges på nytt.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/mentions.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Oppetid

POST /sites/:site_id/uptime.json Legg til en oppetidskontroll for et nettsted uptime_checks_create

Legger til en oppetidskontroll knyttet til ett nettsted. Bruk workspace_uptime_checks_create for en kontroll som ikke hører til noe nettsted. kind avgjør målet. http sjekker statuskoden til url, keyword sjekker at svarinnholdet fra url inneholder keyword, tcp kobler til host og port, og dns sjekker at host kan slås opp. Felter for andre typer ignoreres. url er som standard nettstedets hjemmeside for http-kontroller. expected_status (100 til 599, standard 200), http_method (GET eller HEAD) og timeout_seconds (1 til 30, standard 20) gjelder http- og keyword-kontroller. interval_seconds er tiden mellom probene, den må være minst planens minimum (Free 300, Pro 60, Business 30) og er som standard 300 eller minimum hvis det er høyere. public true lar kontrollen vises på en statusside. Private og interne adresser avvises, og planen begrenser antall kontroller per arbeidsområde (Free 3, Pro 20, Business 100). Den første proben kjører i løpet av øyeblikk, og status starter som pending. Trenger tillatelsen uptime.manage. Returnerer kontrollen med id (upc_...).

Tillatelse: uptime.manage

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/uptime.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /uptime/checks/:id.json Slett en oppetidskontroll og historikken uptime_checks_delete

Sletter en oppetidskontroll permanent sammen med resultatene og hendelseshistorikken, og fjerner den fra alle statussider som viser den. Dette kan ikke angres. Bruk uptime_checks_pause for å slutte å probe men beholde historikken. id kommer fra uptime_checks_list. Trenger tillatelsen uptime.manage. Returnerer den slettede kontrollen.

Tillatelse: uptime.manage

Eksempel
curl -X DELETE https://privatusanalytics.com/uptime/checks/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/uptime.json List oppetidskontrollene for et nettsted uptime_checks_list

Lister oppetidskontrollene for ett nettsted, inkludert kontroller for hele arbeidsområdet som prober nettstedets domene eller et underdomene av det. Sortert etter navn. Bruk workspace_uptime_checks_list for alle kontroller i arbeidsområdet. Filtrer med status (up, down, pending eller paused) eller query (del av name, url eller host). Har sideinndeling med page og per_page (opptil 100). Hver kontroll har id (upc_...), workspace_id, site_id (null for kontroller for hele arbeidsområdet), name, kind, url, host, port, keyword, expected_status, http_method, interval_seconds, timeout_seconds, status (up, down, pending eller paused), enabled, public, last_checked_at, next_check_at, last_response_ms (millisekunder), ssl_expires_at, ssl_issuer, domain_expires_at og created_at. Bruk uptime_checks_get for oppetidsprosenter og hendelser.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/uptime.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /uptime/checks/:id/pause.json Sett en oppetidskontroll på pause uptime_checks_pause

Pauser en oppetidskontroll slik at den ikke lenger probes. Enhver åpen hendelse lukkes med en gang, og ingen down- eller up-varsler sendes mens den er pauset. Historikken beholdes og statusen vises som paused. Gjenoppta den med uptime_checks_resume. id kommer fra uptime_checks_list. Trenger tillatelsen uptime.manage. Returnerer kontrollen.

Tillatelse: uptime.manage

Eksempel
curl -X POST https://privatusanalytics.com/uptime/checks/:id/pause.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /uptime/checks/:id/resume.json Gjenoppta en oppetidskontroll som står på pause uptime_checks_resume

Gjenopptar en pauset oppetidskontroll. Den probes ved neste tikk i planleggeren, og statusen er pending til det første resultatet kommer inn. id kommer fra uptime_checks_list. Trenger tillatelsen uptime.manage. Returnerer kontrollen.

Tillatelse: uptime.manage

Eksempel
curl -X POST https://privatusanalytics.com/uptime/checks/:id/resume.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /uptime/checks/:id.json Hent en oppetidskontroll: oppetid 24 t/7 d/30 d, responstider og hendelser uptime_checks_get

Returnerer én oppetidskontroll med historikken, ikke bare innstillingene. Velg range (24h standard, 7d eller 30d) for diagrammet over responstid. Svaret har check (innstillinger og live-tilstand, se uptime_checks_list), uptime (prosent for 24h, 7d og 30d, null til den første proben har kjørt), range, response_times (unit hour eller day, labels som ISO 8601-tidspunkter og series med gjennomsnittlig responstid i millisekunder per lokasjon med null for hull) og incidents (de 50 siste med started_at, resolved_at null mens den fortsatt er åpen, duration_seconds, cause og failed_locations). Bare vellykkede prober teller med i responstidene. id kommer fra uptime_checks_list.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/uptime/checks/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /uptime/checks/:id.json Endre en oppetidskontroll uptime_checks_update

Endrer en oppetidskontroll. Bare verdiene du sender, endres. Regler og grenser er de samme som i uptime_checks_create (intervallet må være minst planens minimum, private adresser avvises). Å endre kind tømmer målfeltene som ikke lenger gjelder. Å endre interval_seconds planlegger neste probe umiddelbart. id kommer fra uptime_checks_list. Trenger tillatelsen uptime.manage. Returnerer den oppdaterte kontrollen.

Tillatelse: uptime.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/uptime/checks/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /uptime/probes.json Datasenter for prober, User-Agent og IP-områder for utgående trafikk (for å tillate oppetidsprobene våre) uptime_probes_list

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/uptime/probes.json
POST /uptime/probes/results.json Send resultater fra en ekstern probeagent (Bearer-token for oppetidsprobe) uptime_probes_results

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/uptime/probes/results.json \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/uptime.json Legg til en oppetidskontroll for arbeidsområdet (ikke knyttet til et nettsted) workspace_uptime_checks_create

Legger til en oppetidskontroll som hører til hele arbeidsområdet i stedet for ett nettsted. Bruk uptime_checks_create for å knytte en kontroll til et nettsted. Inputer, plangrenser og regler er de samme, se uptime_checks_create. kind er http, keyword, tcp eller dns og avgjør hvilke av url, keyword, host og port som gjelder. Fordi det ikke finnes noe nettsted, trenger en http-kontroll en eksplisitt url. Brukere som er begrenset til noen nettsteder, kan ikke opprette kontroller for hele arbeidsområdet. Trenger workspace_id fra workspaces_list og tillatelsen uptime.manage. Returnerer kontrollen med id (upc_...) og site_id null.

Tillatelse: uptime.manage

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/uptime.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/uptime.json List alle oppetidskontroller i et arbeidsområde workspace_uptime_checks_list

Lister alle oppetidskontroller i et arbeidsområde, inkludert kontroller som ikke er knyttet til noe nettsted, sortert etter navn. En bruker som er begrenset til noen nettsteder, ser bare kontroller for de nettstedene. Bruk uptime_checks_list for kontrollene til ett nettsted. Filtrer med status (up, down, pending eller paused) eller query (del av name, url eller host). Har sideinndeling med page og per_page (opptil 100). Hvert element har feltene beskrevet i uptime_checks_list. Trenger workspace_id fra workspaces_list.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/uptime.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Oversettelser av uttalelser

POST /sites/:site_id/testimonials/translations.json Oversett uttalelser til språkene et nettsted tilbyr testimonial_translations_create

Kall testimonial_translations_estimate først. Dette sender innholdet, tittelen og uthevingen til de valgte uttalelsene til Google Cloud Translation (aldri et navn, en e-post eller et selskap), og medlemmet får en e-post om at en assistent startet det. Oversettelsen skjer i bakgrunnen, og en rad som allerede er lagret hentes aldri på nytt. Ved månedens tegnkvote lagres resten som ventende og fortsetter den 1. Svarer med 402 plan_limit under Business, og med 422 not_configured mens oversettelse ikke er satt opp.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/translations.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/translations/:testimonial_id/:language.json Fjern én lagret oversettelse testimonial_translations_delete

Uttalelsen vises med sine egne ord igjen overalt der språket ble brukt. Tegn som allerede er brukt på den, returneres ikke. Fungerer på alle planer. Over MCP endrer verktøyet ingenting og svarer med siden i appen der en person gjør det.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/translations/:testimonial_id/:language.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/translations/estimate.json Tell tegnene en oversettelseskjøring ville sende, før den kjøres testimonial_translations_estimate

Si hvilke uttalelser på én måte: testimonial_ids, collection_id eller all_approved. Svaret gir uttalelsene, tegnene som ville bli sendt, tegnene som allerede er lagret og hva som er igjen av måneden. Det oppgir tegn, aldri en pris. Ingenting hentes.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/translations/estimate.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/translations.json List de lagrede oversettelsene til et nettsted testimonial_translations_list

Én rad per uttalelse og språk, sist endret først, 25 per side. Filtrer etter language, state, origin eller testimonial_id. Fungerer på alle planer, så oversettelser laget før en nedgradering kan fortsatt leses.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/translations.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/translations/:testimonial_id/:language.json Skriv eller rett én oversettelse for hånd testimonial_translations_update

Raden markeres som redigert, og en senere kjøring overskriver den ikke med mindre overwrite_edited sendes. Ingenting hentes, og ingenting teller mot kvoten. Originalen endres aldri. Business og oppover (402 plan_limit ellers).

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/translations/:testimonial_id/:language.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Papirkurv for uttalelser

DELETE /sites/:site_id/testimonials/trash/permanent.json Slett opptil 100 elementer i papirkurven for godt testimonial_trash_delete_permanently

Dette kan ikke angres. confirm er navnet på elementet (personens navn for en uttalelse) eller id-en for ett element, og navnet på nettstedet for flere. Bare elementer i papirkurven godtas.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/trash/permanent.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/trash/empty.json Slett alt i papirkurven for godt testimonial_trash_empty

Dette kan ikke angres. confirm er navnet på nettstedet. Opptil 100 elementer slettes på en gang. En større papirkurv tømmes i bakgrunnen, og svaret har state running.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/trash/empty.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/trash.json List hva som er i papirkurven, én type om gangen testimonial_trash_list

Svarer med elementene av én type (testimonial som standard) og, i meta.counts, hvor mange av hver type som er i papirkurven. Hvert element sier hva det går tilbake til, hva som viste det, hvem som la det i papirkurven og når det forlater den.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/trash.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/trash/restore.json Gjenopprett opptil 100 elementer fra papirkurven, nøyaktig slik de var testimonial_trash_restore

Id-ene må være av én type. Å gjenopprette uttalelser svarer med en angre-id (data.id og meta.undo_id) som testimonial_undo_records_undo tar i 7 dager. En gjenoppretting teller aldri som en ny uttalelse.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/trash/restore.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Personer bak uttalelser

POST /sites/:site_id/testimonials/people/:id/ask_again.json Start en forespørsel med denne personen som eneste mottaker testimonial_people_ask_again

Den bruker skjemaet personen sist brukte, eller startskjemaet. Ingenting sendes før forespørselen sendes. Serveren svarer med 422 og koden no_email, bounced eller unsubscribed når personen ikke kan spørres, og requests_unavailable mens forespørsler ikke er tilgjengelige.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/people/:id/ask_again.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/people.json Legg til en person på et nettsted testimonial_people_create

name er påkrevd (opptil 120 tegn). email vises aldri offentlig: den grupperer senere uttalelser under denne personen og lar nettstedet spørre dem på nytt, og en adresse en annen person på nettstedet allerede har, avvises. avatar_media_id er id-en (med_...) til et bilde som allerede er lastet opp til nettstedet. Å legge til en person legger ikke til noen uttalelse.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/people.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/people/:id/permanent.json Slett en person for godt, med alt de har sagt, filene og forespørselshistorikken testimonial_people_delete_permanently

For en slettingsforespørsel. Dette kan ikke angres. Det krever confirm, personens navn eller id, og legger igjen én revisjonspost som verken inneholder navnet eller ordene.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/people/:id/permanent.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/people.json List personene på et nettsted, filtrert og sortert testimonial_people_list

Hver person kommer med antallet uttalelser, hvor mange som er godkjent, gjennomsnittsvurderingen og siste forespørsel med utfallet. E-posten er null med mindre kalleren har content.write, og has_email sier fortsatt om det finnes en på fil.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/people.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/people/:id/merge.json Slå andre poster for samme person sammen med denne testimonial_people_merge

Personen i stien blir værende. Alt de andre har sagt og hver forespørsel sendt til dem flyttes over, og de andre fjernes. Et felt denne personen har tomt, fylles fra de andre, eldste først, og bruk navngir hvis verdi som vinner for et felt. Svaret inneholder meta.undo_id, som testimonial_undo_records_undo tar i 7 dager.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/people/:id/merge.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/people/:id.json Hent én person med det de er blitt spurt om og personene som ser ut som samme person testimonial_people_get

Uttalelsene deres er testimonials_list med person_id. can_ask og cannot_ask_reason sier om testimonial_people_ask_again ville gå gjennom.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/people/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/people/:id.json Rediger en person. Bare feltene som sendes endres testimonial_people_update

En tom verdi fjerner et felt, bortsett fra navnet. En e-post en annen person på nettstedet allerede har, avvises. Selskapssiden en person er oppført på følger selskapsnavnet og nettstedet.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/people/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Planer

GET /plans.json List planer, priser og grenser plans_list

Lister de offentlige planene (free, pro, business og enterprise) med grenser og prisnivåer, slik at du kan velge gyldige verdier for billing_checkout, billing_preview og billing_change_plan. Hver plan har name, events (hendelser i måneden inkludert, null for planer med nivåer eller skreddersydde planer), badge_bonus (ekstra månedlige hendelser fra merket, bare Free, ellers null), limits (et objekt med plangrenser som nettsteder, medlemsplasser, oppbevaring av historikk i måneder, mål per nettsted, AI-spørsmål og API-forespørsler per time), tiers (hver med hendelser i måneden og månedlig og årlig pris i hele USD, inkludert MVA eller salgsskatt) og contact_sales (true for skreddersydde planer). meta-objektet legger til currency, et notat om årlig prising, counted (hva som teller som en fakturerbar hendelse) og not_counted. For ett arbeidsområdes egen plan, bruk billing_get. Offentlig, krever ingen autentisering.

Tillatelse: public

Eksempel
curl https://privatusanalytics.com/plans.json

Privat tilbakemelding

GET /sites/:site_id/testimonials/forms/:form_id/feedback.json List den private tilbakemeldingen for et skjema, nyeste først testimonial_feedback_list

Privat tilbakemelding er et svar med en vurdering fra 1 til 3 på et skjema med ruting av lave vurderinger på (Business og oppover). Den er aldri en uttalelse, aldri offentlig og aldri tellet.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/forms/:form_id/feedback.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/forms/:form_id/feedback/:id/mark_read.json Marker et privat tilbakemeldingssvar som lest, eller som ulest igjen testimonial_feedback_mark_read

Setter read_at på ett privat tilbakemeldingssvar, eller fjerner det med read false. Å markere et svar som allerede er lest beholder tidspunktet det først ble lest. Ingenting sendes til personen som skrev det.

Tillatelse: analytics.read

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/forms/:form_id/feedback/:id/mark_read.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/forms/:form_id/feedback/:id.json Hent ett privat tilbakemeldingssvar testimonial_feedback_get

Returnerer vurderingen, teksten, navnet personen oppga og når det ble lest. Privat tilbakemelding er et svar med lav vurdering på et skjema med ruting av lave vurderinger på. Den er aldri en uttalelse og aldri offentlig.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/forms/:form_id/feedback/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Regnearkimport av uttalelser

POST /sites/:site_id/testimonials/imports/spreadsheet.json Last opp et regneark (eller send CSV-tekst) og les kolonnene testimonial_spreadsheet_imports_create

Trinn 1 i en regnearkimport. Send file (CSV, TSV eller XLSX, høyst 10 MB og 5 000 rader, overskrifter i første rad) eller content (CSV-tekst på opptil 1 MB). Svaret har kolonnene, tre eksempelverdier for hver og et første forslag til hvor hver kolonne hører hjemme. Ingenting er importert ennå: fortsett med testimonial_spreadsheet_imports_update og testimonial_spreadsheet_imports_run. Et regneark teller aldri mot de månedlige uttalelsene eller de hentede importene.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/imports/spreadsheet.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/imports/spreadsheet/:id/run.json Les den koblede filen inn i gjennomgangstrinnet testimonial_spreadsheet_imports_run

Rader som kan brukes venter med en avmerkingsboks. Rader som ikke kan, listes med radnummer og årsak. Behold dem med testimonial_import_sources_keep, med regnearkets id som kilde-id.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/imports/spreadsheet/:id/run.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/imports/spreadsheet/:id.json Hent et regnearks kolonner, eksempler, kobling, valg og antall testimonial_spreadsheet_imports_get

Returnerer filens kolonner med eksempelverdier, hvilket felt hver kolonne går til, valgene (standardstatus, etiketter, samling, datoformat, hva som skjer med duplikater) og, etter at den har kjørt, hvor mange rader som venter i gjennomgangstrinnet og hvor mange som ble beholdt.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/imports/spreadsheet/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/imports/spreadsheet/:id.json Lagre hvilken kolonne som går hvor, og valgene for filen testimonial_spreadsheet_imports_update

Trinn 2 og 3 i en regnearkimport. mapping er et objekt fra kolonnenavn til felt, med en tom verdi for en kolonne som skal utelates, og to kolonner kan ikke gå til ett felt. Valgene er default_status (pending eller approved), tags, collection_id (en manuell samling), default_source_name, date_format (auto, ymd, dmy eller mdy) og duplicates (skip eller queue). Bare det som sendes endres, og ingenting importeres før testimonial_spreadsheet_imports_run.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/imports/spreadsheet/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Revisjonslogg

GET /workspaces/:workspace_id/audit_log.json List oppføringer i revisjonsloggen (legg til .csv for å eksportere) audit_logs_get

Returnerer revisjonsloggen for arbeidsområdet, en sideinndelt oversikt over hvem som endret hva (innstillinger, medlemmer, nettsteder, mål, token og så videre), nyeste først. Den krever tillatelsen workspace.manage og en plan med revisjonshistorikk. Free har ingen, og kallet feiler med en plangrensefeil, Pro beholder 30 dager, Business 365 dager og Enterprise har ingen grense. Oppføringer eldre enn oppbevaringsvinduet returneres aldri. Filtrer med actor (et medlems e-post, eksakt treff), item_type (typen post som Site, Goal eller Membership), event (create, update eller destroy), og from og to (YYYY-MM-DD, inklusive, i UTC). Hver oppføring har id, created_at, event, item_type, item_id, target (en lesbar etikett som Site: example.com), actor_email (null når endringen ble gjort av systemet eller av en slettet bruker), actor_name, token_name (API-tokenet som ble brukt, null for en nettleserøkt), changes (et objekt som kobler hvert endrede felt til et [før, etter]-par, med hemmeligheter fjernet) og ip (adressen medlemmet eller API-klienten brukte, null når den er ukjent). En CSV-eksport av den samme loggen finnes bare i appen.

Tillatelse: workspace.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/audit_log.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Robotdeteksjon

GET /sites/:site_id/bot-detection.json Rapport for avansert robotdeteksjon: treff på nettstedets honeypot-sider, per side og etter det som avslørte roboten bot_detection_report

Rapporterer treffene på nettstedets honeypot-sider. En honeypot-side er en side som bare nås via en skjult lenke og er satt opp som siden for avansert robotdeteksjon i appen viser. Disse treffene er roboter, så de er aldri sidevisninger eller besøk og vises ikke i stats_overview eller stats_breakdown. Velg tidsrommet med period (7d, 30d (standard), 90d eller 12mo). Treff beholdes i 12 måneder. Resultatet har period, from (starten på tidsrommet), has_data (false til det første treffet), totals (hits, distinkte sider, automated (treff der trackeren så en automatisert nettleser) og no_interaction (treff uten peker-, tast- eller berøringsinput)), pages (opptil 50 rader med path, hits og last_hit_at), reasons (treff per resultat fra standard robotfilter: known_bot, automation, datacenter, empty_user_agent, referrer_spam, eller undetected for et treff filteret ville telt som en person) og recent (de siste 50 treffene med occurred_at, path, country, browser, device, bot_reason, automation og interacted). Ingen IP-adresse eller User-Agent lagres sammen med et treff, bare nøkkelbaserte hasher av dem som ikke kan identifisere noen, og de returneres aldri. Trenger analytics.read og planen Business eller Enterprise (ellers 402 plan_limit).

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/bot-detection.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Roboter

DELETE /sites/:site_id/crawlers/connection.json Koble fra Cloudflare og slett robottreffene som ble importert derfra crawlers_cloudflare_disconnect

Kobler Cloudflare fra et nettsted. Dette sletter det lagrede API-tokenet og alle crawlertreff som ble importert fra Cloudflare, og det kan ikke angres. Treff som kom fra sendte serverlogger, blir værende. Tokenet finnes fortsatt i Cloudflare-kontoen din til du sletter det der. Feiler hvis nettstedet ikke har noen tilkobling. Returnerer den fjernede tilkoblingen. Trenger sites.manage.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/crawlers/connection.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/crawlers/sync.json Importer robottreff fra Cloudflare nå crawlers_cloudflare_sync

Setter en umiddelbar Cloudflare-import i kø for et nettsted som allerede er tilkoblet, i stedet for å vente på den vanlige tidsplanen. Den returnerer med en gang (HTTP 202) med tilkoblingen, og importen kjører i bakgrunnen. Spør crawlers_report gjentatte ganger og følg med på cloudflare.last_synced_at for å se når den ble ferdig. Feiler hvis nettstedet ikke har noen Cloudflare-tilkobling. Trenger sites.manage.

Tillatelse: sites.manage

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/crawlers/sync.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/crawlers.json Rapport om AI-roboter: treff per robot over tid, toppstier per robot, etter kategori crawlers_report

Rapporterer hvilke AI-, søke- og SEO-crawlere som henter nettstedet, hvor ofte og hvilke stier, fra sendte serverlogger og Cloudflare-importen. Dette er crawlertrafikk, ikke besøkstrafikk, så den vises ikke i stats_breakdown. category er ai (standard), search, seo, other eller all, og crawler avgrenser til én navngitt robot som GPTBot eller ClaudeBot. Velg tidsrommet med period (standard 30d) eller egendefinert from og to. Resultatet har period (from og to som datoer), category, crawler, totals (hits, distinkte stier, distinkte crawlere), categories (treff per kategori, uten hensyn til kategorifilteret), crawlers (opptil 50 rader med crawler, category, hits, paths), series (etiketter per dag og daglige treff for de 8 øverste crawlerne), top_paths (de 10 mest hentede stiene for hver av de 8 øverste crawlerne), has_data (false til det finnes treff) og cloudflare (tilkoblingen med zone, status og last_synced_at, eller null). Resultater bufres i opptil 30 minutter, unntatt rett etter en Cloudflare-endring. Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/crawlers.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Roller

POST /workspaces/:workspace_id/roles.json Opprett en egendefinert rolle roles_create

Oppretter en egendefinert rolle, et navngitt sett med tillatelser du kan gi medlemmer via invitations_create eller members_update med role custom og rollens id som custom_role_id. Den krever Business-planen og members.manage. permissions må liste minst ett navn fra de tillatte verdiene (analytics.read, analytics.export, content.write, sites.manage, uptime.manage, members.manage, tokens.manage, billing.manage, workspace.manage), og du kan ikke ta med en tillatelse du ikke selv har. Returnerer rollen (se roles_list for felter).

Tillatelse: members.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/roles.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /workspaces/:workspace_id/roles/:id.json Slett en egendefinert rolle (må være ubrukt) roles_delete

Sletter en egendefinert rolle. Dette kan ikke angres, og det feiler så lenge et medlem eller en ventende invitasjon fortsatt bruker rollen, så flytt de personene til en annen rolle først med members_update (finn dem med members_list). De innebygde rollene kan ikke slettes. Hent id (uuid) fra roles_list. Krever members.manage. Returnerer den slettede rollen.

Tillatelse: members.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/workspaces/:workspace_id/roles/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/roles.json List egendefinerte roller roles_list

Lister de egendefinerte rollene i et arbeidsområde, ordnet etter navn. Egendefinerte roller er en funksjon i Business-planen som samler tillatelser under ditt eget navn, og de innebygde rollene (owner, admin, editor, analyst, viewer, billing) listes ikke her. Hver rolle har id (uuid, brukes som custom_role_id i invitations_create og members_update), name, permissions (navn som analytics.read, content.write, members.manage), members (antall medlemmer som har den) og created_at. Brukere som er begrenset til noen nettsteder, ser bare roller innenfor sin rekkevidde.

Tillatelse: member

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/roles.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/roles/:id.json Oppdater en egendefinert rolle roles_update

Gir en egendefinert rolle nytt navn og/eller erstatter hele tillatelseslisten. Bare verdiene du sender, endres, og permissions erstatter den eksisterende listen i stedet for å legge til. Endringen gjelder umiddelbart alle medlemmer og ventende invitasjoner som har rollen. Du kan bare redigere en rolle der du har alle tillatelsene selv, og en bruker som er begrenset til noen nettsteder, trenger rekkevidde over alle nettstedene til de som har den. Krever members.manage. Hent id (uuid) fra roles_list. Returnerer den oppdaterte rollen.

Tillatelse: members.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X PATCH https://privatusanalytics.com/workspaces/:workspace_id/roles/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

SCIM

POST /scim/v2/Users.json Etabler en bruker scim_users_create

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/scim/v2/Users.json \
  -H "Content-Type: application/json" -d '{…}'
DELETE /scim/v2/Users/:id.json Avetabler en bruker scim_users_delete

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/scim/v2/Users/:id.json \
  -H "Content-Type: application/json" -d '{…}'
GET /scim/v2/Users.json List etablerte brukere scim_users_list

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/scim/v2/Users.json
GET /scim/v2/Users/:id.json Hent en etablert bruker scim_users_get

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/scim/v2/Users/:id.json
PATCH /scim/v2/Users/:id.json Oppdater en bruker (PATCH active, name) scim_users_update

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X PATCH https://privatusanalytics.com/scim/v2/Users/:id.json \
  -H "Content-Type: application/json" -d '{…}'

SSO

POST /workspaces/:workspace_id/sso/activate.json Aktiver en testet SSO-konfigurasjon sso_activate

Slår på SSO for arbeidsområdet. Konfigurasjonen må allerede ha status tested, noe som skjer etter en vellykket prøveinnlogging (startet fra SSO-innstillingssiden for arbeidsområdet i appen, den trenger en innlogging i nettleser og kan ikke kjøres herfra), eller allerede være active. Bare Business-planen. Etter aktivering kan medlemmer logge inn med SSO, og å sette enforced via sso_update krever da SSO for hver innlogging. Den feiler når konfigurasjonen er utestet eller planen ikke har SSO. Krever workspace.manage. Returnerer konfigurasjonen med status active (se sso_get).

Tillatelse: workspace.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/sso/activate.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/sso/deactivate.json Slå av SSO (tilbake til utkast) sso_deactivate

Slår av SSO ved å sette konfigurasjonen tilbake til draft og fjerne enforced, slik at medlemmer går tilbake til arbeidsområdets andre innloggingsmetoder. Leverandørdetaljer beholdes. Reaktivering krever en ny prøveinnlogging og sso_activate. Sørg først for at medlemmene har en annen måte å logge inn på. Dette virker på alle planer. Krever workspace.manage. Returnerer konfigurasjonen med status draft (se sso_get).

Tillatelse: workspace.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/sso/deactivate.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/sso/scim_token.json Generer et nytt SCIM-token (vises bare én gang) sso_scim_token

Tillatelse: workspace.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/sso/scim_token.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/sso.json Hent SSO-innstillinger sso_get

Returnerer arbeidsområdets konfigurasjon for single sign-on (SSO), eller et tomt utkast når ingen finnes. Feltene er protocol (saml eller oidc), status (draft, testing, tested eller active), enforced (medlemmer må logge inn via SSO), domains (e-postdomener som bruker denne SSO-en), idp_sso_url og idp_entity_id for SAML, oidc_issuer og oidc_client_id for OIDC, default_role og jit_provisioning (opprett medlemmer ved første SSO-innlogging) og scim_enabled. Hemmeligheter returneres aldri, bare de boolske idp_cert_present og oidc_client_secret_present. SSO er en funksjon i Business-planen. Krever workspace.manage.

Tillatelse: workspace.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/sso.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/sso.json Opprett eller oppdater SSO-innstillinger sso_update

Oppretter eller redigerer arbeidsområdets SSO-innstillinger. Bare Business-planen. Bare verdiene du sender, endres. For SAML, send protocol saml med idp_sso_url, idp_entity_id og idp_cert (PEM-tekst). For OIDC, send protocol oidc med oidc_issuer, oidc_client_id og oidc_client_secret, som er skrivebeskyttet og der en tom verdi beholder den eksisterende hemmeligheten. domains lister e-postdomenene som bruker denne SSO-en. default_role er rollen som gis til medlemmer opprettet ved klargjøring ved første innlogging eller SCIM (ikke owner eller custom), og du kan bare sette en rolle du selv kunne gitt. Å endre en hvilken som helst detalj ved identitetsleverandøren sender en active eller tested konfigurasjon tilbake til draft og slår av enforced, så den må testes på nytt før sso_activate virker. enforced true godtas bare mens status er active. Krever workspace.manage. Returnerer konfigurasjonen (se sso_get).

Tillatelse: workspace.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X PATCH https://privatusanalytics.com/workspaces/:workspace_id/sso.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Samlinger av uttalelser

POST /sites/:site_id/testimonials/collections/:id/items.json Legg uttalelser til en manuell samling testimonial_collections_add_items

Opptil 100 på en gang. De kommer nederst, eller øverst med position top, i rekkefølgen oppgitt. Svaret har meta.undo_id, som testimonials_bulk_undo tar i 7 dager. En smart samling tar ingenting for hånd.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/collections/:id/items.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/collections.json Opprett en samling, manuell eller smart testimonial_collections_create

kind manual settes sammen for hånd, og testimonial_ids starter den fylt. kind smart holdes oppdatert av betingelser: rader med field, operator og value forbundet med match. Svaret inneholder antallet og reglene på vanlig norsk, så ett kall gjør en setning om til en levende samling. Prøv reglene først med testimonial_collections_preview. Typen endres aldri etterpå.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/collections.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/collections/:id.json Flytt en samling til papirkurven i 30 dager testimonial_collections_destroy

Uttalelsene berøres ikke. En widget eller vegg den mater viser ingenting fra den før den gjenopprettes. Gjenopprett den med testimonial_trash_restore. Over MCP endrer verktøyet ingenting og svarer med siden i appen der en person gjør det.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/collections/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/collections.json List samlingene til et nettsted testimonial_collections_list

Hver samling kommer med hvor mange uttalelser den inneholder akkurat nå, hvor mange av dem som er godkjent, reglene på vanlig norsk når den er smart, og widgetene og veggene den mater. Samlinger i papirkurven utelates.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/collections.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/collections/preview.json Prøv et sett med regler uten å lagre noe testimonial_collections_preview

Svarer med hvor mange uttalelser som treffer akkurat nå, reglene på vanlig norsk og fem eksempler. Bruk det før testimonial_collections_create eller testimonial_tags_update. En ugyldig rad gir 422 som navngir raden.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/collections/preview.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
DELETE /sites/:site_id/testimonials/collections/:id/items.json Ta uttalelser ut av en manuell samling testimonial_collections_remove_items

Opptil 100 på en gang. Selve uttalelsene endres ikke. Svaret har meta.undo_id, og en angring setter hver tilbake på plassen sin.

Tillatelse: content.write

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/collections/:id/items.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/collections/:id/reorder.json Flytt én uttalelse til en annen plass i en manuell samling testimonial_collections_reorder

Angi plassen med nøyaktig én av position (talt fra 1), before_id eller after_id. Rekkefølgen er rekkefølgen som serveres til hver widget og vegg samlingen mater.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/collections/:id/reorder.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/collections/:id.json Hent én samling med antall, regler og det den mater testimonial_collections_get

Uttalelsene er testimonials_list med collection_id.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/collections/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/collections/:id.json Endre en samlings navn, beskrivelse, regler eller rekkefølge testimonial_collections_update

Bare det som sendes endres. Å sende conditions erstatter hver regel i en smart samling. Typen er fast.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/collections/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Segmenter

POST /sites/:site_id/segments.json Lagre filtre som et segment segments_create

Lagrer et sett med filtre som et navngitt segment som kan gjenbrukes i alle statistikkverktøy via segment_id. Send name og filters (alle betingelser må treffe, og en {any: [...]}-gruppe treffer når én av flere gjør det, se filters-input for dimensjonsnavn og operatorer). Filtrene kontrolleres, så en ukjent dimensjon eller en ugyldig verdi gir en 422 med en melding per rad. Bruk segments_preview først for å sjekke hva et filtersett treffer. shared er true som standard og gjør segmentet synlig for alle med tilgang til nettstedet, false holder det privat for deg. Returnerer segmentet med id (seg_...), site_id, name, description, filters, summary (en beskrivelse i klartekst), shared, mine og tidsstempler. Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/segments.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/segments/:id.json Slett et segment segments_delete

Sletter et lagret segment permanent. Dashbord og lenker som bruker det, faller tilbake til all trafikk. Ingen analysedata berøres, og det finnes ingen angrefunksjon. Returnerer det slettede segmentet. ID-er (seg_...) kommer fra segments_list. Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/segments/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/segments.json List segmenter du kan bruke på et nettsted segments_list

Lister de lagrede segmentene for et nettsted, ordnet etter navn: de delte pluss dine egne private. Hvert segment har id (seg_...), site_id, name, description, filters, summary, shared, mine og tidsstempler. Send en id som segment_id til et hvilket som helst statistikkverktøy (stats_aggregate, stats_breakdown, funnels_get og andre) for å bruke segmentets filtre. Har sideinndeling med standard page-parametere. Bruk segments_create for å legge til ett.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/segments.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/segments/preview.json Beskriv filtre på vanlig språk og tell de besøkende de traff de siste 30 dagene segments_preview

Sjekker et sett med filtre uten å lagre noe. Returnerer summary (filtrene i klartekst), visitors (hvor mange besøkende som traff de siste 30 dagene, null når filtrene er ugyldige), period (alltid 30d) og filters (den rensede, kanoniske formen som ville blitt lagret). Filtre bruker samme format som segments_create, inkludert {any: [...]}-grupper og valgfrie utskrevne navn for land, kanaler og mål, som gjøres om til koder og ID-er. Ugyldige filtre gir en 422 som navngir raden. Bruk den for å prøve filtre før segments_create, og stats_aggregate med filters for tall over en annen periode.

Tillatelse: analytics.read

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/segments/preview.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/segments/:id.json Hent et segment segments_get

Returnerer ett lagret segment: id (seg_...), site_id, name, description, filters (de lagrede betingelsene), summary (en beskrivelse i klartekst som Besøkende fra USA på mobil), shared (synlig for alle med nettstedstilgang), mine (true når du opprettet det) og tidsstempler. Du kan lese delte segmenter og dine egne private. ID-er kommer fra segments_list. For å telle hvor mange besøkende et sett med filtre treffer, bruk segments_preview.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/segments/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/segments/:id.json Gi et segment nytt navn eller endre filtrene eller delingen segments_update

Gir et segment nytt navn, erstatter filtrene eller endrer hvem som kan se det. Bare verdiene du sender, endres. Å sende filters erstatter alle eksisterende filtre, i samme format og med de samme kontrollene som segments_create. shared false gjør det privat for den som opprettet det. description kan tømmes ved å sende den tom. Alt som bruker segmentet, som statistikkall med segment_id, endres umiddelbart. Returnerer segmentet. ID-er kommer fra segments_list. Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/segments/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Selskaper bak uttalelser

GET /sites/:site_id/testimonials/companies.json List selskapene på et nettsted med personene, uttalelsene og gjennomsnittsvurderingen testimonial_companies_list

Én rad per selskap, gruppert fra selskapsnavnet og nettstedet til personene på nettstedet. En person uten selskap er i ingen. query treffer en del av et selskapsnavn eller av nettstedets vert. sort er name (standard), people_desc, testimonials_desc eller received_desc.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/companies.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/companies/:id/merge.json Slå et selskap sammen med et annet, for to stavemåter av samme selskap testimonial_companies_merge

Hver person i selskapet i stien får navnet og URL-en til selskapet som er oppgitt av into.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/companies/:id/merge.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/companies/:id.json Hent ett selskap med personene testimonial_companies_get

Id-en er selskapets nøkkel, en nettstedsvert eller et normalisert navn, slik testimonial_companies_list returnerer den. Uttalelsene er testimonials_list med company.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/companies/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/companies/:id.json Rett et selskaps navn og URL for alle personene på én gang testimonial_companies_update

Et selskaps id kommer fra URL-en eller navnet, så svaret kan inneholde en ny id.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/companies/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Skjemaer

POST /sites/:site_id/testimonials/forms.json Opprett et skjema testimonial_forms_create

Ett kall bærer hele skjemaet: trinn, spørsmål, hopp-logikk, samtykketekst og språk. Alt som utelates starter fra en fornuftig standard på skjemaets språk, og slug-en kommer fra navnet. Lenken er https://privatus.page/f/<slug>. Ruting av lave vurderinger og egendefinert CSS krever Business-planen (402 plan_limit uten). Video- og lydsvar tilbys giveren fra Pro og oppover.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/forms.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/forms/:id/permanent.json Slett et skjema for godt testimonial_forms_delete

Sletter skjemaet, innsendingspostene, belønningen og den private tilbakemeldingen. Uttalelsene det samlet inn beholdes. Det kan ikke angres, så det gjøres av en person på siden. API-et tar confirm (skjemaets navn eller id).

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/forms/:id/permanent.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/forms/:id.json Flytt et skjema til papirkurven testimonial_forms_trash

Lenken svarer at skjemaet er stengt til det gjenopprettes. Papirkurven tømmes etter 30 dager. Over MCP endrer verktøyet ingenting og svarer med siden i appen der en person gjør det.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/forms/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/forms/:id/duplicate.json Kopier et skjema, eventuelt til et annet språk testimonial_forms_duplicate

Kopierer hver innstilling unntatt slug-en, statistikken og belønningen.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/forms/:id/duplicate.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/forms.json List skjemaene til et nettsted testimonial_forms_list

Skjemaer i papirkurven listes med trashed true, og utelates ellers. Hvert skjema har innstillingene sine, belønningen og hvor mange innsendinger det har hatt.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/forms.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/forms/:id/qr.json Hent et skjemas QR-kode som SVG eller PNG testimonial_forms_qr

Koden inneholder skjemaets lenke med ?src=qr, slik at skanninger telles som en egen kanal. En endret slug lar en trykt kode fortsette å fungere.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/forms/:id/qr.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/forms/:id/restore.json Gjenopprett et skjema fra papirkurven. Lenken fungerer igjen testimonial_forms_restore

Tar et skjema ut av papirkurven slik det var, med spørsmål, innsendinger og privat tilbakemelding. Lenken (/f/<slug>) og innbyggingene tar imot svar igjen. Serveren svarer med 422 og koden not_in_trash for et skjema som ikke er i papirkurven.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/forms/:id/restore.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/forms/:id/share.json Hent et skjemas lenke, QR-kodelenker og innbyggingskoder testimonial_forms_share

Returnerer lenken, innbyggingskoden for innebygd visning og innbyggingskoden for popup. Popup-inndataene (trigger, label, position, accent) endrer popup-koden.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/forms/:id/share.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/forms/:id.json Hent ett skjema med hvert trinn, spørsmål, regel og innstilling testimonial_forms_get

Returnerer hele skjemaet slik testimonial_forms_create og testimonial_forms_update tar det, med slug, lenke, belønning og hvor mange innsendinger det har. Et skjema i papirkurven finnes ikke her: gjenopprett det først.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/forms/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/forms/:id.json Endre et skjema. Bare inndataene som sendes endres testimonial_forms_update

En endring i et trinn, et spørsmål eller samtykketeksten øker skjemaets versjon, som hver samtykkepost lagrer. En endret slug lar den gamle lenken omdirigere. Send questions som hele listen.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/forms/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Sponsorrapport

GET /sponsor/:token.json En sponsorrapport, med lenkens token ad_reports_get

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/sponsor/:token.json

Sponsorrapporter

Sporing

POST /sites/:site_id/tracking/ingest_key.json Opprett eller roter nøkkelen for crawlerlogger (vises bare én gang) tracking_ingest_key_rotate

Oppretter en ny hemmelig nøkkel for crawlerlogger (den begynner med pik_) for et nettsted og erstatter en eventuell eksisterende nøkkel. Nøkkelen autentiserer opplastinger av servertilgangslogger til rapporten om AI-crawlere (POST /api/logs). Bruk den både for å opprette den første nøkkelen og for å rotere. Den nye nøkkelen virker med en gang og den gamle slutter å virke med en gang, så rull ut den nye nøkkelen umiddelbart for å unngå 401-feil ved opplasting av logger. Hele nøkkelen returneres bare i dette svaret, i feltet key, så lagre den i et hemmelighetslager. Deretter beholdes og vises bare et kort prefiks (prefix her, ingest_key_prefix på nettstedet). Returnerer site_id, key og prefix. Krever sites.manage. Bruk tracking_ingest_key_revoke for å fjerne nøkkelen uten å erstatte den.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/tracking/ingest_key.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/tracking/ingest_key.json Tilbakekall nøkkelen for crawlerlogger tracking_ingest_key_revoke

Fjerner et nettsteds nøkkel for crawlerlogger. Fra da av avvises hver loggopplasting sendt med den nøkkelen med 401 til du oppretter en ny med tracking_ingest_key_rotate. Nettlesersporing med den offentlige nettsted-ID-en påvirkes ikke. Nøkkelen kan ikke gjenopprettes. Krever sites.manage. Returnerer nettstedsobjektet (se sites_get), der ingest_key_prefix nå er null.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/tracking/ingest_key.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/tracking/verify.json Kontroller at sporeren er installert på nettstedet (script-tag, nettsted-ID, CSP og henviserpolicy) tracking_verify

Henter nettstedets side og sjekker at sporingsskriptet fra Privatus Analytics er riktig installert, og markerer nettstedet som verifisert når skriptet med dette nettstedets id er funnet. Som standard ber den om hjemmesiden (https://domain/), og url kan navngi en annen side, men bare på nettstedets eget domene, tilleggsdomener eller underdomenene deres. Resultatet (under data) har url, status (HTTP-status), script_found, site_ids (hver data-site-id funnet på siden), installed (true når dette nettstedets id er blant dem), csp og csp_ok (om sidens Content-Security-Policy lar trackeren laste og sende), referrer_policy og referrer_ok (en no-referrer-policy betyr at hvert besøk vises som direkte), og checked_at. Den henter over det offentlige internett, leser høyst 2 MB og har frekvensbegrensning per arbeidsområde og per vert, så den svarer 429 når den kalles for ofte. Hvis siden ikke er tilgjengelig, returnerer den en valideringsfeil. Bruk sites_setup_get for å se om hendelser har kommet inn. Krever sites.manage.

Tillatelse: sites.manage

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/tracking/verify.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/tracking/snippet.json Bygg sporingskoden for valgte alternativer tracking_snippet

Bygger HTML-script-taggen for å installere sporing på et nettsted og returnerer den med nettsted-ID-en som data.site_id og data.snippet. Velg denne fremfor sites_setup_get når du trenger å tilpasse den, og bruk tracking_verify etterpå for å sjekke den levende siden. Som standard lastes alle trackermoduler og sidevisninger er automatiske. modules begrenser den til et utvalg av engage (tid og rulling), auto (utgående lenker, nedlastinger, skjemaer, 404-sider), vitals (Web Vitals), clicks (klikkart) og ask (undersøkelser på nettstedet). manual true slår av den automatiske sidevisningen slik at du sender dem selv. spa setter sporing av navigasjon i enkeltsideapper til auto, history, hash eller off. domains begrenser sporingen til disse vertsnavnene, exclude lister stiglobber som skal hoppes over, query_params lister ekstra spørreparametere som skal beholdes og mask lister stimasker på klientsiden skrevet som /u/*->/u/:id. Ingenting lagres, snippeten genereres fra inputene hver gang. Krever analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/tracking/snippet.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Språk for uttalelser

GET /sites/:site_id/testimonials/settings/languages.json Hent språkinnstillingene for et nettsteds uttalelser testimonial_languages_get

Standardspråket, språkene som tilbys, om nylig godkjente uttalelser oversettes automatisk, om planen inkluderer oversettelse, om oversettelse er satt opp, og månedens tegn brukt og igjen.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/settings/languages.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/settings/languages.json Sett standardspråket, språkene som tilbys og automatisk oversettelse testimonial_languages_update

Send bare det som endres. Standarden er alltid blant språkene som tilbys, og et språk et skjema er skrevet på kan ikke fjernes (in_use). Å slå på auto_translate krever Business eller høyere (402 plan_limit ellers): fra da av sendes ordene i hver nylig godkjente uttalelse til Google Cloud Translation, og medlemmet får en e-post om at en assistent endret dette.

Tillatelse: sites.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/settings/languages.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Statussider

GET /status/:slug/confirm/:token.json Bekreft et abonnement fra lenken i e-posten public_status_pages_confirm

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/status/:slug/confirm/:token.json
GET /status/:slug.json Offentlig statusside: nåværende status, oppetidsstolper for 90 dager, hendelser og innlegg public_status_pages_get

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl https://privatusanalytics.com/status/:slug.json
POST /status/:slug/subscribers.json Abonner med en e-postadresse (dobbel bekreftelse) public_status_pages_subscribe

Nettleserklienter sender et Cloudflare Turnstile-token som `cf-turnstile-response`. Forespørsler med et API-token trenger ikke det.

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/status/:slug/subscribers.json \
  -H "Content-Type: application/json" -d '{…}'
POST /status/:slug/unsubscribe/:token.json Avslutt abonnementet med tokenet i e-posten public_status_pages_unsubscribe

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/status/:slug/unsubscribe/:token.json \
  -H "Content-Type: application/json" -d '{…}'
POST /status_pages/:status_page_id/posts.json Publiser en hendelsesoppdatering (sender e-post til abonnentene) status_page_posts_create

Publiserer en hendelsesoppdatering på en statusside og sender som standard e-post til de bekreftede abonnentene. Velg den for å kunngjøre eller oppdatere en hendelse, og bruk status_page_posts_update for å flytte en eksisterende hendelse videre (for eksempel til resolved) i stedet for å opprette et nytt innlegg. Påkrevd er title (maks 200 tegn). status er en av investigating (standard), identified, monitoring eller resolved. body er ren tekst (maks 10 000 tegn), posted_at er et ISO 8601-tidspunkt som er som standard nå, og notify (standard true) styrer e-posten. E-poster sendes bare for en publisert side og har frekvensbegrensning per side, over grensen blir innlegget likevel publisert men ingen får e-post. status_page_id kommer fra status_pages_list. Trenger tillatelsen uptime.manage. Returnerer innlegget med id (spp_...), title, body, status, posted_at og updated_at.

Tillatelse: uptime.manage

Eksempel
curl -X POST https://privatusanalytics.com/status_pages/:status_page_id/posts.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /status_pages/:status_page_id/posts/:id.json Slett et innlegg på en statusside status_page_posts_delete

Sletter et hendelsesinnlegg fra en statusside permanent. Det forsvinner fra den offentlige siden med en gang og dette kan ikke angres. Ingen e-post sendes. id kommer fra status_page_posts_list. Trenger tillatelsen uptime.manage. Returnerer det slettede innlegget.

Tillatelse: uptime.manage

Eksempel
curl -X DELETE https://privatusanalytics.com/status_pages/:status_page_id/posts/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /status_pages/:status_page_id/posts.json List innlegg på en statusside status_page_posts_list

Lister hendelsesinnleggene på en statusside, nyeste først etter posted_at. Bruk den for å finne en innleggs-ID eller se hendelseshistorikken. Filtrer eventuelt etter status (investigating, identified, monitoring eller resolved). Har sideinndeling med page og per_page (opptil 100). Hvert innlegg har id (spp_...), title, body (null når tom), status, posted_at og updated_at. status_page_id kommer fra status_pages_list.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/status_pages/:status_page_id/posts.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /status_pages/:status_page_id/posts/:id.json Rediger et innlegg på en statusside status_page_posts_update

Redigerer et hendelsesinnlegg. Bare verdiene du sender, endres, så send bare status for å løse en hendelse. Abonnenter får e-post bare når statusen faktisk endres og notify ikke er false (standard true). Å redigere bare tittelen eller innholdet sender ingen e-post. E-poster går til bekreftede abonnenter på en publisert side og har frekvensbegrensning per side. Gyldige status-verdier er investigating, identified, monitoring og resolved. id kommer fra status_page_posts_list. Trenger tillatelsen uptime.manage. Returnerer det oppdaterte innlegget.

Tillatelse: uptime.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/status_pages/:status_page_id/posts/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /status_pages/:status_page_id/subscribers/:id.json Fjern en abonnent status_page_subscribers_delete

Fjerner en e-postabonnent fra en statusside slik at vedkommende slutter å motta e-post om hendelser og oppetid. Dette kan ikke angres, men personen kan abonnere igjen på den offentlige siden. id er abonnent-ID-en fra status_page_subscribers_list (en vanlig UUID, ikke en ID med prefiks). Trenger tillatelsen uptime.manage. Returnerer den fjernede abonnenten.

Tillatelse: uptime.manage

Eksempel
curl -X DELETE https://privatusanalytics.com/status_pages/:status_page_id/subscribers/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /status_pages/:status_page_id/subscribers.json List abonnenter på en statusside status_page_subscribers_list

Lister e-postabonnentene på en statusside, sortert etter e-post. Bruk confirmed true for å se bare folk som har bekreftet adressen sin (bare de mottar e-post) eller confirmed false for ventende. Har sideinndeling med page og per_page (opptil 100). Hvert element har id (en UUID, brukt av status_page_subscribers_delete), email, confirmed_at (null mens ventende) og created_at. status_page_id kommer fra status_pages_list. Trenger tillatelsen uptime.manage og returnerer personopplysninger (e-postadresser). Krever planen Business eller Enterprise (ellers 402 plan_limit).

Tillatelse: uptime.manage

Eksempel
curl https://privatusanalytics.com/status_pages/:status_page_id/subscribers.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /workspaces/:workspace_id/status_pages.json Opprett en statusside status_pages_create

Oppretter en offentlig statusside for et arbeidsområde som viser valgte oppetidskontroller, hendelsesinnlegg og en e-postregistrering. Påkrevd er name (maks 100 tegn). slug (små bokstaver, sifre og bindestreker, unik på tvers av alle arbeidsområder) utledes som standard fra navnet, og siden serveres på /status/<slug>. check_ids lister oppetidskontrollene som skal vises (upc_...-ID-er fra uptime_checks_list), og bare kontroller opprettet med public true godtas. published er true som standard, så siden er synlig for alle umiddelbart. Valgfri merkevarebygging er description (maks 2000 tegn), logo_url (må være https), brand_color (hex som #06755b) og custom_domain (et vertsnavn du peker en CNAME mot appen, unikt). Bruk status_page_posts_create for å publisere hendelser etterpå. Trenger tillatelsen uptime.manage. Returnerer siden med id (sp_...), slug, check_ids og subscribers (antall bekreftede abonnenter). Planen avgjør hvor mange sider et arbeidsområde har: ingen på Free (402 plan_limit), 1 på Pro og 10 på Business. Et custom_domain og e-postabonnenter krever planen Business eller Enterprise. Sider utover planens antall beholdes og er offline.

Tillatelse: uptime.manage

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/status_pages.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /status_pages/:id.json Slett en statusside status_pages_delete

Sletter en statusside permanent sammen med alle hendelsesinnleggene og abonnentene. Den offentlige siden og det egendefinerte domenet slutter å virke med en gang og dette kan ikke angres. Selve oppetidskontrollene slettes ikke. id kommer fra status_pages_list. Trenger tillatelsen uptime.manage. Returnerer den slettede siden.

Tillatelse: uptime.manage

Eksempel
curl -X DELETE https://privatusanalytics.com/status_pages/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/status_pages.json List statussider status_pages_list

Lister statussidene i et arbeidsområde sortert etter navn. Bruk query for å treffe en del av et navn eller en slug. Når den som kaller er begrenset til noen nettsteder, returneres bare sider der alle kontrollene ligger innenfor disse nettstedene. Har sideinndeling med page og per_page (opptil 100). Hvert element har feltene beskrevet i status_pages_get. Trenger workspace_id fra workspaces_list.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/status_pages.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /status_pages/:id.json Hent en statusside status_pages_get

Returnerer én statusside med innstillingene. Feltene er id (sp_...), workspace_id, name, slug, custom_domain (null når ingen), description, logo_url, brand_color, published, check_ids (ID-ene til oppetidskontrollene som vises på siden), subscribers (antall bekreftede e-postabonnenter) og created_at. Bruk status_page_posts_list for hendelsene og status_page_subscribers_list for personene. id kommer fra status_pages_list.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/status_pages/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /status_pages/:id.json Endre en statusside status_pages_update

Endrer en statusside. Bare verdiene du sender, endres, så send bare published false for å ta siden offline eller check_ids for å erstatte de viste kontrollene (hele listen erstattes, den slås ikke sammen). Inputene og grensene deres er de samme som i status_pages_create. Send custom_domain som en tom streng for å fjerne det egendefinerte domenet. Bare kontroller med public true kan vises, og en bruker som er begrenset til noen nettsteder, kan bare legge kontroller fra de nettstedene på en side. id kommer fra status_pages_list. Trenger tillatelsen uptime.manage. Returnerer den oppdaterte siden.

Tillatelse: uptime.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/status_pages/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Søk

GET /sites/:site_id/search.json Søkerapport: klikk, visninger, CTR, posisjon, toppspørringer og -sider, landingssider og muligheter search_report

Søkeytelse fra Google Search Console og Bing Webmaster, koblet til nettstedets egne landingssidemetrikker. Velg provider: all (standard) legger sammen alle tilkoblede søkemotorer, med posisjon vektet etter visninger og land og enheter bare fra Google, eller google eller bing alene, og vanlig period eller egendefinert from og to. limit (1 til 100, standard 25) begrenser radene i hver tabell. Resultatet har period, provider, connection (property, status, last_synced_at for den valgte søkemotoren, eller null når den ikke er tilkoblet eller provider er all), connections (hver tilkoblede søkemotor med provider, property, status og last_synced_at), latest_date (nyeste dag med data), delayed (true når tidsrommet strekker seg forbi latest_date), totals og series (per dag), hver med clicks, impressions, ctr (en prosent, ikke en brøk, 2 desimaler) og position (gjennomsnittlig rangering, 1 er best, null hvis ukjent), breakdowns for query, page, country og device (rader med value pluss de samme fire metrikkene), landing_pages (toppsider med visits, bounce_rate og conversion_rate som prosent, og conversions) og opportunities (low_ctr_queries med minst 100 visninger og en CTR under 2 prosent, og striking_distance-sider med gjennomsnittsposisjon 8 til 20). Landverdier er slik leverandøren rapporterer dem. Bruk stats_breakdown for besøksdata og dette verktøyet for det som skjer før klikket. Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/search.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
DELETE /sites/:site_id/search/connections/:provider.json Koble fra Search Console eller Bing og slett dataene search_disconnect

Kobler en søkeleverandør (google eller bing) fra et nettsted og sletter de importerte søkedataene for den leverandøren permanent. Dette kan ikke angres. Google-autorisasjonen fjernes også når ingen nettsteder bruker den lenger. Feiler hvis den leverandøren ikke er tilkoblet. Returnerer den fjernede tilkoblingen. Trenger sites.manage.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/search/connections/:provider.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/search/sync.json Importer søkedata nå search_sync

Setter en umiddelbar import av søkedata i kø for en tilkoblet leverandør (google, som er standard, eller bing) i stedet for å vente på den vanlige tidsplanen. Den returnerer med en gang (HTTP 202) med tilkoblingen, og importen kjører i bakgrunnen. Spør search_report gjentatte ganger og følg med på connection.last_synced_at. Søkemotorer rapporterer med et par dagers forsinkelse, så de nyeste dagene forblir tomme selv etter en synkronisering. Feiler hvis leverandøren ikke er tilkoblet. Trenger sites.manage.

Tillatelse: sites.manage

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/search/sync.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Trafikkregler

POST /sites/:site_id/traffic_rules.json Legg til en trafikkregel traffic_rules_create

Legger til et mønster i en av nettstedets blokkerings- eller tillatelseslister. list er en av hostnames, paths, referrers, countries, ip_ranges, user_agents eller events. pattern bruker * som jokertegn og treffet er uavhengig av store og små bokstaver, for eksempel /admin/*, et vertsnavn, en henviservert som spam.example, en landskode på to bokstaver (lagres med store bokstaver), et nettlesernavn med hovedversjon siden user agent reduseres (for eksempel Chrome 120), eller et egendefinert hendelsesnavn. ip_ranges tar en IPv4- eller IPv6-adresse eller CIDR (203.0.113.0/24), som må være gyldig. Et mønster kan finnes én gang per liste, og et nettsted kan ha opptil 500 regler. Om listen blokkerer eller tillater de som treffer, avhenger av modusen, som er block som standard og endres med sites_update. Treff forkastes ved innsamlingen og lagres ikke, og regelen gjelder i løpet av minutter for nye treff. Trenger sites.manage. Krever Pro-planen eller høyere (ellers 402 plan_limit).

Tillatelse: sites.manage

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/traffic_rules.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/traffic_rules/:id.json Slett en trafikkregel traffic_rules_delete

Sletter en trafikkregel, funnet med id fra traffic_rules_list. Treff den forkastet, telles på nytt fra da av, og treff som allerede er forkastet, er borte for godt. Merk at å slette det siste mønsteret i en liste i allow-modus får den listen til å slutte å filtrere. Returnerer den slettede regelen. Trenger sites.manage.

Tillatelse: sites.manage

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/traffic_rules/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/traffic_rules.json List trafikkregler traffic_rules_list

Lister nettstedets trafikkregler, som er blokkerings- eller tillatelseslister brukt ved innsamlingen for å avgjøre hvilke treff som teller. Hver regel har id (en UUID for oppdatering og sletting), list (hostnames, paths, referrers, countries, ip_ranges, user_agents eller events), pattern, label (valgfritt notat), mode (block eller allow, modusen for hele den listen) og created_at. I block-modus forkastes et treff som samsvarer med et hvilket som helst mønster i listen, i allow-modus forkastes et treff som ikke samsvarer med noen, og en tom liste filtrerer ingenting. Filtrer med list. Listens modus settes ikke her, den settes med sites_update ved hjelp av traffic_rule_modes. Bruk traffic_rules_test for å sjekke et eksempeltreff. Trenger analytics.read.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/traffic_rules.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/traffic_rules/test.json Test om et treff ville blitt talt med nettstedets gjeldende regler traffic_rules_test

Prøvekjøring som forteller om et eksempeltreff ville blitt talt under nettstedets gjeldende trafikkregler. Ingenting lagres. Send hvilke som helst av url (en full side-URL, vert og sti kontrolleres), referrer (URL eller vertsnavn), country (kode på to bokstaver), ip (kontrolleres mot ip_ranges, lagres aldri), user_agent (en full User-Agent-streng, redusert til nettleser og hovedversjon) og event (et egendefinert hendelsesnavn). Verdier du utelater, kontrolleres ikke. Resultatet har counted (true hvis treffet ville blitt registrert), blocked_by (listen som forkastet det, eller null), mode (block eller allow for den listen, eller null) og values (de normaliserte verdiene som ble kontrollert). Regler leses live, så en ny regel vises med en gang. Trenger analytics.read. Krever Pro-planen eller høyere (ellers 402 plan_limit).

Tillatelse: analytics.read

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/traffic_rules/test.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
PATCH /sites/:site_id/traffic_rules/:id.json Endre en trafikkregel traffic_rules_update

Endrer mønsteret eller etiketten til en trafikkregel, funnet med id fra traffic_rules_list. Bare verdiene du sender, endres. Listen kan ikke endres, slett og opprett regelen på nytt for å flytte den til en annen liste. Mønsteret må forbli gyldig for listen sin (en CIDR for ip_ranges) og være unikt i den. Send en tom label for å tømme den. Gjelder bare nye treff. Trenger sites.manage. Krever Pro-planen eller høyere (ellers 402 plan_limit).

Tillatelse: sites.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/traffic_rules/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Trakter

POST /sites/:site_id/funnels.json Opprett en trakt funnels_create

Oppretter en trakt, en sekvens av trinn som besøk beveger seg gjennom, målt per besøk. Send name og steps, en ordnet liste av {type, value, match, name}. type er page, event eller goal. value er en sti for page-trinn (for eksempel /pricing), et egendefinert hendelsesnavn for event-trinn, eller en mål-ID (goal_..., fra goals_list) for goal-trinn. match gjelder bare page-trinn og er exact, prefix, glob (* som jokertegn) eller regex, og er som standard glob når verdien har en * og ellers exact. name er en valgfri etikett. Trinn med tom verdi forkastes. order_mode er strict (hvert trinn må komme etter det forrige, standard) eller any (trinn i hvilken som helst rekkefølge). window er visit (standard) eller day, og begge måler innenfor ett enkelt besøk fordi ingen besøkende-ID lagres. Plangrenser gjelder. Free tillater 3 trakter per nettsted og 5 trinn, Pro tillater 10 trinn og Business 20, og en trakt trenger minst 2 trinn. Returnerer trakten med id (fun_...). Les resultatene med funnels_get. Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/funnels.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/funnels/:id.json Slett en trakt funnels_delete

Sletter en traktdefinisjon permanent. Ingen analysedata berøres, men trakten og innstillingene kan ikke gjenopprettes og det finnes ingen angrefunksjon. Returnerer den slettede trakten. ID-er (fun_...) kommer fra funnels_list. Bruk funnels_update for å endre en trakt i stedet. Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/funnels/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/funnels.json List trakter med innganger, fullføringer og rate funnels_list

Lister traktene for et nettsted med hovedresultatene for perioden, ordnet etter navn. Hver trakt har id (fun_...), name, steps, order_mode, window og stats {entered, completed, conversion_rate}, der entered er besøk som nådde trinn 1, completed er besøk som nådde siste trinn og conversion_rate er en prosent (0 til 100). Har sideinndeling med page og per_page (maks 100, standard 25). Tar de felles inputene period og filters. For detaljer trinn for trinn, bruk funnels_get, og bruk funnels_create for å legge til en.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/funnels.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/funnels/:id.json Traktrapport: trinnantall, konvertering, frafall, tid mellom trinn og hvor besøkene gikk i stedet funnels_get

Konverteringsrapporten for én trakt for en periode. Returnerer period, funnel_id, name, order_mode, window, steps, overall_conversion_rate, breakdown og, med compare, comparison. Hvert trinn har index (fra 1), name, type, value, match, count (besøk som nådde det), step_conversion_rate (prosent av forrige trinn), overall_conversion_rate (prosent av trinn 1), dropoff og dropoff_rate (besøk som forlot etter dette trinnet), median_seconds_from_previous (null for trinn 1) og next_pages (de 5 øverste sidene som ble besøkt neste av besøk som falt fra, med (exit) for de som forlot). Rater er prosent fra 0 til 100. Sett breakdown til channel, device, country, utm_campaign, utm_source, browser eller os for å få total konvertering per verdi (de 20 øverste). comparison har den andre periodens antall, overall_conversion_rate og change (prosent, null når den tidligere raten var 0). Sidefiltre ignoreres her fordi de ville kuttet besøk, bruk et page-trinn i stedet. Tar de felles inputene period, compare, filters og segment. ID-er kommer fra funnels_list.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/funnels/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/funnels/:id.json Oppdater en trakt funnels_update

Endrer en trakt. Bare verdiene du sender, endres. Å sende steps erstatter hele listen med trinn, så send hvert trinn i rekkefølge (format og trinngrenser er de samme som i funnels_create, Free tillater 5 trinn, Pro 10 og Business 20, og goal-trinn må navngi mål for dette nettstedet). Du kan også endre name, order_mode (strict eller any) og window (visit eller day). Resultater beregnes fra definisjonen når de leses, så å endre en trakt gjelder hele historikken umiddelbart og tidligere viste tall vil avvike. Returnerer trakten. ID-er kommer fra funnels_list. Trenger tillatelsen content.write.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/funnels/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Undersøkelser

POST /sites/:site_id/surveys.json Opprett en undersøkelse surveys_create

Oppretter en undersøkelse på nettstedet uten informasjonskapsler for et nettsted. Den samler ikke inn noe før statusen er active, så opprett den som draft først eller send status active for å starte med en gang. Påkrevd er name (internt, besøkende ser det aldri, maks 120 tegn) og questions (1 til 5 rader i rekkefølge). Hvert spørsmål er et objekt med key (valgfri, en stabil id av små bokstaver, sifre og understreker, genereres når den utelates), kind (text, choice, multi, rating, nps eller yes_no), prompt (påkrevd, maks 200 tegn), required (boolsk), choices (en liste med opptil 10 alternativer, bare for choice og multi) og scale (3, 5, 7 eller 10, bare for rating, standard 5). NPS bruker alltid 0 til 10. Målretting er trigger_kind (immediate, delay, scroll, exit eller manual) med delay_seconds (0 til 600, standard 10, bare for delay) og scroll_percent (1 til 100, standard 50, bare for scroll), paths (rader med match_type exact, prefix eller glob og pattern, tom betyr hver side), devices (desktop, mobile, tablet, tom betyr alle), position (bottom_right, bottom_left eller center), sample_rate (1 til 100 prosent av besøkende), thank_you (maks 200 tegn), starts_on og ends_on (YYYY-MM-DD). Undersøkelser kan ikke be om en e-postadresse, og skrevne svar renses for personopplysninger. Free-planen tillater 1 undersøkelse per arbeidsområde og et begrenset antall svar i måneden, betalte planer er ubegrenset. Trenger tillatelsen content.write. Returnerer undersøkelsen med id (svy_...). Les svarene med surveys_get.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/surveys.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/surveys/:id.json Slett en undersøkelse med svarene surveys_delete

Sletter en undersøkelse permanent sammen med alle svarene. Dette kan ikke angres og resultatene går tapt. Bruk surveys_pause i stedet hvis du bare vil slutte å samle inn. id kommer fra surveys_list og site_id er påkrevd. Trenger tillatelsen content.write. Returnerer den slettede undersøkelsen.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/surveys/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/surveys.json List undersøkelsene til et nettsted med antall svar surveys_list

Lister undersøkelsene for et nettsted, nyeste først, med innstillinger og antall svar. Filtrer med status (draft, active, paused eller all, standard all). Har sideinndeling med page og per_page (standard 25, opptil 100). Hver undersøkelse har id (svy_...), name, status, questions, målrettingsinnstillinger, starts_on, ends_on, created_at, updated_at og stats (antall for responses, completed og this_month). Bruk surveys_get for svarene og resultatene for én undersøkelse.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/surveys.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/surveys/:id/pause.json Slutt å samle inn svar og behold de som allerede er gitt surveys_pause

Pauser en undersøkelse slik at den slutter å bli tilbudt besøkende med en gang. Svar som allerede er samlet inn, beholdes og vises i surveys_get, og surveys_start gjenopptar den. Bruk den i stedet for surveys_delete når du bare vil slutte å samle inn. id kommer fra surveys_list og site_id er påkrevd. Trenger tillatelsen content.write. Returnerer undersøkelsen med status paused.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/surveys/:id/pause.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/surveys/:id.json Undersøkelsesresultater for en periode, fordelt per spørsmål surveys_get

Returnerer resultatrapporten for én undersøkelse over en periode, ikke bare innstillingene (bruk surveys_list for innstillinger og antall). Velg period som forhåndsinnstilling (standard 30d) eller period custom med from og to. Svaret har survey (innstillingene), period (from og to som ISO 8601-tidspunkter), responses (folk som svarte på minst ett spørsmål), completed (folk som svarte på det siste spørsmålet), questions (én oppføring per spørsmål med key, kind, prompt og antall svar, pluss detaljer etter type) og pages, devices og countries (opptil 10 rader hver av value og count). Detaljer etter type er texts (opptil 100 nyeste skrevne svar med text og at) for text, choices (value, count, share som prosent med ett desimal, offered) for choice, multi og yes_no, average (null uten svar), scale og distribution for rating, og score (NPS fra -100 til 100, null uten svar), promoters (9 og 10), passives (7 og 8), detractors (0 til 6) og distribution for nps. Bruk surveys_themes for å oppsummere skrevne svar.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/surveys/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/surveys/:id/start.json Begynn å samle inn svar surveys_start

Setter en undersøkelse til active slik at den kan tilbys besøkende. Den vises bare når dagens dato ligger innenfor starts_on og ends_on (når satt), siden samsvarer med paths og devices, og planens månedlige svarkvote ikke er brukt opp. Bruk den for et utkast eller en pauset undersøkelse. id kommer fra surveys_list og site_id er påkrevd. Trenger tillatelsen content.write. Returnerer undersøkelsen med status active. Stopp den igjen med surveys_pause.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/surveys/:id/start.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/surveys/:id/themes.json Grupper fritekstsvarene på ett spørsmål i temaer (Business-planen) surveys_themes

Bruker AI til å gruppere de skrevne svarene på ett fritekstspørsmål i temaer. Bare Business-planen. Velg den etter at surveys_get viser et tekstspørsmål med nok svar, og send question_key (key til et spørsmål av typen text fra surveys_get). Den trenger minst 5 skrevne svar og bruker de 300 nyeste. Resultatet lister opptil 12 temaer, hvert med label, count, sentiment (positive, neutral eller negative) og example (et representativt svar, kan være null), pluss answers (hvor mange svar som ble oppsummert) og generated_at. Hver nye generering bruker ett spørsmål fra arbeidsområdets månedlige AI-kvote, som gis tilbake hvis den feiler. Resultatet bufres mot svarene, så å kalle på nytt uten nye svar koster ingenting. Den feiler med en valideringsfeil når planen ikke inkluderer den, kvoten er brukt opp, AI-en ikke er konfigurert eller det er for få svar.

Tillatelse: analytics.read

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/surveys/:id/themes.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
PATCH /sites/:site_id/surveys/:id.json Oppdater en undersøkelse surveys_update

Endrer en undersøkelse. Bare verdiene du sender, endres. Inputer og grenser er de samme som i surveys_create, med status draft, active eller paused. Når du sender questions, erstattes hele listen, så ta med hvert spørsmål du vil beholde og behold hver eksisterende key for å beholde de innsamlede svarene (å omformulere en prompt med samme key deler ikke opp resultatene). Spørsmål du utelater, slutter å vises i resultater. Endringer i målretting trer i kraft for besøkende umiddelbart. id kommer fra surveys_list og site_id er påkrevd. Trenger tillatelsen content.write. Returnerer den oppdaterte undersøkelsen.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/surveys/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Uttalelser

GET /sites/:site_id/testimonials/overview.json Les tallene for et nettsted, hva som trenger oppmerksomhet og hva som har skjedd i det siste testimonials_overview

stats inneholder de fem tallene på oversiktssiden: godkjente uttalelser, ventende, nye denne måneden, gjennomsnittsvurdering og i bruk. attention lister det som trenger en avgjørelse med antallet. activity er de siste 10 hendelsene og latest_approved de tre sist godkjente uttalelsene.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/overview.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/setup.json Hent oppsettlisten til et nettsted testimonials_setup_get

Returnerer punktene import, testimonials, approve, ask, widget og teammate, hvert med done og dismissed. Et punkt er ferdig ut fra det nettstedet inneholder, aldri ved et klikk. hidden er true når hvert punkt er ferdig eller avvist, og da slutter innboksen å vise kortet.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/setup.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/setup.json Avvis ett punkt i oppsettlisten, eller hele kortet testimonials_setup_update

dismiss er én punktnøkkel (import, testimonials, approve, ask, widget eller teammate) eller all for hele kortet. Å avvise skjuler punktet og markerer det aldri som ferdig, og det kan ikke hentes tilbake gjennom API-et.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/setup.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/:id/approve.json Godkjenn en uttalelse slik at den kan vises testimonials_approve

En uttalelse som venter på kvote kan ikke godkjennes: serveren svarer med 422 og koden waiting_for_allowance. Svaret inneholder meta.undo_id.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/:id/approve.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/bulk.json Kjør én handling over et utvalg uttalelser, eller over alt et filter treffer testimonials_bulk

Send ids (opptil 100, kjørt på en gang, alle eller ingen) eller filters med confirm_count (hele resultatet). Mer enn 100 kjøres i bakgrunnen, og svaret har state running. Handlinger: approve, reject, mark_pending, pin, unpin, add_tags, remove_tags, add_to_collection, remove_from_collection, set_property, trash, restore. Hver svarer med en angre-id som testimonials_bulk_undo tar i 7 dager. delete_permanently er den ene handlingen som ikke kan angres: den krever sites.manage, og svaret sier undoable false. Over MCP kjøres ikke de to handlingene som sletter, trash og delete_permanently: verktøyet svarer med human_only og siden i appen der en person gjør det, og alle andre handlinger kjøres. Over API-et endrer handlingen export (med ids eller filters, og et valgfritt format av csv, json, ndjson eller xlsx) ingenting: den krever analytics.export og svarer med 202 og eksporten som kan lastes ned.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/bulk.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/bulk/:id/undo.json Angre en massehandling innen 7 dager testimonials_bulk_undo

Setter den tidligere verdien tilbake på hver uttalelse kjøringen endret. En som er endret igjen siden, blir latt i fred og telt i left. Over MCP kjøres ikke en angring som ville slette eller flytte til papirkurven (angring av en gjenoppretting, av en oversettelseskjøring og av en kjøring som lager bilder): verktøyet svarer med human_only og siden i appen der en person gjør det.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/bulk/:id/undo.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials.json Legg til en uttalelse for hånd eller gjennom API-et testimonials_create

Lagres gjennom den ene inngangen alle ruter bruker. Den teller mot planens månedlige kvote for nye uttalelser, og ved kvoten svarer serveren med 422 og koden allowance_reached (bare en kundes skjemainnsending holdes i stedet som ventende). Samme person som sier de samme ordene igjen avvises med koden duplicate med mindre allow_duplicate er true. Samme external_id igjen returnerer den som allerede er lagret.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/:id/permanent.json Slett en uttalelse permanent, med historikk, samtykkepost og filer testimonials_delete

Dette kan ikke angres. Det fungerer på en uttalelse i papirkurven eller utenfor, krever confirm og tillatelsen sites.manage. Over MCP sletter verktøyet ingenting og svarer med siden der en person gjør det.

Tillatelse: sites.manage · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/:id/permanent.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/:id.json Flytt en uttalelse til papirkurven i 30 dager testimonials_trash

Uttalelsen beholder status, etiketter, samlinger og filer, vises ingen steder og slettes permanent etter 30 dager. testimonials_restore setter den tilbake nøyaktig slik den var. Svaret inneholder meta.undo_id. Å legge i papirkurven en som allerede ligger der endrer ingenting. Over MCP endrer verktøyet ingenting og svarer med siden i appen der en person gjør det.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/facets.json Tell uttalelsene bak hver filterverdi, for samme inndata som listen testimonials_facets

Formen på biblioteket uten å lese noen uttalelse. Hver facet teller verdiene sine med sitt eget valg utelatt og alle andre filtre brukt. meta inneholder totalen og filteret i ord.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/facets.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/:id/highlight.json Marker den beste setningen i en uttalelse, eller fjern den testimonials_highlight

highlight må være en nøyaktig del av uttalelsens ord, ellers svarer serveren med 422. En tom highlight fjerner den. Hver endring er en versjon i historikken.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/:id/highlight.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/:id/history.json List alle versjoner av en uttalelses ord, tittel, vurdering og utheving testimonials_history

Nyeste først. Versjon 1 er uttalelsen slik den ble mottatt og har ingen forfatter. Hver senere versjon har medlemmet som laget den, når, notatet de la igjen og, for en gjenoppretting, versjonen den satte tilbake. Delt opp i sider med page og per_page.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/:id/history.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials.json List et nettsteds uttalelser, filtrert og sortert testimonials_list

Tre måter å si hvilke, og de legges sammen: facet-inndataene (status, tag_id, has_video og resten), q (søkeboksen med operatorene, for eksempel rating:5 has:video tag:onboarding "saved us") og conditions med match (strukturerte rader). Send facets som true for det levende antallet bak hver facet-verdi i meta.facets. Ingenting i papirkurven listes med mindre trashed er true, som bare lister papirkurven.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/:id/pend.json Sett en uttalelse tilbake til ventende testimonials_pend

Tar en godkjent eller avvist uttalelse tilbake til ventende, slik at den vises ingen steder før den avgjøres igjen. Svaret inneholder meta.undo_id. En uttalelse i papirkurven avvises med koden in_trash.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/:id/pend.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/:id/pin.json Fest en uttalelse slik at den vises først, eller løsne den testimonials_pin

En festet uttalelse vises først overalt den vises. Send pinned false for å løsne. Svaret inneholder meta.undo_id når noe ble endret.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/:id/pin.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/:id/reject.json Avvis en uttalelse. Den beholdes og vises ingen steder testimonials_reject

Uttalelsen beholder alt den har og vises ingen steder. Å avvise en som allerede er avvist endrer ingenting. Svaret inneholder meta.undo_id, som testimonials_bulk_undo tar i 7 dager. En uttalelse i papirkurven avvises med koden in_trash.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/:id/reject.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/:id/restore.json Gjenopprett en uttalelse fra papirkurven, nøyaktig slik den var testimonials_restore

Setter en uttalelse fra papirkurven tilbake til sin status, etiketter, samlinger og stedene som viste den. Den teller aldri som en ny uttalelse. En som ikke er i papirkurven avvises med koden not_in_trash.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/:id/restore.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/:id/restore_version.json Sett tilbake ordene, tittelen, vurderingen og uthevingen fra en tidligere versjon testimonials_restore_version

Ingenting fjernes fra historikken. Gjenopprettingen er en ny versjon som sier hvilken den kom fra. version 1 setter uttalelsen tilbake til ordene slik de ble mottatt. Et ukjent versjonsnummer gir 422.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/:id/restore_version.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/:id.json Hent én uttalelse med personen, filene, samtykkeposten, etikettene og hvor den brukes testimonials_get

Returnerer én uttalelse på nettstedet ut fra id-en (tm_...), i papirkurven eller ikke. person.email er null med mindre kalleren har content.write, og has_email sier om det finnes en på fil. media lister filene med behandlingsstatus. used_in lister hver widget, vegg og bilde som viser den.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/showable.json List uttalelsene offentligheten kan se, slik offentligheten kan se dem testimonials_showable

De nyeste godkjente uttalelsene til et nettsted som kan vises offentlig, for en egen visning utenfor widgetene og veggene. Hver inneholder bare det samtykkeposten tillater: en person hvis navn ikke kan vises, leses som A customer, og et bilde eller et opptak utelates med mindre det var tillatt. En ventende, avvist eller slettet uttalelse, eller en som venter på kvoten, listes aldri. Det er ingen e-post i svaret.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/showable.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/triage.json Hent neste uttalelse i en triagekø testimonials_triage

Uten filter er køen Ventende, ikke venter på kvote, eldst mottatt først. Med innboksfiltrene er det det resultatet i sin sortering. Send after med id-en som nettopp ble behandlet for å få den som følger. data er null når køen er tom. meta inneholder remaining og total.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/triage.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/:id.json Rediger en uttalelse. Endringer i ordene, tittelen, vurderingen og utheving beholdes i historikken testimonials_update

Bare inndataene som sendes endres. En endring i body, title, rating eller highlight legger til en versjon i historikken med edit_note, og endrer aldri den verifiserte markeringen. rating null fjerner den. highlight må være en nøyaktig del av ordene, og en tom fjerner den. properties endrer bare nøklene som sendes. add_tags og remove_tags tar navn eller id-er. Status, feste og papirkurv har egne verktøy. En uttalelse i papirkurven kan ikke redigeres.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Uttalelsesmedier

POST /sites/:site_id/testimonials/media/uploads.json Start en opplasting, eller legg til en fil fra en nettadresse testimonial_media_uploads_create

To måter. For å laste opp, send filename, content_type og byte_size: svaret inneholder upload, med url-en filen skal PUT-es til, hodene som skal sendes med og, for en stor fil, deler som kan sendes én for én. Kall deretter testimonial_media_uploads_finish. Eller send source_url, så lastes filen ned og behandles for deg: spør testimonial_media_get til state er ready. Grenser: video og lyd opptil 500 MB og så lang som planen tillater (2 minutter på Pro, 10 minutter på Business, ingen på Free, der serveren svarer med 402 plan_limit), bilder opptil 10 MB, en logo opptil 2 MB.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/media/uploads.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/media/:id.json Slett en fil som ingen uttalelse beholder testimonial_media_delete

En fil som hører til en uttalelse slettes sammen med uttalelsen, via papirkurven. De lagrede filene slettes, og adressene deres fjernes fra hurtigbufferen.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/media/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/media/uploads/:id/finish.json Si at en opplasting er fullført, slik at filen kontrolleres og behandles testimonial_media_uploads_finish

Kall den når filen er sendt. Filen må ligge i opplastingslageret og ha nøyaktig den størrelsen som ble lovet. Å kalle den to ganger er trygt.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/media/uploads/:id/finish.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/media/:id/retry.json Prøv en mislykket fil på nytt testimonial_media_retry

Behandler filen på nytt fra opplastingen som ble beholdt. Opplastingen beholdes i 24 timer etter en feil. Etter det svarer serveren med not_retryable, og filen må lastes opp på nytt.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/media/:id/retry.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/media/:id.json Hent én fil med status og hvor den lastes fra testimonial_media_get

url er den varige adressen til den ferdige filen på mediavverten, og den er null til state er ready. Adressen er den samme for alle og er ikke signert, så gi bare videre adressen til en fil der feltet shareable er true.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/media/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Varsler

POST /alerts/:id/acknowledge.json Bekreft den siste hendelsen alerts_acknowledge

Merker den siste ukvitterte hendelsen for en varsling som sett av brukeren som kaller. Den løser ikke hendelsen og demper ikke varslingen, varslingen løses av seg selv når tilstanden opphører. Hvis varslingen ikke har noen ukvittert hendelse, feiler kallet med en valideringsfeil. Returnerer varslingen. Bruk alerts_history for å se hendelser med acknowledged_at og acknowledged_by. Trenger bare lesetilgang til analyser, så seere kan kvittere.

Tillatelse: analytics.read

Eksempel
curl -X POST https://privatusanalytics.com/alerts/:id/acknowledge.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/alerts.json Opprett et varsel alerts_create

Oppretter en varslingsregel som overvåker et nettsted (eller hele arbeidsområdet for kind usage) og varsler de valgte kanalene når den utløses. Banen tar workspace_id. name og kind er påkrevd. kind avgjør hva annet som trengs. threshold trenger site_id, metric (visitors, visits, pageviews, bounce_rate eller conversion), operator (gt, gte, lt eller lte) og threshold, og conversion trenger også goal_id. anomaly trenger site_id og metric (visitors, visits eller pageviews), sammenligner siste vindu med samme vindu i hver av de 4 foregående ukene og bruker sensitivity (low, medium eller high). operator lt varsler bare ved fall, gt bare ved topper, og tom varsler ved begge. goal trenger site_id, goal_id og threshold (antall fullføringer i vinduet). no_data trenger site_id og threshold i timer uten hendelser (standard 24). usage trenger ikke noe nettsted og threshold som prosent av den månedlige hendelseskvoten (standard 80). uptime trenger site_id og eventuelt uptime_check_id (standard alle kontroller for nettstedet). ssl trenger site_id og threshold i dager før et sertifikat eller domene utløper (standard 14). vitals trenger site_id, metric (lcp, inp, cls, fcp eller ttfb) og threshold i millisekunder (en score for cls). subscriptions trenger site_id, metric (mrr_drop: MRR falt med mer enn threshold prosent de siste 30 dagene, churn_rate eller mrr_churn_rate: frafallet de siste 30 dagene er over threshold prosent) og threshold (standard 10), og hoppes over mens nettstedet ikke har noen betalingsleverandør tilkoblet eller ingenting å måle. window_minutes (standard 60, 5 til 10080) er hvor langt tilbake hver evaluering ser. channel_ids kommer fra notification_channels_list, og sensitivity er som standard medium. Varsler evalueres automatisk hvert 5. minutt. Terskler for bounce_rate og conversion er prosent fra 0 til 100. Returnerer den opprettede varslingen med state ok.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/alerts.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /alerts/:id.json Slett et varsel alerts_delete

Sletter en varslingsregel og hele hendelseshistorikken permanent. Dette kan ikke angres, og varslene stopper umiddelbart. Hvis du vil pause en varsling uten å miste historikken, bruk alerts_update med enabled false eller alerts_mute. id (alr_...) kommer fra alerts_list. Returnerer den slettede varslingen slik den var. Krever tillatelse til å skrive innhold.

Tillatelse: content.write

Eksempel
curl -X DELETE https://privatusanalytics.com/alerts/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /alerts/:id/history.json Hendelseshistorikk for et varsel alerts_history

Lister hendelsene for én varsling, nyeste først og med sideinndeling. Hver hendelse har triggered_at, resolved_at (null mens den fortsatt er åpen), value (tallet som ble målt da den utløstes, samme enhet som varslingens terskel), message (en lesbar beskrivelse), acknowledged_at og acknowledged_by (visningsnavnet til medlemmet, eller null). Sett open til true for å se bare uløste hendelser. Bruk alerts_acknowledge for å merke den siste som sett og alerts_get for regelens nåværende tilstand.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/alerts/:id/history.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /workspaces/:workspace_id/alerts.json List varsler alerts_list

Lister varslingsreglene i et arbeidsområde (banen tar workspace_id), sortert etter navn og med sideinndeling. Returnerer en data-matrise med varslinger og meta-sideinndeling. Hver varsling har id (alr_...), site_id (pa_..., null for usage-varslinger som overvåker hele arbeidsområdet), name, kind, metric, operator, threshold, window_minutes, sensitivity, goal_id, channel_ids (nch_...-ID-er), state (ok eller triggered), enabled, muted_until, last_triggered_at, last_evaluated_at og created_at. Avgrens med site_id, state (ok eller triggered) eller kind. Bruk site_alerts_list for å liste varslingene for ett nettsted fra en nettstedsbane, alerts_get for én enkelt varsling og alerts_history for hendelsene. En bruker som er begrenset til noen nettsteder, ser aldri usage-varslinger.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/alerts.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /alerts/:id/mute.json Demp (eller opphev demping av) varslingene for et varsel alerts_mute

Demper varslene fra én varsling i et antall minutter mens den fortsetter å evaluere og registrere hendelser i historikken. minutes er som standard 60, maksimum er 43200 (30 dager), og 0 opphever dempingen med en gang. Svaret er varslingen med muted_until satt til slutten av dempingen (null når den ikke er dempet). Bruk alerts_update med enabled false for å slutte helt å evaluere, og alerts_acknowledge for å merke en hendelse som sett uten å dempe.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/alerts/:id/mute.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /alerts/:id.json Hent et varsel alerts_get

Returnerer én varslingsregel etter id (alr_..., fra alerts_list eller site_alerts_list). Svaret er varslingsobjektet med id, site_id (null for usage-varslinger), name, kind, metric, operator, threshold, window_minutes, sensitivity, goal_id, channel_ids, state (ok eller triggered), enabled, muted_until, last_triggered_at, last_evaluated_at og created_at. Det inneholder ikke hendelser, bruk alerts_history for dem. threshold er et tall hvis enhet avhenger av kind (se alerts_create). Krever lesetilgang til analyser.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/alerts/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /alerts/:id.json Oppdater et varsel alerts_update

Endrer en eksisterende varslingsregel (id fra alerts_list). Bare verdiene du sender, endres, alt annet beholder sin verdi. De samme reglene per kind som for alerts_create gjelder resultatet, så å endre kind eller metric kan kreve tilhørende site_id, goal_id, operator eller threshold. Send channel_ids for å erstatte hele listen over varslingskanaler, og enabled false for å slutte å evaluere uten å slette. For å dempe varsler en stund men fortsatt registrere hendelser, bruk alerts_mute i stedet. Returnerer den oppdaterte varslingen.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/alerts/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/alerts.json List varsler for et nettsted site_alerts_list

Lister varslingsreglene for ett nettsted (banen tar site_id), sortert etter navn og med sideinndeling. Returnerer de samme varslingsobjektene og godtar de samme filtrene state og kind som alerts_list, men bare for dette nettstedet, så usage-varslinger (som ikke har noe nettsted) er ikke med. Velg denne når du allerede har en nettsted-ID, og alerts_list når du vil ha alle varslinger i arbeidsområdet. Hver varsling har id (alr_...), site_id, name, kind, metric, operator, threshold, window_minutes, sensitivity, goal_id, channel_ids, state (ok eller triggered), enabled, muted_until, last_triggered_at, last_evaluated_at og created_at.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/alerts.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"

Varslingskanaler

DELETE /channels/:id.json Slett en varslingskanal notification_channels_delete

Sletter en varslingskanal og fjerner den fra alle varsler som brukte den, slik at disse varslene slutter å varsle der. Dette kan ikke angres, og selve varslene beholdes. id (nch_...) kommer fra notification_channels_list. Returnerer den slettede kanalen.

Tillatelse: content.write

Eksempel
curl -X DELETE https://privatusanalytics.com/channels/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/channels.json List varslingskanaler notification_channels_list

Lister varslingskanalene i et arbeidsområde (banen tar workspace_id), sortert etter navn og med sideinndeling. En kanal er et sted varsler leveres til. Hver har id (nch_...), kind (email, slack, teams, discord, webhook, pagerduty, opsgenie eller push), name, target (en maskert oppsummering som e-postadressene eller slutten av en webhook-URL, hemmeligheter returneres aldri), last_used_at og created_at. Filtrer etter kind. Bruk ID-ene som channel_ids i alerts_create og alerts_update. Brukere som er begrenset til noen nettsteder, ser bare kanaler brukt av varsler på nettstedene sine.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/channels.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /channels/:id/send_test.json Send en testmelding gjennom en kanal notification_channels_send_test

Sender en ekte testmelding gjennom kanalen (en e-post, et chat-innlegg, et webhook-kall og så videre), så bruk den bare når brukeren vil det. Kallet feiler med en feil som navngir årsaken hvis leveringen ikke virker, ellers returnerer det kanalen. Testsendinger har frekvensbegrensning per arbeidsområde, og e-postkanaler også per ekstern adresse. Bruk den etter notification_channels_create eller notification_channels_update for å bekrefte at en URL eller nøkkel er riktig.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/channels/:id/send_test.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /channels/:id.json Hent en varslingskanal notification_channels_get

Returnerer én varslingskanal etter id (nch_..., fra notification_channels_list). Svaret har kind, name, target (en maskert oppsummering, hemmeligheter som webhook-URL-er og nøkler returneres aldri), last_used_at og created_at. Bruk notification_channels_send_test for å sjekke at den leverer.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/channels/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /notifications/unsubscribe/:token.json Avslutt abonnementet for en adresse på én varslingskanal eller oppetidskontroll med tokenet fra en e-post notification_unsubscribes_create

Tillatelse: public · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X POST https://privatusanalytics.com/notifications/unsubscribe/:token.json \
  -H "Content-Type: application/json" -d '{…}'
POST /push_subscription.json Registrer en nettleser for push-varsler push_subscriptions_create

Registrerer den nåværende nettleseren for pushvarsler på nettet, ved hjelp av de tre verdiene fra nettleserens PushSubscription (endpoint, p256dh og auth). Et abonnement mottar varsler fra alle arbeidsområder medlemmet tilhører, for alle nettsteder, og derfor kan et API-token bare bruke den når det kan lese hele arbeidsområdet sitt og medlemmet ikke har noe annet arbeidsområde. Å kalle den på nytt med samme endpoint oppdaterer nøklene og flytter abonnementet til den som kaller. endpoint må være en offentlig https-URL til en pushtjeneste. Dette registrerer bare nettleseren, så varsler trenger fortsatt en varslingskanal av typen push (notification_channels_create). Returnerer endpoint_host (vertsnavnet til pushtjenesten, ikke hele endepunktet) og created_at. Økter åpnet via en identitetsleverandør for arbeidsområdet, kan ikke bruke den.

Tillatelse: member

Eksempel
curl -X POST https://privatusanalytics.com/push_subscription.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /push_subscription.json Fjern en nettlesers push-registrering push_subscriptions_delete

Fjerner en av det innloggede medlemmets nettleserregistreringer for push, slik at nettleseren slutter å motta varsler. Send det samme endpoint som ble brukt med push_subscriptions_create. Feiler med ikke funnet når det ikke finnes noe slikt abonnement for medlemmet. Returnerer det fjernede abonnementet som endpoint_host og created_at. Den sletter ingen varslingskanal. Underlagt de samme tokenbegrensningene som push_subscriptions_create.

Tillatelse: member

Eksempel
curl -X DELETE https://privatusanalytics.com/push_subscription.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Walls of Love

POST /sites/:site_id/testimonials/walls.json Opprett en Wall of Love testimonial_walls_create

En vertsbasert side på https://privatus.page/w/<slug>. Alt som utelates starter fra en standard: tittelen Wall of Love, murverksoppsettet, slug-en fra navnet.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/walls.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/walls/:id.json Flytt en vegg til papirkurven testimonial_walls_trash

Siden svarer at den er tatt ned til den gjenopprettes, og en innebygd kopi viser ingenting. Å gjenopprette den bringer den tilbake på samme adresse. Den slettes for godt etter 30 dager. Over MCP endrer verktøyet ingenting og svarer med siden i appen der en person gjør det.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/walls/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/walls/:id/duplicate.json Kopier en vegg under et nytt navn og en ny adresse testimonial_walls_duplicate

Lager en kopi med en ny id, navnet som slutter på «copy» og en egen slug, så den har sin egen adresse. Originalen og adressen endres ikke.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/walls/:id/duplicate.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/walls/:id/embed.json Hent lenken til en vegg og koden for å plassere den inne i en annen side testimonial_walls_embed

Veggens offentlige adresse, og skript-, ramme- og vanlig lenke-kodene som plasserer den inne i en annen side. Kodene endres aldri når veggen redigeres.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/walls/:id/embed.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/walls.json List Walls of Love for et nettsted testimonial_walls_list

Hver Wall of Love på nettstedet som ikke er i papirkurven, med adressen, hva som mater den og hvor mange uttalelser den viser. Bruk q for å søke etter navn eller slug og sort for å sortere etter navn eller nyeste.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/walls.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/walls/:id/restore.json Gjenopprett en vegg fra papirkurven testimonial_walls_restore

Tar en vegg ut av papirkurven. Siden svarer igjen på samme adresse, og hver innebygd kopi viser den igjen uten endring i koden som ble limt inn.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/walls/:id/restore.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/walls/:id.json Hent én vegg med alle innstillinger testimonial_walls_get

Alt byggeren lagrer: adressen (/w/<slug>), overskriften og knappen, oppsettet, hva som mater veggen, hva hvert kort viser, stilen og søkemotorinnstillingene. En vegg i papirkurven svarer med 404.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/walls/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/walls/:id.json Endre en vegg testimonial_walls_update

Bare inndataene som sendes endres. En endret slug lar den gamle adressen omdirigere.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/walls/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Webhooks

GET /workspaces/:workspace_id/webhooks/:webhook_id/deliveries.json List leveringer for en webhook webhook_deliveries_list

Lister leveringene sendt til én webhook (banen tar webhook_id), nyeste først og med sideinndeling. Hver har id (whd_...), event, status (pending, succeeded for ethvert 2xx-svar, eller failed), status_code (null når ingen respons kom), error (en kort årsak som et tidsavbrudd, ellers null), attempt (hvor mange forsøk så langt), duration_ms, payload (JSON-dataene som ble sendt), response_body (de første 2000 tegnene av svaret) og delivered_at og created_at. Filtrer med status succeeded eller failed. Bruk den for å feilsøke et endepunkt og webhook_deliveries_redeliver for å sende en igjen.

Tillatelse: workspace.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/webhooks/:webhook_id/deliveries.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /workspaces/:workspace_id/webhooks/:webhook_id/deliveries/:id/redeliver.json Send en levering på nytt webhook_deliveries_redeliver

Sender nyttelasten fra en tidligere levering på nytt som en ny levering til samme endepunkt (id whd_..., fra webhook_deliveries_list). Dette gjør en HTTP-forespørsel til kundens URL, så mottakeren kan behandle den samme hendelsen to ganger. Den har frekvensbegrensning per arbeidsområde (delt med webhooks_test). Den settes i kø, så svaret er en ny levering med status pending, les webhook_deliveries_list for å se utfallet.

Tillatelse: workspace.manage

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/webhooks/:webhook_id/deliveries/:id/redeliver.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/webhooks.json Legg til et webhook-endepunkt webhooks_create

Legger til et endepunkt som mottar POST-sendt JSON for arbeidsområdehendelser (banen tar workspace_id). url må være en offentlig https-adresse, private og interne adresser avvises. events er en påkrevd liste valgt blant alert.triggered, alert.resolved, goal.completed_threshold, uptime.down, uptime.up, export.ready, import.completed, import.failed, site.created, site.deleted, member.added, usage.threshold og site_audit.completed. enabled er som standard true. En signeringshemmelighet (whsec_...) genereres og returneres i svaret, og hver levering har en Privatus-Signature-header med et tidsstempel og en HMAC-SHA256 av innholdet laget med den. Mislykkede leveringer forsøkes på nytt med tiltakende ventetid, og endepunktet deaktiveres etter 20 feil på rad. Bruk webhooks_test for å sende et eksempel.

Tillatelse: workspace.manage

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/webhooks.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /workspaces/:workspace_id/webhooks/:id.json Slett en webhook webhooks_delete

Sletter et webhook-endepunkt og hele leveringsloggen. Dette kan ikke angres, og ventende nye forsøk stopper. For å pause det i stedet, bruk webhooks_update med enabled false. id (wh_...) kommer fra webhooks_list. Returnerer den slettede webhooken.

Tillatelse: workspace.manage

Eksempel
curl -X DELETE https://privatusanalytics.com/workspaces/:workspace_id/webhooks/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /workspaces/:workspace_id/webhooks.json List webhooks webhooks_list

Lister de utgående webhook-endepunktene i et arbeidsområde (banen tar workspace_id), eldste først. Hver har id (wh_...), url, events (hendelsesnavnene den mottar), enabled, status (active, failing etter nylige feil, eller disabled), secret (signeringshemmeligheten, behandle den som sensitiv), consecutive_failures, last_success_at, last_failure_at og created_at. Trenger tillatelsen workspace.manage. Dette er for å sende rå hendelser til din egen server. For å varsle folk, bruk notification_channels_list. Bruk webhook_deliveries_list for det som ble sendt.

Tillatelse: workspace.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/webhooks.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /workspaces/:workspace_id/webhooks/:id.json Hent en webhook webhooks_get

Returnerer ett webhook-endepunkt etter id (wh_..., fra webhooks_list), inkludert signeringshemmeligheten (whsec_...), som brukes til å verifisere Privatus-Signature-headeren på hver levering. Feltene er url, events, enabled, status (active, failing eller disabled), secret, consecutive_failures, last_success_at, last_failure_at og created_at. Trenger tillatelsen workspace.manage.

Tillatelse: workspace.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/webhooks/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /workspaces/:workspace_id/webhooks/:id/test.json Send en testlevering webhooks_test

Setter en webhook.test-levering med en eksempelmelding i kø til ett endepunkt, selv når det er deaktivert, noe som gjør en HTTP-forespørsel til kundens URL. Den har frekvensbegrensning per arbeidsområde (delt med webhook_deliveries_redeliver), og en test forsøkes ikke på nytt. Leveringen sendes i bakgrunnen, så svaret returnerer den køede leveringen med status pending. Les webhook_deliveries_list et øyeblikk senere for å se status_code, error, duration_ms og response_body.

Tillatelse: workspace.manage

Eksempel
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/webhooks/:id/test.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
PATCH /workspaces/:workspace_id/webhooks/:id.json Oppdater en webhook (hendelser, URL, aktivert, roter hemmelighet) webhooks_update

Endrer en webhook (id fra webhooks_list). Bare verdiene du sender, endres. Å sende events erstatter hele listen. Å sette enabled true på et deaktivert endepunkt nullstiller feiltellingen, og slik slår du på igjen et som ble deaktivert etter gjentatte feil. Sett rotate_secret true for å generere en ny signeringshemmelighet, vist i svaret, og den gamle slutter å virke med en gang, så mottakeren må oppdateres. Reglene for url er de samme som i webhooks_create. Returnerer webhooken.

Tillatelse: workspace.manage

Eksempel
curl -X PATCH https://privatusanalytics.com/workspaces/:workspace_id/webhooks/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Widgeter

POST /sites/:site_id/testimonials/widgets/:id/copied.json Noter at den innlimte HTML-innbyggingen til en widget ble kopiert testimonial_widgets_mark_copied

Den innlimte HTML-en oppdateres ikke av seg selv. Etter dette kallet rapporterer testimonial_widgets_embed hvor mange ganger widgeten har endret seg siden.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/widgets/:id/copied.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/widgets.json Opprett en widget testimonial_widgets_create

Ett kall bærer hele widgeten: oppsettet og valgene, hva som mater den, hva hvert kort viser og hvordan den ser ut. Alt som utelates starter fra en standard, og en tom stilinnstilling arver merkevarepakken. Følg det med testimonial_widgets_embed for å få koden som skal limes inn.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/widgets.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /sites/:site_id/testimonials/widgets/:id.json Flytt en widget til papirkurven testimonial_widgets_trash

Innbyggingene viser ingenting og tar ingen plass til den gjenopprettes. Den slettes for godt etter 30 dager. Over MCP endrer verktøyet ingenting og svarer med siden i appen der en person gjør det.

Tillatelse: content.write · Kun HTTP (ikke et MCP-verktøy)

Eksempel
curl -X DELETE https://privatusanalytics.com/sites/:site_id/testimonials/widgets/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/testimonials/widgets/:id/duplicate.json Kopier en widget med alle innstillinger testimonial_widgets_duplicate

Lager en kopi med en ny id og navnet som slutter på «copy». Kopien har sin egen innbyggingskode og er ikke sett aktiv noe sted. Originalen endres ikke.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/widgets/:id/duplicate.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/widgets/:id/embed.json Hent innbyggingskoden til en widget og hva den veier testimonial_widgets_embed

Returnerer skriptkoden (anbefalt), den innlimte HTML-en, rammekoden og adressen til de offentlige dataene, med den målte størrelsen på lasteskriptet og på denne widgeten. Den innlimte HTML-en og rammen er null for hjørnepopupen.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/widgets/:id/embed.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/widgets.json List widgetene til et nettsted testimonial_widgets_list

Widgeter i papirkurven listes ikke. Hver widget har innstillingene sine, hvor mange uttalelser den viser nå, visningene og klikkene de siste 30 dagene og den første siden den ble sett aktiv på.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/widgets.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/testimonials/widgets/:id/installs.json List sidene en widget ble sett aktiv på testimonial_widgets_installs

Opptil 50 sider, de nyeste først. Bare skriptet og rammen kan oppdages.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/widgets/:id/installs.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/testimonials/widgets/:id/restore.json Gjenopprett en widget fra papirkurven testimonial_widgets_restore

Den kommer tilbake overalt der den ble limt inn.

Tillatelse: content.write

Eksempel
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/widgets/:id/restore.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
GET /sites/:site_id/testimonials/widgets/:id.json Hent én widget med alle innstillinger, hva den viser og hvor den er aktiv testimonial_widgets_get

Alt byggeren lagrer: oppsettet og valgene, hva som mater widgeten (en samling, en lagret visning, etiketter eller en håndplukket liste), hva hvert kort viser, stilen, språket og anmeldelsesmarkeringen, med hvor den ble sett aktiv og hvor mange uttalelser den viser nå. En widget i papirkurven svarer med 404.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/testimonials/widgets/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/testimonials/widgets/:id.json Endre en widget testimonial_widgets_update

Bare inndataene som sendes endres. En lagret endring når hvert nettsted widgeten ligger på uten at koden deres røres, fordi de hurtigbufrede kopiene tømmes.

Tillatelse: content.write

Eksempel
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/widgets/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'

Ytelse

GET /sites/:site_id/performance.json Web Vitals: p75-resultattavle, daglig trend og nedbrytninger etter side, enhet, nettleser og land performance_report

Web Vitals-rapport fra ekte besøkende. Returnerer period, metric, sample_rate, scorecard, trend og breakdowns. scorecard har én rad for hver av LCP, INP, CLS, FCP og TTFB med p75 (75-persentilen, i millisekunder bortsett fra CLS, som er en enhetsløs score), samples, rating (good, needs_improvement eller poor, null uten data), good, needs_improvement og poor (prosent av utvalget), previous_p75, change (prosent mot den tidligere perioden, null når ukjent) og thresholds [grense for good, grense for poor]. trend er den daglige p75 for den valgte metrikken som {date, p75, samples}. breakdowns har page, device, browser og country, hver med opptil limit rader (standard 10, maks 100) for den valgte metrikken som {value, p75, samples, rating, slow_share, poor}, de verste og travleste først. Velg metric med nøyaktig én av LCP, INP, CLS, FCP eller TTFB med store bokstaver (standard LCP). sample_rate er andelen av besøk som rapporterer vitals, så antallene er utvalg og ikke alle besøk. Tar de felles inputene period, compare, filters og segment. For én sides vitals, bruk pages_detail.

Tillatelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/performance.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"