Dokumentation
Gennemse dokumentationen

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 operationer

Godkendelse

Send Authorization: Bearer pat_…. Opret tokens under Indstillinger for arbejdsområdet, API-tokens. Vejledning i godkendelse.

JSON overalt

Tilføj .json til enhver sti. Svar er { "data": … }, og fejl er { "error": { "code", "message" } }. Fejl.

MCP

Send JSON-RPC med POST til https://privatusanalytics.com/mcp med samme token. Hver operation nedenfor er et værktøj. MCP-vejledning.

Download openapi.json · 527 operationer

API-tokens

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

Opretter et API-token til det kaldende medlem i et arbejdsområde og returnerer hemmeligheden præcis én gang i feltet token. Kopiér den med det samme. Den kan ikke læses igen, og et mistet token skal tilbagekaldes og oprettes på ny. Et token kan kun indsnævre, hvad dets medlem må. permissions er som standard alle medlemmets egne rettigheder, hvis feltet udelades (en eksplicit tom liste afvises, og hvis du beder om en rettighed, du ikke har, giver det en fejl). site_ids tager offentlige websteds-id'er (pa_...) og begrænser tokenet til disse websteder. Hvis feltet er tomt, virker tokenet for alle websteder, medlemmet kan tilgå (eller beholder webstedslisten fra det token, der foretager dette kald). expires_at er valgfri ISO 8601 og skal ligge i fremtiden og højst 3 år ude, udelad den for et token, der aldrig udløber. allowed_ips begrænser tokenet til disse IP-adresser eller CIDR-områder. Et token, der foretager dette kald, skal have tokens.manage. Et arbejdsområde, der kræver tofaktorgodkendelse, afviser tokens til medlemmer uden en egen anden faktor. Returnerer de samme felter som api_tokens_list plus token.

Tilladelse: member · Kun HTTP (ikke et MCP-værktøj)

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 Tilbagekald et API-token api_tokens_delete

Tilbagekalder et API-token med det samme og permanent. Forespørgsler, der bruger det, fejler fra da af, og et tilbagekaldt token kan ikke genoprettes, opret et nyt i stedet. Tokenets post bliver i listen med status revoked (brug api_tokens_list med include_revoked for at se den), og hvis du tilbagekalder et allerede tilbagekaldt token, sker der ingenting. Tag id'et (et uuid) fra api_tokens_list. Du kan tilbagekalde dine egne tokens. For at tilbagekalde en andens kræves tokens.manage og adgang til alle de websteder, tokenet dækker. Et token, der kalder dette, skal have tokens.manage. Returnerer det tilbagekaldte token uden dets hemmelighed.

Tilladelse: member · Kun HTTP (ikke et MCP-værktøj)

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 Vis API-tokens api_tokens_list

Viser et arbejdsområdes API-tokens, nyeste først og med sideinddeling. Uden rettigheden tokens.manage ser du kun dine egne tokens, med den ser du alle medlemmers. Tilbagekaldte og udløbne tokens er skjult, medmindre include_revoked er true. Hvert element har id (uuid, bruges af api_tokens_delete), name, token_prefix (de første tegn, så man kan genkende et token), owner (medlemmets e-mail), permissions (navne som analytics.read), site_ids (offentlige websteds-id'er pa_..., et tomt array betyder alle websteder, ejeren kan tilgå), allowed_ips, oauth_client (den tilsluttede apps navn, når tokenet blev udstedt via OAuth, ellers null), status (active, expired eller revoked), expires_at, last_used_at, revoked_at og created_at. Selve hemmeligheden returneres aldrig her, token er altid null i en liste. Den vises kun én gang af api_tokens_create.

Tilladelse: member

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

Abonnementer

GET /plans.json Vis abonnementer, priser og grænser plans_list

Viser de offentlige abonnementer (free, pro, business og enterprise) med deres grænser og priser pr. niveau, så du kan vælge gyldige værdier til billing_checkout, billing_preview og billing_change_plan. Hvert abonnement har name, events (hændelser pr. måned inkluderet, null for abonnementer med niveauer eller tilpassede abonnementer), badge_bonus (ekstra månedlige hændelser fra badget, kun Free, ellers null), limits (et objekt med abonnementsgrænser som websteder, medlemspladser, historikopbevaring i måneder, mål pr. websted, AI-spørgsmål og API-forespørgsler pr. time), tiers (hver med hændelser pr. måned og den månedlige og årlige pris i hele USD, inklusive moms eller salgsafgift) og contact_sales (true for tilpassede abonnementer). Objektet meta tilføjer currency, en note om årlig prissætning, counted (hvad der tæller som en fakturerbar hændelse) og not_counted. Brug billing_get til ét arbejdsområdes eget abonnement. Offentligt, ingen godkendelse nødvendig.

Tilladelse: public

Eksempel
curl https://privatusanalytics.com/plans.json
DELETE /sites/:site_id/subscriptions/connections/:provider.json Afbryd en betalingsudbyder, og slet dens nøgle og abonnementsdata subscriptions_disconnect

Afbryder en betalingsudbyder (stripe, paddle, lemon_squeezy, chargebee eller polar) fra et websted og sletter permanent den gemte API-nøgle og alle abonnementsrækker, der er læst fra den. Det kan ikke fortrydes, og tal for MRR, frafald og kohorter mister med det samme den udbyders abonnementer. Fejler, hvis den udbyder ikke er forbundet. Returnerer den fjernede forbindelse. Kræver sites.manage.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 Læs abonnementer fra en betalingsudbyder nu subscriptions_sync

Sætter en øjeblikkelig synkronisering af abonnementer fra én forbundet udbyder (stripe, paddle, lemon_squeezy, chargebee eller polar) i kø i stedet for at vente på den almindelige tidsplan. Den returnerer med det samme (HTTP 202) med forbindelsen, og synkroniseringen kører i baggrunden. Hent subscriptions_report gentagne gange, eller tjek last_synced_at og last_error på forbindelsen. Rapporter caches i op til 15 minutter. Fejler, hvis udbyderen ikke er forbundet. Kræver sites.manage.

Tilladelse: 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 Kohortegitter: frafald eller fastholdelse efter måned for første betaling subscriptions_cohorts

Frafaldsgitteret over webstedets abonnementer, én række pr. måned for første betaling. months er 6, 12 (standard) eller 24 kohorter. plan beholder kun abonnementerne i ét abonnement (se plans i subscriptions_report). metric er subscriptions (antal) eller mrr (penge). view er churn (andelen, der var ophørt på det tidspunkt, standard) eller retention (andelen, der stadig kører). Returnerer metric, view, months, plan (filtret eller null), currency og cohorts, hver med month (YYYY-MM), size (abonnementer eller MRR i mindste enhed af webstedets valuta) og cells, hvor hver celle har offset (måneder siden kohortemåneden, 0 er den første), retained (samme enhed som size) og percent (0 til 100, null for en tom kohorte). Prøveperioder, der aldrig blev betalt, er ikke i nogen kohorte. Brug subscriptions_report til samlet MRR, ARR og frafald. Kræver analytics.read.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/subscriptions/cohorts.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/subscriptions.json Abonnementstal: MRR, ARR, MRR-bevægelser, frafald, indtægtsfastholdelse, prøveperioder, abonnementer og en prognose subscriptions_report

Abonnementsmålinger for webstedet, læst fra dets tilsluttede Stripe-, Paddle-, Lemon Squeezy-, Chargebee- eller Polar-konto. months er 6, 12 (standard) eller 24. plan beholder kun abonnementerne i ét abonnement, navngivet som plans viser det. Pengefelter er heltal i mindste enhed af webstedets valuta (svarets currency), hvor andre valutaer er omregnet til dagens kurs. Resultatet har currency, connected (false, når ingen udbyder er tilsluttet), plan (abonnementsfiltret eller null), connections (én pr. tilsluttet udbyder med provider, account_name, sandbox, status, last_error, last_synced_at og created_at, aldrig en nøgle), skipped_currencies (valutaer uden kurs, hvis penge ikke tælles med), totals, series, forecast og plans. totals har mrr_minor, arr_minor, previous_mrr_minor (MRR for 30 dage siden), active_subscriptions, arpa_minor (null uden abonnementer), trialing, trial_conversion_rate (procent af prøveperioder, der sluttede inden for de seneste 90 dage og blev betalt, null når ingen sluttede) og for de seneste 30 dage new_subscriptions, new_mrr_minor, expansion_mrr_minor, contraction_mrr_minor, churned_subscriptions, churned_mrr_minor, net_new_mrr_minor, quick_ratio (ny plus udvidet MRR for hver enhed af frafaldet plus indskrænket MRR, null når intet gik tabt), subscription_churn_rate og mrr_churn_rate (procent, null uden grundlag). Den har også net_revenue_retention og gross_revenue_retention (procent af det, abonnementerne, der betalte for 12 måneder siden, betalte dengang, som de betaler nu, med og uden opgraderinger, null uden grundlag) og forecast_mrr_minor (MRR om 12 måneder, null uden prognose). series har én række pr. måned (month som YYYY-MM) med mrr_minor, active_subscriptions, de samme bevægelsesfelter og churn_rate. forecast har én række pr. måned for de næste 12 måneder (month, mrr_minor), fremskrevet ud fra de seneste tre hele måneder, og er tom uden tre hele måneder, der startede med MRR. plans viser op til 50 abonnementer efter MRR med plan (null for abonnementer, som udbyderen ikke gav et abonnementsnavn), mrr_minor, active_subscriptions, churned_subscriptions og subscription_churn_rate (seneste 30 dage), altid for hvert abonnement. Et abonnement tæller fra dets første betaling. Opgraderinger og nedgraderinger kendes fra den første synkronisering, og før den bruger tidligere måneder den pris, et abonnement havde, da det første gang blev læst. Brug subscriptions_cohorts til fastholdelse efter måned for første betaling. Kræver analytics.read.

Tilladelse: analytics.read

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

Advarsler

POST /alerts/:id/acknowledge.json Kvittér for den seneste hændelse alerts_acknowledge

Markerer den seneste ukvitterede hændelse for en advarsel som set af den kaldende bruger. Den afslutter ikke hændelsen og slår ikke advarslen fra. Advarslen afsluttes af sig selv, når betingelsen ophører. Hvis advarslen ikke har nogen ukvitteret hændelse, fejler kaldet med en valideringsfejl. Returnerer advarslen. Brug alerts_history til at se hændelser med deres acknowledged_at og acknowledged_by. Kræver kun læseadgang til analyser, så seere kan kvittere.

Tilladelse: 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 Opret en advarsel alerts_create

Opretter en advarselsregel, der overvåger et websted (eller hele arbejdsområdet for kind usage) og giver besked i de valgte kanaler, når den udløses. Stien tager workspace_id. name og kind er påkrævede. kind afgør, hvad der ellers skal angives. threshold kræver site_id, metric (visitors, visits, pageviews, bounce_rate eller conversion), operator (gt, gte, lt eller lte) og threshold, og conversion kræver også goal_id. anomaly kræver site_id og metric (visitors, visits eller pageviews), sammenligner det seneste vindue med det samme vindue i hver af de forrige 4 uger og bruger sensitivity (low, medium eller high). operator lt advarer kun om fald, gt kun om stigninger, og tom advarer om begge dele. goal kræver site_id, goal_id og threshold (gennemførelser i vinduet). no_data kræver site_id og threshold i timer uden hændelser (standard 24). usage kræver intet websted og threshold som procent af den månedlige hændelseskvote (standard 80). uptime kræver site_id og eventuelt uptime_check_id (standard alle webstedets kontroller). ssl kræver site_id og threshold i dage, før et certifikat eller domæne udløber (standard 14). vitals kræver site_id, metric (lcp, inp, cls, fcp eller ttfb) og threshold i millisekunder (en score for cls). subscriptions kræver site_id, metric (mrr_drop: MRR faldt med mere end threshold procent de seneste 30 dage, churn_rate eller mrr_churn_rate: frafaldet over de seneste 30 dage ligger over threshold procent) og threshold (standard 10), og springes over, mens webstedet ikke har nogen betalingsudbyder forbundet eller intet at måle. window_minutes (standard 60, 5 til 10080) er, hvor langt tilbage hver evaluering ser. channel_ids kommer fra notification_channels_list, og sensitivity er som standard medium. Advarsler evalueres automatisk hvert 5. minut. Tærsklerne for bounce_rate og conversion er procenter fra 0 til 100. testimonials kræver site_id og metric, som siger, hvad den overvåger: new (en ny udtalelse kommer), low_rating (en vurdering på 3 eller lavere kommer), approved (en udtalelse godkendes), allowance (månedens kvote af nye udtalelser er 80 % brugt, opbrugt eller holder en udtalelse som ventende), sync_found (en synkronisering finder nye anmeldelser), import_failed (en import fejler, eller en kilde fejler tre synkroniseringer i træk), removal_requested (nogen beder om at få deres udtalelse fjernet) eller request_bounced (en anmodningsmail returneres). En testimonials-advarsel evalueres ikke hvert 5. minut: den udløses med det samme, hver gang det sker, registrerer en hændelse, der allerede er løst, og dens tilstand forbliver ok. Med metric allowance overvåger den hele arbejdsområdet og har intet websted. Returnerer den oprettede advarsel med state ok.

Tilladelse: 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 Slet en advarsel alerts_delete

Sletter en advarselsregel og hele dens hændelseshistorik permanent. Det kan ikke fortrydes, og notifikationer stopper med det samme. Hvis du vil sætte en advarsel på pause uden at miste historikken, brug alerts_update med enabled false eller alerts_mute. Id'et (alr_...) kommer fra alerts_list. Returnerer den slettede advarsel, som den var. Kræver skriveadgang til indhold.

Tilladelse: 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 Hændelseshistorik for en advarsel alerts_history

Viser hændelserne for én advarsel, nyeste først og med sideinddeling. Hver hændelse har triggered_at, resolved_at (null, mens den stadig er åben), value (det målte tal, da den udløstes, i samme enhed som advarslens tærskel), message (en læsbar beskrivelse), acknowledged_at og acknowledged_by (medlemmets visningsnavn eller null). Sæt open til true for kun at se uafsluttede hændelser. Brug alerts_acknowledge til at markere den seneste som set og alerts_get til regelens aktuelle tilstand.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/alerts/:id/history.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /workspaces/:workspace_id/alerts.json Vis advarsler alerts_list

Viser et arbejdsområdes advarselsregler (stien tager workspace_id), sorteret efter navn og med sideinddeling. Returnerer et data-array med advarsler samt meta med sideinddeling. Hver advarsel har id (alr_...), site_id (pa_..., null for usage-advarsler, som overvåger hele arbejdsområ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. Indsnævr med site_id, state (ok eller triggered) eller kind. Brug site_alerts_list til at vise advarslerne for ét websted fra en webstedssti, alerts_get til en enkelt advarsel og alerts_history til dens hændelser. En kalder, der er begrænset til nogle websteder, ser aldrig usage-advarsler.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/alerts.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /alerts/:id/mute.json Slå notifikationer fra (eller til) for en advarsel alerts_mute

Dæmper notifikationerne fra én advarsel i et antal minutter, mens den fortsat evalueres og registrerer hændelser i sin historik. minutes er som standard 60, maksimum er 43200 (30 dage), og 0 ophæver dæmpningen med det samme. Svaret er advarslen med muted_until sat til dæmpningens slutning (null, når den ikke er dæmpet). Brug alerts_update med enabled false for at stoppe evalueringen helt og alerts_acknowledge til at markere en hændelse som set uden at dæmpe.

Tilladelse: 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 en advarsel alerts_get

Returnerer én advarselsregel via id (alr_..., fra alerts_list eller site_alerts_list). Svaret er advarselsobjektet med id, site_id (null for usage-advarsler), 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 indeholder ikke hændelser, brug alerts_history til dem. threshold er et tal, hvis enhed afhænger af kind (se alerts_create). Kræver læseadgang til analyser.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/alerts/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /alerts/:id.json Opdatér en advarsel alerts_update

Ændrer en eksisterende advarselsregel (id fra alerts_list). Kun de felter, du sender, ændres, alt andet beholder sin værdi. De samme regler pr. kind som i alerts_create gælder for resultatet, så en ændring af kind eller metric kan kræve det tilhørende site_id, goal_id, operator eller threshold. Send channel_ids for at erstatte hele listen af notifikationskanaler og enabled false for at stoppe evalueringen uden at slette. Hvis du vil dæmpe notifikationer et stykke tid, men fortsat registrere hændelser, så brug alerts_mute i stedet. Returnerer den opdaterede advarsel.

Tilladelse: 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 Vis advarsler for et websted site_alerts_list

Viser advarselsreglerne for ét websted (stien tager site_id), sorteret efter navn og med sideinddeling. Den returnerer de samme advarselsobjekter og accepterer de samme filtre for state og kind som alerts_list, men kun for dette websted, så usage-advarsler (som ikke har noget websted) er ikke med. Vælg denne, når du allerede har et websteds-id, og alerts_list, når du vil have alle advarsler i arbejdsområdet. Hver advarsel 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.

Tilladelse: analytics.read

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

Affiliateprogram

GET /account/affiliate/commissions.json Vis dine affiliateprovisioner affiliate_commissions_list

Provisioner, modregninger ved refusion og chargeback samt tilbageførsler, nyeste først. Beløb er i cent.

Tilladelse: member

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

Indlejringskoden til din tilmeldingsboks (et script og en almindelig iframe) til det valgte tema, de attributter, der udfylder formularen på forhånd, de hændelser, scriptet udløser på din side, og boksens tal: tilmeldinger, der venter på bekræftelse, bekræftede tilmeldinger og betalende kunder. available er false, indtil din affiliateansøgning er godkendt.

Tilladelse: member

Eksempel
curl https://privatusanalytics.com/account/affiliate/signup-box.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /account/affiliate.json Hent din affiliatestatus, dit henvisningslink og statistik affiliate_get

Status for din affiliateansøgning, henvisningslink, tilmeldinger og betalende kunder, du har henvist, samt saldi pr. valuta (tilbageholdt, til udbetaling, udbetalt). status er none, når du ikke har ansøgt.

Tilladelse: member

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

Analyse

GET /sites/:site_id/clicks.json Klikkort: de mest klikkede elementer på webstedet, eller på én side med andelen af besøg, der klikkede på hvert element clicks_list

Klik pr. element fra tracker-modulet clicks. Et element er en kort CSS-selector (tag, id og op til to klasser, højst fire niveauer), eller [data-privatus-click="name"], hvis webstedet gav det et navn. Send path (starter med en skråstreg, som den er gemt) for én side: så er elements {selector, clicks, visits, visit_share}, og page_visits er antallet af besøg, der så siden, mens visit_share er den procentdel af dem (0 til 100), der klikkede på elementet. Uden path er elements {path, selector, clicks, visits} på tværs af webstedet. visits tæller de besøg, der klikkede mindst én gang. Returnerer period, path, page_visits og elements, de mest klikkede først. Der indsamles aldrig tekst fra elementer, koordinater eller musebevægelser. Brug pages_detail til resten af en side.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/clicks.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/overview.json Overblik over webstedet: målinger, diagramserier, topoversigter, live-besøgende og noter stats_overview

Ét kald, der returnerer alt det, webstedets oversigtsside viser: brug det til at besvare et bredt spørgsmål som fx hvordan et websted klarer sig, i stedet for at kalde flere værktøjer. Returnerer period, metrics (visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration, revenue), interval, series (én post pr. tidsinterval), panels, notes og live_visitors. Med compare tilføjes comparison_period, comparison, change og comparison_series, som i stats_aggregate og stats_timeseries. Enhederne svarer til disse værktøjer: bounce_rate er en procent fra 0 til 100, visit_duration er median engageret tid i millisekunder, revenue er et heltal i mindste enhed (cent). panels er et objekt med dimensionsnavnet som nøgle, hver med de 10 øverste rækker og deres andel, i samme rækkeform som stats_breakdown for den dimension. Som standard returnerer det channel, referrer, page, entry_page, country, device, browser, os, utm_campaign, event og goal. Send panels for at vælge andre dimensioner (alle dimensionsnavne undtagen prop-nøgler). notes viser annotationer i intervallet som {id, date, end_date, title, url, color}. live_visitors tæller besøgende inden for de seneste 5 minutter. Brug stats_breakdown til mere end 10 rækker af en dimension og stats_aggregate til ét tal. Tager de fælles inputs period, compare, filters og segment.

Tilladelse: 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 pr. variant, løft i forhold til kontrol og signifikans (z-test for to andele) experiments_report

Rapporterer en A/B-test ud fra hændelsesdata. Besøg tildeles den variant, der findes i en hændelsesegenskab (den første værdi set i besøget, fx egenskaben variant med værdierne control og b), og en konvertering er et besøg, der gennemførte et mål. Påkrævede inputs er property (nøgle med små bogstaver, op til 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 (procent, 0 til 100), control (true for grundlinjen), uplift (procentvis ændring af konverteringsraten i forhold til kontrolgruppen, null for kontrolgruppen eller når kontrolgruppens rate er 0), z, p_value og significant (true, når p_value er under 0.05, med en z-test for to andele). Kontrolgruppen er den variant, du angiver i control, ellers en med navnet control, ellers varianten med flest besøg. Højst 20 varianter, de travleste først. Sørg først for, at webstedet sender varianten som en hændelsesegenskab. Tager de fælles inputs period og filters. Brug goals_get til en almindelig konverteringsrate for et mål. Kræver Business- eller Enterprise-abonnementet (ellers 402 plan_limit).

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/experiments/external.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/insights.json Bemærkelsesværdige ændringer i forhold til den forrige periode, på almindeligt dansk (største bevægelser, ændringer i målkonvertering) insights_get

Notérbare ændringer for et websted i letforståeligt dansk, sammenlignet med den foregående periode af samme længde. Returnerer period, comparison_period og insights. Perioden dækker hele dage til og med i går og vælges med period (7d, 14d, 28d eller 30d, standard 7d). Hver indsigt har dimension (total, channel, page, country eller goal), metric, value, previous, current, change og sentence. change er en procent for antal og procentpoint for målets konverteringsrate, og sentence er en færdig sætning på engelsk. Den omfatter samlede besøgende og sidevisninger, de to største bevægelser pr. dimension (ændringer på 20 procent eller mere med mindst 10 besøg eller visninger) og mål, hvis konverteringsrate flyttede sig med et halvt point eller mere. Vigtigste først, begrænset af limit (standard 8, maks. 20). Resultater gemmes for dagen. Brug stats_aggregate og stats_breakdown til nøjagtige tal, og brug denne til at finde ud af, hvad der er ændret.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/insights.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/journeys.json Rejser: de 3-trins stier, der oftest følger efter en side (eller en vilkårlig indgang), eller som går forud for en side eller et mål journeys_explore

Udforsker de mest almindelige sidestier i tre trin inden for besøg. I fremadrettet tilstand (standard) viser den stierne efter en startside angivet i path eller efter en vilkårlig indgang, når path er tom. I omvendt tilstand viser den stierne, der fører til en slutside (path) eller et mål (goal_id, som automatisk skifter til omvendt). reverse kræver path eller goal_id. path skal begynde med en skråstreg. Returnerer period, mode, path, goal, sampled, sample_rate (procent), total_visits og stigrafen med nodes og links pr. trin, begrænset til limit sider pr. trin (2 til 12, standard 6). Over 100.000 besøg udtages der stikprøver af data. Sidefiltre ignoreres, fordi de ville afkorte stierne. Stierne bygges pr. besøg, da der ikke gemmes noget besøgende-id. Tager de fælles inputs period, filters og segment. Brug pages_detail til én sides naboer og funnels_get til konvertering pr. trin.

Tilladelse: 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 næste sider, kilder, Web Vitals, hændelser og klikkort for én sti pages_detail

Én side i dybden. Angiv path (skal begynde med en skråstreg, fx /pricing), præcis som den er gemt (uden query string og vært). 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 (procenter, 0 til 100), time_on_page (median i millisekunder) og scroll_depth (median i procent), hvor de to sidste er null uden engagementsdata. previous_pages og next_pages er siderne set før og efter i samme besøg, som {value, count, share}, med (entrance) og (exit) som specialværdier. sources har de bedste kanaler og henvisere for besøg, der begyndte på denne side. vitals har p75-værdier pr. Web Vital med vurderinger. events er brugerdefinerede hændelser udløst på siden, clicks er de mest klikkede elementvælgere, goals er mål gennemført på den, og notes er annotationer, der nævner den. Brug stats_breakdown med dimension page til at rangere sider og referrers_detail til et henvisende websted.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/pages/detail.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/referrers.json Henvisninger: de websteder, der linker til dette websted, med besøgende, engagement, trafiktype og antal linkende sider referrers_list

Rangerer de eksterne websteder, der sendte besøgende, med hvad hvert enkelt sendte. Direkte besøg (uden henviser) er udeladt. Returnerer period, summary, channels, page, limit, has_more og rows. summary har visitors, visits, pageviews, bounce_rate (procent), visit_duration (median engagerede millisekunder), revenue (mindste enhed, cent), sites (antal henvisende websteder) og share (procent af alle besøg, der kom fra henvisere). channels viser slagene af trafik som {value, visitors, visits}. Hver række har value (henviserens vært), visitors, visits, pageviews, bounce_rate, visit_duration, revenue, channel (dens sædvanlige kanal), linking_pages (hvor mange forskellige sider på det websted, der linker hertil) og share (procent af henviste besøgende). Sortér med sort (visitors, visits, pageviews eller revenue, standard visitors), indsnævr med search (tekst indeholdt i værten), og gå gennem siderne med page og limit (maks. 100), så længe has_more er true. Brug referrers_detail til ét websted. Tager de fælles inputs period, compare, filters og segment.

Tilladelse: 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øgletal og udvikling for ét henvisende websted, dets linkende sider, landingssider, lande, enheder, kampagner og konverteringer referrers_detail

Ét henvisende websted i dybden. Angiv referrer som værten uden www og uden sti (fx news.ycombinator.com), samme værdi som i referrers_list. Returnerer period, referrer, url, channel (dets mest almindelige kanal), metrics, share (procent af alle besøg), 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 bruger de samme felter og enheder som stats_aggregate og stats_timeseries. linking_pages er henviserens sider, der sendte besøgende, som rækker med path, url, visitors og share (query strings gemmes aldrig). landing_pages er, hvor disse besøgende kom ind. channels, countries, devices og campaigns er topværdier med metrics, og goals viser mål, de gennemførte, med conversions og conversion_rate. Brug referrers_list til at rangere henvisende websteder og stats_breakdown med dimension referrer til en enkel liste.

Tilladelse: 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

Hovedtal for én periode, som ét objekt. Returnerer period {from, to} og metrics {visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration, revenue}. Med compare returneres også comparison_period, comparison (de samme målinger for det andet interval) og change (procentvis ændring pr. måling, null når den tidligere værdi var 0). Enheder: bounce_rate er en procent fra 0 til 100 (10.9 betyder 10,9 %). visit_duration er et besøgs median engagerede tid i millisekunder. revenue er et heltal i mindste enhed (cent) i webstedets valuta. views_per_visit er et decimaltal. Besøgende tælles pr. dag, fordi der ikke gemmes noget vedvarende besøgende-id, så en, der kommer tilbage en anden dag, tælles igen. Brug denne til totaler og ændring fra periode til periode. Brug stats_timeseries til et diagram over tid, stats_breakdown til topværdier for en dimension og stats_overview til det hele i ét kald. Indsnævr dem alle med filters (se filters for dimensionsnavne og operatorer).

Tilladelse: 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 Topværdier for en dimension (sider, kilder, lande…) stats_breakdown

Topværdier for én dimension med deres målinger, vigtigste først og med sideinddeling. Dimensionen er den sidste del af stien og skal være et nøjagtigt navn fra dens beskrivelse (fx country, page, channel, utm_campaign, prop:plan). Returnerer period, dimension, label, page, limit, has_more og rows. Bed om næste side, så længe has_more er true. Hver række har value og share (procent af periodens total). De øvrige felter i en række afhænger af dimensionen. Besøgsdimensioner (channel, referrer, referrer_url, utm_*, ref, hostname, country, language, device, browser, browser_version, os, os_version, screen, entry_page, exit_page, interaction, bot_score) giver visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration og revenue. page giver pageviews, visits, time_on_page (millisekunder) og scroll_depth (procent), uden visitors. event og prop:<key> giver completions, visits, revenue og conversion_rate. goal giver goal_id, completions, conversions, conversion_rate og revenue. Enheder: bounce_rate og conversion_rate er procenter (0 til 100), varigheder er millisekunder, revenue er i mindste enhed (cent). En forkert dimension giver en 422, der viser de gyldige navne. Brug search til at lede efter en værdi på tværs af alle rækker og filters til først at indsnævre data (fx sider besøgt fra ét land). Brug pages_detail eller referrers_detail til én side eller én henviser i dybden. Dimensionerne interaction og bot_score kræver Business- eller Enterprise-abonnementet: som opdeling svarer de med 402 plan_limit på andre abonnementer, og et filter på en af dem udelades.

Tilladelse: 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 pr. tidsinterval til diagrammer stats_timeseries

Målinger pr. tidsinterval, til diagrammer og tendenser. Returnerer period, interval (det faktisk brugte interval) og series, en liste af {date, visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration, revenue}, én post pr. interval, hvor date er intervallets start i ISO 8601. Med compare returneres også comparison_series for det andet interval, interval for interval. Enhederne er de samme som i stats_aggregate: bounce_rate er en procent (0 til 100), visit_duration er median engagerede millisekunder, revenue er i mindste enhed (cent). interval er som standard auto, som vælger minut, time, dag, uge eller måned, så det passer til tidsrummet. Sæt det for at gennemtvinge en intervalstørrelse. Brug stats_aggregate til en enkelt total og stats_breakdown til at opdele efter en dimension som country eller page.

Tilladelse: analytics.read

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

Analyse af udtalelser

GET /sites/:site_id/testimonials/analytics/breakdown.json Opdel ét mål for udtalelser efter formular, anmodning, widget, væg, udtalelse, kanal, side, land eller kilde testimonial_stats_breakdown

Returnerer rækker, største først, hver med key, label, value og share (en procent af totalen), eller numerator og denominator for en rate. En række for en post (formular, anmodning, widget, væg, udtalelse) bærer dens id. Hver dimension tager kun nogle mål: form og channel tager formularmålene, request anmodningsmålene, widget og wall deres egne views, clicks, click rate og video_plays, testimonial tager testimonial_views og video_plays, page og country tager visnings- og klikmålene, og source tager new_testimonials. Et par, der ikke passer, responderer med 422 og nævner de mål, der passer.

Tilladelse: 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 Stil en fil med ét afsnit af udtalelsesanalysen i kø testimonial_stats_export

Opretter en eksport af arten testimonial_stats for den angivne periode og returnerer den i kø. Poll exports_get, indtil status er complete, og brug derefter exports_download. section vælger rækkerne: days (én række pr. dag, uge eller måned med hvert mål), forms, channels, requests, widgets, walls, pages, testimonials, sources eller countries. Filen gemmes i 7 dage. Responderer med 422 in_progress, når for mange eksporter allerede er i kø.

Tilladelse: 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 Læs et steds analyse af udtalelser i ét kald testimonial_stats_overview

Returnerer alt, hvad fanen Analyse under Udtalelser 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 sat), chart (ét mål over tid), en række pr. formular, anmodning, widget og væg, channels (hvordan formularer blev åbnet), pages (hvor widgets og vægge blev set), top_testimonials, new_testimonials (efter kilde og efter nuværende status) og countries. Rater er procenter fra 0 til 100 og er null, når der intet er at dividere med. blank er true, så længe stedet aldrig har talt noget, og recorded lister de mål, det nogensinde har talt. Det er daglige totaler for udtalelsesfunktionen, ikke webanalyse: brug stats_overview til besøgende og sidevisninger.

Tilladelse: 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 Læs ét mål for udtalelser pr. dag, uge eller måned testimonial_stats_timeseries

Returnerer punkter med date, to, value og, når compare er sat, previous og previous_date, plus total, previous_total og change. En rate (completion_rate, answer_rate, widget_click_rate, wall_click_rate) udregnes ud fra totalerne i hver spand og er null for en spand uden noget at dividere med. new_testimonials tælles ud fra selve udtalelserne efter den dag, hver blev tilføjet.

Tilladelse: analytics.read

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

Anmodninger om eget domæne til udtalelser

POST /sites/:site_id/testimonials/settings/custom_domain.json Bed om et eget domæne til en væg eller formularer testimonial_custom_domain_requests_create

Egne domæner til udtalelser opsættes af Privatus Analytics-teamet i hånden. Dette gemmer anmodningen og giver teamet besked, som sender den DNS-post, der skal tilføjes, på e-mail. Værtsnavnet virker ikke, før anmodningens status er active. Business og op: andre planer får 402 plan_limit.

Tilladelse: 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 Træk en anmodning om eget domæne tilbage ud fra dens værtsnavn testimonial_custom_domain_requests_delete

Kun en anmodning, teamet ikke er gået i gang med (status requested), kan trækkes tilbage. En, der er i gang, responderer med wrong_state. Over MCP ændrer værktøjet intet og responderer med den side i appen, hvor en person gør det.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 et steds anmodninger om eget domæne testimonial_custom_domain_requests_list

Hver anmodning om et værtsnavn på en væg eller på formularer, nyeste først, med dens status. Værtsnavnet virker først, når status er active. Virker på enhver plan, så tidligere anmodninger stadig kan læses.

Tilladelse: analytics.read

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

Anmodninger om fjernelse

POST /sites/:site_id/testimonials/removal_requests/:id/dismiss.json Afvis en anmodning om fjernelse testimonial_removal_requests_dismiss

Lukker anmodningen med en note og lader udtalelsen blive, hvor den vises. Intet slettes, og der sendes ingen e-mail til den, der bad om det. Noten er påkrævet. En anmodning, der allerede er afgjort, responderer med 422.

Tilladelse: 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 et steds anmodninger om fjernelse testimonial_removal_requests_list

Åbne anmodninger, medmindre en anden status bedes om. Den e-mail, giveren skrev, returneres kun til en kaldende, der må ændre indhold.

Tilladelse: 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 Afgør en anmodning om fjernelse testimonial_removal_requests_resolve

trash flytter udtalelsen til papirkurven, hvilket tager den af hver widget, væg og offentlig side på én gang og kan fortrydes i 30 dage. dismiss lader den blive vist og kræver en note.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 anmodning om fjernelse testimonial_removal_requests_get

Én anmodning med den udtalelse, den handler om, den note, personen efterlod, om den e-mail, de skrev, matcher e-mailen på udtalelsen, hvor mange gange de bad om det, og afgørelsen, når der er en. Selve e-mailen returneres kun til en kaldende med content.write.

Tilladelse: analytics.read

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

Anmodninger om udtalelser

POST /requests/resubscribe/:token.json Bekræft at modtage anmodninger om udtalelser igen testimonial_request_resubscribes_confirm

POST'en bag knappen på bekræftelsessiden. Den ophæver fravalget, så adressen kan spørges igen.

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/requests/resubscribe/:token.json \
  -H "Content-Type: application/json" -d '{…}'
POST /requests/resubscribe.json Bed om den e-mail, der lader en adresse modtage anmodninger igen testimonial_request_resubscribes_create

Sender en bekræftelsesmail til selve adressen, når den havde afmeldt sig. Svaret er det samme, uanset om den havde eller ej.

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/requests/resubscribe.json \
  -H "Content-Type: application/json" -d '{…}'
POST /requests/unsubscribe/:token.json Afmeld en adresse fra anmodninger om udtalelser testimonial_request_unsubscribes_create

POST'en bag knappen på afmeldingssiden og det, en mailapps egen afmeldingsknap kalder. Tokenet kommer fra linket i e-mailen.

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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 anmodning som kladde testimonial_requests_create

Opretter en kladde med dens e-mail og dens modtagere. Intet sendes før testimonial_requests_send. Alt, der udelades, starter fra en standard: e-mailen, én opfølgning efter 5 dage, stedets navn som afsender og dig som svaradresse. Hver modtager gemmes som queued eller som skipped med årsagen.

Tilladelse: 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 Slet en kladde testimonial_requests_delete

Kun en anmodning, der aldrig blev sendt, kan slettes. En sendt anmodning gemmes som optegnelsen over den post, der blev sendt. Over MCP ændrer værktøjet intet og responderer med den side i appen, hvor en person gør det.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Kopiér en anmodning til en ny kladde testimonial_requests_duplicate

Kopien har samme formular og e-mail og endnu ingen modtagere.

Tilladelse: 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 et steds anmodninger testimonial_requests_list

Nyeste først, hver med sin e-mail og sine tal for tragten. Filtrér efter status, formular eller periode.

Tilladelse: 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-mail fra en anmodning, som dens første modtager får den testimonial_requests_preview

Afsenderen, emnet og brødteksten med flettefelterne udfyldt. Intet sendes. step 0 er den første e-mail, 1 til 3 opfølgningerne.

Tilladelse: 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 Genoptag en stoppet anmodning testimonial_requests_resume

Fortsætter, hvor den stoppede. En opfølgning, der forfaldt, mens den var stoppet, tidsindstilles igen fra nu, så intet går ud i en bunke. Dette sender e-mails til personer uden for arbejdsområdet, så medlemmet får en e-mail om, at en assistent genoptog den.

Tilladelse: 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 anmodning, nu eller på et tidspunkt testimonial_requests_send

Kræver confirm_relationship: true. De modtagere, der står i kø, kontrolleres endnu en gang, og derefter går de første e-mails ud (eller venter på send_at). Opfølgninger går til de personer, der ikke har svaret. E-mails med anmodninger sendes gennem stedets egen e-mailudbyder (Indstillinger > E-mailafsendelse, Business og op), så et sted uden en fungerende forbindelse får 422 no_email_connection eller email_connection_paused, og en anden plan får 402 plan_limit. Hver e-mail tæller med i stedets månedlige loft for e-mails med anmodninger (10.000, medmindre vi angiver et andet). Ved loftet droppes intet: personerne bliver i kø, og afsendelsen fortsætter den 1. Dette sender e-mails til personer uden for arbejdsområdet, så medlemmet får en e-mail om, at en assistent sendte den.

Tilladelse: 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-mail fra en anmodning til din egen adresse testimonial_requests_send_test

Går kun til den kaldendes egen adresse gennem stedets egen e-mailudbyder ligesom de rigtige (422 no_email_connection uden en). Den har intet personligt link og ingen åbningstæller og tæller ikke med i stedets månedlige loft.

Tilladelse: 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 anmodning med dens e-mail, opfølgninger og tal for tragten testimonial_requests_get

Returnerer e-mailen, opfølgningerne, status og tallene for tragten (sent, opened, clicked, submitted, bounced, unsubscribed) for én anmodning.

Tilladelse: 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 Stop en anmodning testimonial_requests_stop

Annullerer hver e-mail, der endnu ikke er sendt, med det samme. Intet, der allerede er sendt, berøres, og testimonial_requests_resume fortsætter, hvor den stoppede.

Tilladelse: 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 Ændr en anmodnings navn, formular eller e-mail testimonial_requests_update

Tilladt til enhver tid. En ændring gælder hver e-mail, der endnu ikke er sendt. At ændre en opfølgnings forsinkelse tidsindstiller de ventende opfølgninger igen.

Tilladelse: 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 '{…}'

Annoncekreativer

POST /sites/:site_id/experiments/ads/:ad_placement_id/creatives.json Tilføj en kreativ til en annonceplacering ad_creatives_create

Tilføjer et billede i placeringens form (mindst dens størrelse, det dobbelte ser skarpest ud) og den adresse, et klik fører til. Send billedet som en multipart-fil, eller image_url for at få det hentet. Det behandles i baggrunden, så kald ad_creatives_get, indtil state er ready. En tidsplan, enheder og stier er Pro og derover. Kræver content.write.

Tilladelse: 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 Slet en kreativ og dens billede ad_creatives_delete

Sletter permanent en kreativ og dens billede. En, som et eksperiment sammenligner, kan ikke slettes: slå den fra i stedet. MCP-værktøjet kører det ikke og svarer med human_only og den side, hvor en person sletter den. Kræver content.write.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 én kreativ med dens tilstand ad_creatives_get

En kreativ er processing, indtil dens billede er lavet, derefter ready (eller failed, med årsagen i error). Kræver analytics.read.

Tilladelse: 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 Ændr en kreativ ad_creatives_update

Ændrer linket, vægten, tidsplanen eller målretningen, slår den fra (active false) eller erstatter billedet. Kun de angivne input ændres. Et nyt billede erstatter det gamle, når det er klar. Kræver content.write.

Tilladelse: 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 '{…}'

Annonceplaceringer

POST /sites/:site_id/experiments/ads.json Opret en annonceplacering ad_placements_create

Opretter en plads i én størrelse på webstedet. Send size (en almindelig størrelse som medium_rectangle eller leaderboard) eller width og height i pixel. key er det, tagget på webstedet navngiver den med, og laves ud fra navnet, hvis det udelades. Tilføj derefter kreativer med ad_creatives_create og sæt tagget fra ad_placements_embed på webstedet. Kræver content.write.

Tilladelse: 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 Slet en annonceplacering med dens kreativer ad_placements_delete

Sletter permanent en placering med dens kreativer og deres billeder, dens annonceeksperimenter og deres resultater samt dens sponsorlinks. Tagget på webstedet tegner så ingenting. MCP-værktøjet kører det ikke og svarer med human_only og den side, hvor en person sletter den. Kræver content.write.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 det tag, der viser en placering på webstedet ad_placements_embed

Loader-scriptet (én gang pr. side) og pladsen til denne placering som html til indsættelse. Pladsen beholder sin størrelse, før loaderen kører. Kræver analytics.read.

Tilladelse: 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 websteds annonceplaceringer med de seneste 30 dage ad_placements_list

Hver placering med sin nøgle, størrelse, antal kreativer og statistik (visninger, synlige visninger, klik og ctr, klikraten pr. synlig visning) for de seneste 30 dage. Kræver analytics.read.

Tilladelse: 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 placering med hver kreativs tal ad_placements_get

Placeringen, dens kreativer med deres statistik for perioden (7d, 30d eller 90d) og placeringens tal dag for dag. humans_only beholder det, som botscoren kalder sandsynlige mennesker (Pro og derover). Kræver analytics.read.

Tilladelse: 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 Ændr en annonceplacering ad_placements_update

Ændrer navn, nøgle, størrelse eller label. Kun de angivne input ændres. En ny nøgle kræver det nye tag på webstedet. Kræver content.write.

Tilladelse: 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 '{…}'

Arbejdsområder

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

Returnerer arbejdsområdets white label-branding. Felterne er workspace_id (ws_...), brand_name, brand_logo_url og brand_color (en hex-farve som #06755b), hver null, når den ikke er sat, hide_branding, available (true, når abonnementet inkluderer white label, hvilket er Business og derover) og active (true, når branding er sat og i kraft). Brandingen erstatter Privatus Analytics på delte dashboards, indlejringer, statussider og e-mailrapporter. Kræver workspace.manage.

Tilladelse: 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 Angiv white label-brandet for delte dashboards og e-mailrapporter (Business) white_label_update

Sætter arbejdsområdets white label-branding. Kun Business-abonnement, ellers fejler den med en abonnementsfejl. Kun de inputs, du sender, ændres, og en tom streng rydder brand_name, brand_logo_url eller brand_color. brand_logo_url skal være en https-URL til et billede og brand_color en hex-farve som #06755b. hide_branding true fjerner Privatus Analytics-linket fra delte dashboards, indlejringer og statussider og logoet fra e-mailrapporter. Ændringen gælder med det samme for eksisterende delingslinks. Kræver workspace.manage. Returnerer brandingen (se white_label_get).

Tilladelse: 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 sikkerhedsindstillinger for arbejdsområdet workspace_security_get

Returnerer arbejdsområdets sikkerhedspolitik. Felterne er workspace_id (ws_...), enforce_2fa (medlemmer skal bruge tofaktorgodkendelse), login_methods (de tilladte blandt password, magic_link, passkey, google, github og sso), session_ttl_hours (log ud efter så mange timer, null for ingen grænse), app_ip_allowlist (IP-adresser eller CIDR-områder med tilladelse til at bruge appen og API'et, tom betyder overalt fra) og support_access_until (ISO 8601-tidspunkt, indtil hvilket Privatus Analytics-support må se arbejdsområdet, null når der ikke er givet adgang). Kræver workspace.manage.

Tilladelse: workspace.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/security.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/security.json Opdatér sikkerhedsindstillinger for arbejdsområdet (2FA, loginmetoder, sessionslevetid, IP-tilladelsesliste, supportadgang) workspace_security_update

Ændrer arbejdsområdets sikkerhedspolitik, kun de inputs, du sender. enforce_2fa true kræver, at alle medlemmer bruger tofaktorgodkendelse, og kræver Business-abonnementet. login_methods erstatter den tilladte liste med værdier fra password, magic_link, passkey, google, github og sso, og hvis du fjerner en metode, logges medlemmernes huskede logins ud, så de skal logge ind igen. session_ttl_hours logger medlemmer ud efter så mange timer (0 fjerner grænsen). app_ip_allowlist erstatter listen over IP-adresser eller CIDR-områder, der må nå appen og API'et (Business-abonnement, en tom liste betyder overalt fra), og afvises, hvis den ville udelukke kalderens IP, så du ikke kan låse dig selv ude. support_access true lader Privatus Analytics-support se arbejdsområdet i 7 dage, og false trækker den adgang tilbage. Kræver workspace.manage. Returnerer politikken (se workspace_security_get).

Tilladelse: workspace.manage · Kun HTTP (ikke et MCP-værktøj)

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 Opret et arbejdsområde (du bliver ejer) workspaces_create

Tilladelse: member · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/workspaces.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN" \
  -H "Content-Type: application/json" -d '{…}'
DELETE /workspaces/:id.json Slet et arbejdsområde og alle dets websteder (kun ejeren, opsiger ethvert abonnement) workspaces_delete

Sletter et arbejdsområde sammen med alle dets websteder. Det er en blød sletning, alt forsvinder med det samme og slettes permanent efter 7 dage, så betragt det som uigenkaldeligt. Kun ejeren kan gøre det, og confirm skal være arbejdsområdets nøjagtige navn (skelner mellem store og små bogstaver). Et aktivt betalt abonnement opsiges først med det samme, og hvis den opsigelse fejler, slettes intet. Afventende webstedsoverførsler fra arbejdsområdet annulleres. Medlemmer mister adgangen. Brug workspaces_get til at læse navnet. Kræver workspace.manage og rollen owner. Returnerer arbejdsområdet.

Tilladelse: workspace.manage · Kun HTTP (ikke et MCP-værktøj)

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

Viser de arbejdsområder, kalderen tilhører, sorteret efter navn. Et API-token eller en MCP-forbindelse ser kun det ene arbejdsområde, det blev udstedt til. Hvert element har id (ws_..., bruges som workspace_id af de fleste værktøjer), name, timezone, currency, plan, plan_events, subscription_status og role (kalderens rolle). Kald derefter sites_list med et arbejdsområde-id for at finde websteds-id'er. Oprettelse af et arbejdsområde er kun mulig i appen.

Tilladelse: member

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

Returnerer ét arbejdsområde via dets offentlige id (ws_..., fra workspaces_list). Felterne er id, name, timezone (IANA-navn), currency (ISO 4217), plan (free, pro, business eller enterprise), plan_events (abonnementets månedlige hændelseskvote), subscription_status (none, trialing, active, past_due, paused eller canceled), role (kalderens rolle i det) og created_at. Brug billing_get til de fulde faktureringsdetaljer og billing_usage til denne måneds forbrug. Ethvert medlem kan læse det.

Tilladelse: member

Eksempel
curl https://privatusanalytics.com/workspaces/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:id.json Opdatér indstillinger for arbejdsområdet workspaces_update

Ændrer et arbejdsområdes navn, standardtidszone eller standardvaluta, kun de inputs, du sender. timezone er et IANA-navn som Europe/Berlin, og currency er en ISO 4217-kode på 3 bogstaver. Det er standardværdier for nye websteder, de ændrer ikke eksisterende websteder (brug sites_update til dem). Kræver workspace.manage. Returnerer arbejdsområdet (se workspaces_get).

Tilladelse: 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 Stil et spørgsmål i en ny samtale (tæller med i den månedlige grænse for AI-spørgsmål) assistant_ask

Starter en ny Ask-samtale på ét websted og besvarer det første spørgsmål ud fra webstedets analyser. Brug den til et spørgsmål i almindeligt sprog om et websted. Brug assistant_ask_followup til at fortsætte en eksisterende samtale og statistikværktøjerne, når du allerede kender den nøjagtige forespørgsel. Svaret skabes af en AI-model, der selv kører skrivebeskyttede analyseforespørgsler, så kaldet kan tage mange sekunder. Det tæller som ét AI-spørgsmål af arbejdsområdets månedlige kvote (5 på Free, 20 på Pro, 100 på Business) og fejler med en grænsefejl, når kvoten er brugt op. Spørgsmålet kan højst være på 2.000 tegn. Samtaler er private for det medlem, der startede dem, og slettes 30 dage efter deres sidste besked. Returnerer samtalen (id, site_id, title taget fra spørgsmålet, created_at, updated_at, expires_at) med et messages-array. Hver besked har role (user eller assistant), content (svarteksten), queries (de nøjagtige analyseforespørgsler, assistenten kørte), chart (diagramdefinition, kan være null), goal_draft (foreslået mål, kan være null), tokenantal og created_at. Hvis svaret fejler, fjernes samtalen, og intet spørgsmål tælles. Kræver analytics.read.

Tilladelse: 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 Slet en Spørg-samtale og dens beskeder assistant_conversations_delete

Sletter én Ask-samtale og alle dens beskeder permanent med det samme. Det kan ikke fortrydes. Hent samtalens id fra assistant_conversations_list. Kun det medlem, der startede en samtale, kan se og slette den. Kræver analytics.read og et site_id. Returnerer den slettede samtales oversigt (id, site_id, title, tidsstempler). Den refunderer ikke de AI-spørgsmål, der allerede er talt med for måneden.

Tilladelse: 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 Vis dine Spørg-samtaler for et websted assistant_conversations_list

Viser det loggede medlems Ask-samtaler på ét websted, senest opdaterede først. Andre medlemmers samtaler vises aldrig. Brug den til at finde et samtale-id til assistant_conversations_get, assistant_ask_followup eller assistant_conversations_delete. Hvert element har id, site_id, title (det første spørgsmål, afkortet til 80 tegn), created_at, updated_at og expires_at, men ingen beskeder. Med sideinddeling via page og per_page (maksimum 100). Kræver analytics.read.

Tilladelse: 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ørg-samtale: spørgsmål, svar, forespørgslerne bag dem og diagrammer assistant_conversations_get

Returnerer én Ask-samtale med hele beskedhistorikken. Hent samtalens id fra assistant_conversations_list eller fra resultatet af assistant_ask. Felterne er id, site_id, title, created_at, updated_at, expires_at (30 dage efter den sidste besked, derefter slettes samtalen) og messages. Hver besked har role (user eller assistant), content, queries (de analyseforespørgsler, assistenten kørte), chart (kan være null), goal_draft (kan være null) samt input_tokens og output_tokens (heltal, kan være null). Kun det medlem, der startede samtalen, kan læse den. Kræver analytics.read.

Tilladelse: 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 Stil et opfølgende spørgsmål i en samtale (tæller med i den månedlige grænse for AI-spørgsmål). Returnerer svaret. assistant_ask_followup

Stiller et opfølgende spørgsmål i en eksisterende Ask-samtale, så assistenten beholder de tidligere spørgsmål og svar som kontekst. Brug assistant_ask til i stedet at starte en ny samtale. Hent conversation_id fra assistant_conversations_list. Kaldet kan tage mange sekunder, fordi assistenten kører skrivebeskyttede analyseforespørgsler. Hvert spørgsmål tæller med i arbejdsområdets månedlige kvote af AI-spørgsmål (5 på Free, 20 på Pro, 100 på Business) og fejler med en grænsefejl, når den er brugt op. Spørgsmålet kan højst være på 2.000 tegn. Returnerer kun den nye assistentbesked (ikke hele samtalen) med id, role, content (svaret), queries (de nøjagtige forespørgsler, der blev kørt), chart (kan være null), goal_draft (kan være null), input_tokens, output_tokens og created_at. Kræver analytics.read og virker kun på dine egne samtaler.

Tilladelse: 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 Kopiér en formulars belønning til andre formularer på samme sted testimonial_rewards_copy

Kopierer titlen, teksten, koden og til- eller fra-tilstanden for denne formulars belønning til hver formular i form_ids (1 til 100 formularer på samme sted, ikke i papirkurven). En belønning, målformularen allerede har, erstattes. Serveren responderer med 422 og koden unknown_ids, når et id ikke er en formular på stedet, og så kopieres intet.

Tilladelse: 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 hver formular på et sted testimonial_rewards_list

Én række pr. formular. En formular uden angivet belønning har enabled false.

Tilladelse: 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 Angiv den belønning, en formular viser på sit takketrin testimonial_rewards_update

Id'et er formularens id. Koden er tekst, du selv angiver. Privatus Analytics opretter, kontrollerer eller udløber den ikke.

Tilladelse: 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 '{…}'

Billeder af udtalelser

POST /sites/:site_id/testimonials/images/bulk.json Lav billeder af hver godkendt udtalelse i en samling testimonial_images_bulk_create

Op til 200 udtalelser pr. kørsel, ét billede pr. størrelse for hver. En tekst, der er for lang til billedet, tegnes ud fra sin fremhævelse eller ellers ud fra sine første sætninger (excerpted fortæller hvor mange). Svaret lister de startede billeder, de udeladte udtalelser med årsagen og export_id: én zip med PNG-filerne vises på Eksporter-siden, når de er tegnet.

Tilladelse: 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 Lav billeder af én godkendt udtalelse, ét pr. størrelse testimonial_images_create

Kun en godkendt udtalelse kan tegnes, fordi PNG-filen får en offentlig adresse: enhver anden afvises med not_approved. Hvert billede starter som rendering og tegnes i baggrunden. Svaret er listen over startede billeder. Poll testimonial_images_get for file_url. En 422 med text_too_long betyder, at ordene ikke kan være der: brug text_mode highlight eller excerpt, eller en højere størrelse.

Tilladelse: 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 Slet et billede og dets fil testimonial_images_delete

PNG-filen slettes fra medie-værten, og dens adresse holder op med at virke. Et billede har ingen papirkurv. Det kan laves igen ud fra sin udtalelse med testimonial_images_create. Over MCP ændrer værktøjet intet og responderer med den side i appen, hvor en person gør det.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 et steds billeder testimonial_images_list

Billeder lavet af godkendte udtalelser, nyeste først, 25 pr. side. Filtrér efter status, template, size eller testimonial_id. Hver bærer file_url, når den er klar.

Tilladelse: 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 ét billede med dets tilstand og adressen på dets PNG testimonial_images_get

status er rendering, ready eller failed. file_url er sat, når den er klar. Poll dette efter testimonial_images_create, indtil status ikke længere er rendering.

Tilladelse: 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 Ændr, hvordan et billede tegnes, og gengiv det igen testimonial_images_update

Send kun det, der ændres. Uden noget sendt gengiver den det samme billede igen fra udtalelsen, som den er nu, hvilket også er måden at prøve et mislykket igen. En ny gengivelse har en ny file_url, og den gamle fil slettes.

Tilladelse: 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 '{…}'

Bot-detektion

GET /sites/:site_id/bot-detection.json Rapport om avanceret bot-detektion: hits på webstedets honeypot-sider, pr. side og efter hvad der afslørede botten bot_detection_report

Rapporterer hits på webstedets honeypot-sider. En honeypot-side er en side, der kun nås via et skjult link, og som er sat op som siden for avanceret bot-detektion i appen. Disse hits er bots, så de er aldrig sidevisninger eller besøg og vises ikke i stats_overview eller stats_breakdown. Vælg tidsrummet med period (7d, 30d (standard), 90d eller 12mo). Hits gemmes i 12 måneder. Resultatet har period, from (tidsrummets start), has_data (false, indtil det første hit), totals (hits, forskellige sider, automated (hits, hvor trackeren så en automatiseret browser) og no_interaction (hits uden input fra mus, tastatur eller berøring)), pages (op til 50 rækker med path, hits og last_hit_at), reasons (hits pr. resultat af det almindelige botfilter: known_bot, automation, datacenter, empty_user_agent, referrer_spam eller undetected for et hit, filteret ville have talt som en person) og recent (de seneste 50 hits med occurred_at, path, country, browser, device, bot_reason, automation og interacted). Der gemmes ingen IP-adresse eller User-Agent sammen med et hit, kun nøglede hashes af dem, som ikke kan identificere nogen, og de returneres aldrig. Kræver analytics.read og Business- eller Enterprise-abonnementet (ellers 402 plan_limit).

Tilladelse: analytics.read

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

Brandkit til udtalelser

DELETE /sites/:site_id/testimonials/settings/brand_kit.json Sæt brandkittet til et steds udtalelser tilbage til standarderne fra Privatus Analytics testimonial_brand_kit_reset

Rydder hver farve, skrifttype, radius, vurderingsstil, logoerne og den brugerdefinerede CSS i ét trin, og hver formular, widget og væg ændres med det. Det kan ikke fortrydes, så en assistent sendes til Brandkit-siden i stedet for at køre det.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 brandkittet til et steds udtalelser med hver farve løst for lys og mørk testimonial_brand_kit_get

Returnerer farver, skrifttyper, hjørneradius, vurderingsstil, logoer, badge-kontakt og brugerdefineret CSS, som hver formular, widget og væg på stedet tegnes med. En indstilling, der aldrig er ændret, kommer tilbage med standarden fra Privatus Analytics.

Tilladelse: 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 Ændr brandkittet til et steds udtalelser testimonial_brand_kit_update

Kun de inputs, du sender, ændres. Send en tom streng for at sætte én indstilling tilbage til standarden fra Privatus Analytics. Brugerdefineret CSS kontrolleres, når den gemmes, og alt, der ikke er tilladt, afvises med den linje, det står på. Brugerdefineret CSS kræver Business-planen, og at skjule badgen kræver Business-planen. Uden den responderer serveren med 402 plan_limit.

Tilladelse: 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 '{…}'

Brugerdefinerede egenskaber for udtalelser

POST /sites/:site_id/testimonials/settings/properties.json Tilføj en brugerdefineret egenskab til et sted testimonial_properties_create

Et sted rummer op til 20 aktive egenskaber. Nøglen er fast, når den er lavet, fordi formularlinks, regler og API'et bruger den. Udelad den, og den foreslås ud fra etiketten.

Tilladelse: 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 Slet en brugerdefineret egenskab og dens værdier for altid testimonial_properties_destroy

Dette kan ikke fortrydes. Det fjerner egenskaben og dens værdi fra hver udtalelse. confirm er nøglen. En egenskab, der bruges af en smart samling eller en regel for automatisk tagging, kan ikke slettes, mens de bruger den. Arkivering er den daglige måde at pensionere en på.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 et steds brugerdefinerede egenskaber i visningsrækkefølge testimonial_properties_list

Hver fortæller sin nøgle, type og valgmuligheder, hvor mange udtalelser der har en værdi (filled), om dens type stadig kan ændres, og hvilke smarte samlinger og regler for automatisk tagging der bruger den.

Tilladelse: 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 Ændr, omarranger, arkivér eller genindfør en brugerdefineret egenskab testimonial_properties_update

Kun de inputs, du sender, ændrer noget. At omdøbe en valgmulighed omdøber den på hver udtalelse, der har den. En egenskab, der bruges af en smart samling eller en regel for automatisk tagging, kan ikke arkiveres, mens de bruger den.

Tilladelse: 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 '{…}'

Crawlere

DELETE /sites/:site_id/crawlers/connection.json Afbryd Cloudflare, og slet de crawlerhits, der er importeret derfra crawlers_cloudflare_disconnect

Afbryder Cloudflare fra et websted. Det sletter det gemte API-token og alle crawler-hits, der blev importeret fra Cloudflare, og kan ikke fortrydes. Hits, der kom fra afsendte serverlogs, bliver. Tokenet findes stadig i din Cloudflare-konto, indtil du sletter det dér. Fejler, hvis webstedet ikke har nogen forbindelse. Returnerer den fjernede forbindelse. Kræver sites.manage.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 Importér crawlerhits fra Cloudflare nu crawlers_cloudflare_sync

Sætter en øjeblikkelig Cloudflare-import i kø for et websted, der allerede er forbundet, i stedet for at vente på den almindelige tidsplan. Den returnerer med det samme (HTTP 202) med forbindelsen, og importen kører i baggrunden. Hent crawlers_report gentagne gange, og hold øje med cloudflare.last_synced_at for at se, hvornår den blev færdig. Fejler, hvis webstedet ikke har nogen Cloudflare-forbindelse. Kræver sites.manage.

Tilladelse: 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-crawlere: hits pr. crawler over tid, topstier pr. crawler, efter kategori crawlers_report

Rapporterer, hvilke AI-, søge- og SEO-crawlere der henter webstedet, hvor ofte og hvilke stier, ud fra afsendte serverlogs og Cloudflare-importen. Det er crawlertrafik, ikke besøgstrafik, så den vises ikke i stats_breakdown. category er ai (standard), search, seo, other eller all, og crawler indsnævrer til én navngiven bot som GPTBot eller ClaudeBot. Vælg tidsrummet med period (standard 30d) eller tilpasset from og to. Resultatet har period (from og to som datoer), category, crawler, totals (hits, forskellige stier, forskellige crawlere), categories (hits pr. kategori, uden hensyn til kategorifilteret), crawlers (op til 50 rækker med crawler, category, hits, paths), series (etiketter pr. dag og daglige hits for de 8 øverste crawlere), top_paths (de 10 mest hentede stier for hver af de 8 øverste crawlere), has_data (false, indtil der findes hits) og cloudflare (forbindelsen med zone, status og last_synced_at, eller null). Resultater caches i op til 30 minutter, undtagen lige efter en Cloudflare-ændring. Kræver analytics.read.

Tilladelse: analytics.read

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

Dashboards

GET /workspaces/:workspace_id/dashboards/:id/cards/:index.json Data til ét kort på et eget dashboard dashboards_card

Returnerer live-data for ét kort på et brugerdefineret dashboard. Dashboards er lister af kort (se dashboards_get for kortlisten), og hvert kort indlæses for sig, så kald den én gang pr. kort med dets position i index, talt fra 0. Returnerer index, type, title, site_id, site_name, params, status og data. status er ok, not_available (kortet har intet at vise, fx et tragtkort på et websted uden tragte eller et oppetidskort uden kontroller) eller no_access (kortet hører til et websted, dit token eller din rolle ikke kan åbne, og så er title, params og data tomme). Formen på data afhænger af type. metric giver {metric, value, previous, change, period} sammenlignet med den foregående periode. chart giver {metric, interval, period, series: [{date, value}]}. breakdown giver {dimension, label, rows}. goal giver {rows} af målgennemførelser. live giver {visitors}. funnel giver {funnel_id, name, overall_conversion_rate, steps}. uptime giver {checks: [{name, status, uptime}]}. vitals giver {scorecard}. subscriptions giver {currency, mrr_minor, previous_mrr_minor (for 30 dage siden), change (procent, null uden MRR for 30 dage siden), active_subscriptions, subscription_churn_rate (seneste 30 dage)} og er not_available, mens webstedet ikke har nogen betalingsudbyder forbundet. Kortparametre er som standard period 30d, metric visitors, dimension page og 5 rækker (limit er begrænset til 10). Et index uden for listen returnerer 404. Brug først dashboards_get til at se, hvor mange kort der er.

Tilladelse: 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 Opret et eget dashboard dashboards_create

Opretter et brugerdefineret dashboard i et arbejdsområde. Et brugerdefineret dashboard er en navngivet, ordnet liste af op til 40 kort, og kortene kan komme fra forskellige websteder i arbejdsområdet. Angiv name (op til 100 tegn) og cards, en liste af objekter med type (metric, chart, breakdown, goal, live, funnel, uptime, vitals eller subscriptions), site_id (pa_..., fra sites_list) og eventuelt title (op til 80 tegn) og params. De parametre, der bruges pr. 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 tager ingen. Andre parametre droppes. period skal være en forudindstilling som 30d (ikke custom), og metric skal være en af visitors, visits, pageviews, views_per_visit, bounce_rate eller visit_duration. Hvert kort skal pege på et websted, dit token kan tilgå, og et token begrænset til nogle websteder skal have mindst ét kort med. Returnerer dashboardet med id (dash_...), name, cards og tidsstempler. Læs det med dashboards_get og indlæs hvert korts tal med dashboards_card. Kræver rettigheden content.write. Abonnementet fastsætter, hvor mange dashboards et arbejdsområde har: 1 på Free, 3 på Pro, ubegrænset på Business. Ét over antallet afvises med en valideringsfejl.

Tilladelse: 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 Slet et eget dashboard dashboards_delete

Sletter et brugerdefineret dashboard permanent. Kun dashboardets layout fjernes, ingen analysedata berøres, og der er ingen fortryd. Du skal have adgang til alle websteder, der har et kort på dashboardet, og dashboardet skal have mindst ét kort fra et websted, du kan tilgå. Returnerer det slettede dashboard. Brug dashboards_update til i stedet at ændre et dashboard. Id'er (dash_...) kommer fra dashboards_list. Kræver rettigheden content.write.

Tilladelse: 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 Vis egne dashboards dashboards_list

Viser et arbejdsområdes brugerdefinerede dashboards, sorteret efter navn. Hvert element har id (dash_...), name, cards og tidsstempler, i samme form som dashboards_get. Et token begrænset til nogle websteder ser kun dashboards, der indeholder et kort fra et af dets websteder, og kort fra andre websteder blankes til {type, status: no_access}. Med sideinddeling via page og per_page (maks. 100). Brug dashboards_card til at indlæse et korts data og dashboards_create til at tilføje et dashboard. For ét websted giver stats_overview samme slags tal uden et dashboard.

Tilladelse: 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 eget dashboard og dets kort dashboards_get

Returnerer ét brugerdefineret dashboard: id (dash_...), name, cards samt 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 websted, du ikke kan tilgå, returneres som {type, status: no_access} uden andre felter. Det returnerer kun layoutet, ikke tallene. Indlæs et korts tal med dashboards_card ved hjælp af kortets position talt fra 0. Id'er kommer fra dashboards_list. Et dashboard over abonnementets antal (1 på Free, 3 på Pro) bevares og låses: det svarer 402 plan_limit, indtil arbejdsområdet opgraderer eller sletter et andet.

Tilladelse: 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 Omdøb et eget dashboard eller erstat dets kort dashboards_update

Omdøber et brugerdefineret dashboard og/eller erstatter hele dets liste af kort. Kun de felter, du sender, ændres, og name berøres ikke, når den er tom. Hvis du sender cards, erstattes alle kort, så send den fulde liste i den rækkefølge, du ønsker, taget fra dashboards_get og redigeret. Kortformat og parametre pr. type er de samme som i dashboards_create (maks. 40 kort). Et kort vist som {type, status: no_access} hører til et websted, du ikke kan åbne. Send det tilbage uændret for at beholde det, det kan ikke redigeres, og det sidste kort fra et sådant websted kan ikke fjernes. Et token begrænset til nogle websteder kan ikke efterlade dashboardet tomt. Returnerer det opdaterede dashboard. Kræver rettigheden content.write.

Tilladelse: 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 Tilføj en datavarehusdestination warehouse_destinations_create

Tilføjer en warehouse-destination, der modtager hver dags rå hændelser (kun Business-abonnement). Dagligt kl. 02:00 UTC uploades den forrige UTC-dag, den første kørsel er ved næste 02:00 UTC, og en fejlet kørsel prøves igen en time senere. kind skal angives og afgør de påkrævede indstillinger. s3 (også GCS, R2 og MinIO via endpoint) kræver bucket, access_key_id og secret_access_key, med valgfri region, prefix og endpoint (kun https og offentlige værter). bigquery kræver service_account_json, dataset og table, med valgfri project_id. snowflake kræver account, user, private_key (PEM RSA), database, schema og table, med valgfri warehouse og role. azure kræver sas_url (et https SAS-link til en blob-container med skriveadgang), med valgfri prefix. Hemmeligheder (secret_access_key, service_account_json, private_key, sas_url) kan kun skrives og returneres aldrig. site_ids begrænser websteder (pa_...-id'er), tom betyder alle websteder, og et medlem eller token begrænset til nogle websteder skal nævne dem. Hændelsesegenskaber sendes kun, når de er markeret som sikre at eksportere (se event_properties_list). Kræver rettigheden workspace.manage. Returnerer destinationen med id (whd_...), et maskeret mål og configured (navnene på de udfyldte indstillinger).

Tilladelse: workspace.manage · Kun HTTP (ikke et MCP-værktøj)

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 Slet en datavarehusdestination warehouse_destinations_delete

Sletter en warehouse-destination, så der ikke sendes mere. Data, der allerede er uploadet, bliver i din bucket eller dit warehouse, og det kan ikke fortrydes, selv om du kan tilføje destinationen igen (historik sendes ikke automatisk igen). En manuel synkronisering, der stadig er i kø, kaldes ikke tilbage. Id'et kommer fra warehouse_destinations_list. Kræver rettigheden workspace.manage. Returnerer den slettede destination.

Tilladelse: workspace.manage · Kun HTTP (ikke et MCP-værktøj)

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 Vis datavarehusdestinationer warehouse_destinations_list

Viser et arbejdsområdes warehouse-destinationer sorteret efter navn, eventuelt kun én type (s3, bigquery, snowflake eller azure). Et medlem eller token begrænset til nogle websteder ser kun destinationer, hvis websteder alle er blandt deres, og destinationer, der sender alle websteder, er skjult for dem. Med sideinddeling via page og per_page (op til 100). Hvert element har de felter, der er beskrevet i warehouse_destinations_get. Kræver workspace_id fra workspaces_list og rettigheden workspace.manage.

Tilladelse: workspace.manage

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

Returnerer én warehouse-destination uden legitimationsoplysninger. Felterne er id (whd_...), kind (s3, bigquery, snowflake eller azure), name, target (en maskeret oversigt som s3://bucket/prefix), configured (navne på de indstillinger, der er udfyldt, hemmeligheder vises kun med navn), site_ids (tom betyder alle websteder), schedule (daily), schema_version (den rækkeopbygning, der sendes), last_run_at, next_run_at, last_error (null, når den sidste kørsel virkede) og created_at. Id'et kommer fra warehouse_destinations_list. Tjek last_error efter warehouse_destinations_sync for at se, hvordan en synkronisering gik.

Tilladelse: workspace.manage

Eksempel
curl https://privatusanalytics.com/warehouses/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /warehouses/:id/sync.json Sæt en synkronisering af én dag i kø nu warehouse_destinations_sync

Sætter en øjeblikkelig upload af én UTC-dag med rå hændelser til en destination i kø, uden for den daglige tidsplan. Kun Business-abonnement. date (YYYY-MM-DD) skal ligge før i dag i UTC og er som standard i går. Den uploader den dag for alle destinationens websteder, så undgå at synkronisere en dag, der allerede er sendt, og manuelle synkroniseringer er hastighedsbegrænsede til 30 i timen pr. arbejdsområde. Kaldet returnerer 202 med destinationen med det samme, og uploaden kører i baggrunden. Hent warehouse_destinations_get gentagne gange og læs last_run_at og last_error for at se resultatet. Id'et kommer fra warehouse_destinations_list. Kræver rettigheden workspace.manage.

Tilladelse: workspace.manage · Kun HTTP (ikke et MCP-værktøj)

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 Opdatér en datavarehusdestination (tomme hemmeligheder beholdes) warehouse_destinations_update

Ændrer en warehouse-destination (kun Business-abonnement). Kun de inputs, du sender, ændres, og kind kan ikke ændres. En tom hemmelighed beholder den gemte værdi, så du kan redigere andre indstillinger uden at sende legitimationsoplysninger igen. Indstillinger valideres for destinationens kind som i warehouse_destinations_create. Hvis du sender site_ids, erstattes listen af websteder. Når målet ændres (en anden bucket, dataset, tabel, database eller lignende), starter fremdriften for ufærdige dage forfra, så de dage sendes igen til det nye sted. Id'et kommer fra warehouse_destinations_list. Kræver rettigheden workspace.manage. Returnerer den opdaterede destination.

Tilladelse: workspace.manage · Kun HTTP (ikke et MCP-værktøj)

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 Badge med besøgstæller (SVG) for et offentligt websted badges_get

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl https://privatusanalytics.com/badge/:site_id.json
GET /share/:token/breakdown/:dimension.json Topværdier for en delt dimension shares_breakdown

Topværdier for én dimension bag et delingslink, den delte pendant til stats_breakdown. Stien tager token (den sidste del af delings-URL'en) og dimension, som skal høre til en sektion, linket deler, fx deler sources channel, referrer og referrer_url, deler pages page, entry_page, exit_page og hostname, deler campaigns utm_-dimensionerne, deler locations country og language, deler technology device, browser, os og screen, deler conversions goal og deler events event. En dimension uden for linkets sektioner afvises med en valideringsfejl. limit er 1 til 100 rækker (standard 10). Rækker har de samme felter og enheder som stats_breakdown for den dimension. Linkets låste periode og filtre vinder over period, from, to og filters, og filtre fra kalderen ignoreres, når linket ikke tillader dem. Et password-link kræver headeren X-Share-Password.

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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

Læser dashboardet bag et delingslink for personer uden en konto. Stiens token er den sidste del af en delings-URL (/share/<token>) og er den eneste legitimation, et password-link kræver også headeren X-Share-Password, og et sso-link kræver et medlem, der er logget ind. Den accepterer også et websteds-id (pa_...), når webstedet har sit offentlige dashboard slået til. Returnerer de samme data som stats_overview, begrænset til det, linket deler. Det er period, metrics (visitors, visits, pageviews, views_per_visit, bounce_rate som procent, visit_duration i millisekunder, revenue i mindste enhed), diagramserien for interval, sammenligningsdata, når compare er sat, og panels med topværdier kun for de delte sektioner. Den tilføjer site (id, name, domain, timezone), sections og locked_period. live_visitors vises kun, når linket deler live. En låst periode og låste filtre på linket tilsidesætter period, from, to og filters. Brug shares_breakdown til flere rækker af én dimension. Til dine egne websteder, brug stats_overview.

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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

Dokumentation

GET /docs/api.json Vis alle API-operationer og MCP-værktøjer docs_api

Returnerer det fulde katalog over alle API-operationer, som også er alle MCP-værktøjer. Brug det til at finde ud af, hvilket værktøj eller endpoint der findes, og præcis hvad det kræver. Hvert element har tool_name, summary, description (kan være null), group, verb (HTTP-metode), path (skabelon med pladsholdere), permission (den rettighed, et medlem eller token skal have, null for offentlige værktøjer), input_schema (JSON Schema for inputs) og response_schema (JSON Schema for svaret). Svaret er stort. Til ét værktøj, du allerede kender, så foretræk dokumentationssiderne (docs_search). docs_openapi returnerer de samme oplysninger som et OpenAPI-dokument. Offentligt, ingen godkendelse nødvendig.

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl https://privatusanalytics.com/docs/api.json
GET /docs.json Vis dokumentationssider docs_list

Viser alle dokumentationssider med title, description, path (som /docs/api/authentication), section og uden brødtekst. Brug det til at gennemse, hvad der findes. Brug docs_search til at finde en side efter emne og docs_get med dens section og side til at læse en. Med sideinddeling via page og per_page (maksimum 100). Offentligt, ingen godkendelse nødvendig.

Tilladelse: 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, der beskriver hele det offentlige API, som rå JSON (ikke pakket ind i et data-felt). Brug det, når du har brug for en maskinlæsbar specifikation til kodegenerering. Til en gennemsøgelig liste af operationer med deres input- og responsskemaer er docs_api lettere at læse. Det beskriver de samme operationer, som udstilles som MCP-værktøjer. Offentligt, ingen godkendelse nødvendig.

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl https://privatusanalytics.com/openapi.json
GET /docs/:section/:page.json Læs en dokumentationsside (Markdown og HTML) docs_get

section og page kommer fra sidestien /docs/<section>/<page>. Brug siden "index" til et overblik over et afsnit.

Tilladelse: public

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

Domain Rating

GET /sites/:site_id/domain-rating.json Domain Rating-rapport: den seneste vurdering, indgående og udgående links, ændringen siden udgivelsen før og historikken pr. måned domain_rating_report

Returnerer webstedets Domain Rating, et skøn fra 0 til 100 over, hvor stærke de links er, der peger på dets domæne, samt antal indgående og udgående links og deres historik. Det er Privatus Analytics' egen score, ikke en Google-måling. Ratings opdateres én gang om måneden pr. udgivelse, så ændringer vises månedligt. months (1 til 120, standard 12) angiver, hvor mange månedlige historikpunkter der medtages. Resultatet har domain, checked_at (hvornår webstedet sidst blev tjekket, null hvis aldrig), release (månedens seneste data som YYYY-MM), rating, inbound_links, outbound_links (hver null, hvis den endnu ikke er kendt), changes (de samme tre målinger som forskel mod den forrige udgivelse, null, når en af dem er ukendt) og history (én række pr. måned med month, rating, inbound_links, outbound_links, ældste først). Et nyt websted kan være uden rating i nogle minutter. Kræver analytics.read.

Tilladelse: analytics.read

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

Dubletter af udtalelser

POST /sites/:site_id/testimonials/duplicates/dismiss.json Sig, at en gruppe ikke er dubletter. Den vender aldrig tilbage til køen testimonial_duplicates_dismiss

testimonial_ids skal være hver kopi af én åben gruppe i dublettekøen, der er uden for papirkurven, som testimonial_duplicates_list returnerer dem. Intet flettes eller ændres på udtalelserne, og de grupperes aldrig sammen igen. For at dele en gruppe på tre skal du først flette de to, der er ens. Serveren responderer med 422, når id'erne ikke er præcis én åben gruppe.

Tilladelse: 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 grupperne af udtalelser, der sandsynligvis er den samme to gange testimonial_duplicates_list

Nøjagtige match kommer først. Hver gruppe indeholder sine kopier i fuld form og keeper_id, den kopi, der ville blive beholdt. meta.exact_groups er, hvor mange grupper testimonial_duplicates_merge_exact ville flette.

Tilladelse: 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 Flet kopier af en udtalelse ind i den i stien testimonials_merge

Den beholdte beholder sin status og verificerede tilstand og sine ord, medmindre body_from angiver en anden kopi. Den får de tags, manuelle samlinger, placeringer og brugerdefinerede egenskaber, den mangler. Kopierne går i papirkurven mærket som flettet, og at gendanne en fortryder fletningen for den kopi. En kopi, der ankom denne måned, holder op med at tælle som en ny udtalelse. Svaret indeholder meta.undo_id.

Tilladelse: 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 Flet alle nøjagtige match i køen på én gang testimonial_duplicates_merge_exact

Send først dry_run for antallene, derefter confirm_count med den total, den gav. Op til 100 grupper flettes pr. kald. Svaret indeholder meta.undo_id, og én fortryd tager hele kørslen tilbage.

Tilladelse: 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-mailindstillinger

POST /email/preferences/:token/unsubscribe.json Stop alle e-mails til en adresse, som kan slås fra, med token fra dens link til e-mailindstillinger email_preferences_unsubscribe_all

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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-mails til en adresse fra eller til med token fra dens link til e-mailindstillinger email_preferences_update

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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

E-mailrapporter

DELETE /recipients/:id.json Fjern en modtager fra en e-mailrapport email_report_recipients_delete

Fjerner én adresse fra en e-mailrapport (modtagerens id, fra email_report_recipients_list). Adressen holder op med at modtage rapporter, og dens række slettes. Hvis adressen selv havde frameldt sig, bliver frameldingen registreret, så en fjernelse gør det ikke muligt for nogen at invitere den igen. Hvis du vil ændre mange adresser på én gang, send i stedet den fulde liste via email_reports_update. Returnerer den fjernede modtager.

Tilladelse: 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 Vis modtagerne af en e-mailrapport med deres status email_report_recipients_list

Statusser: active (modtager rapporter), pending (inviteret, endnu ikke accepteret), declined eller unsubscribed. Tilføj eller fjern adresser via rapportens modtagerliste.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/reports/:report_id/recipients.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /recipients/:id/resend.json Send en afventende rapportinvitation igen email_report_recipients_resend

Sender invitationen igen med nye links. Tilladt én gang hver 7. dag pr. adresse pr. rapport.

Tilladelse: 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 Opret en e-mailrapport email_reports_create

Opretter en planlagt analyse-e-mailrapport, der dækker ét eller flere websteder (stien tager workspace_id). Påkrævet er name og site_ids (pa_...-id'er). frequency er daily, weekly (standard, sendes på en hverdag) eller monthly (den 1. i måneden), hour er klokkeslættet 0 til 23 i arbejdsområdets tidszone (standard 8), og weekday er 0 for søndag til 6 for lørdag (standard 1, bruges kun af ugentlige rapporter). blocks vælger indholdet blandt kpis, chart, pages, sources, goals, campaigns, vitals, uptime, testimonials og subscriptions (standard kpis, chart, pages, sources, goals, testimonials, subscriptions). subscriptions viser MRR og det, der flyttede den i perioden, for et websted med en betalingsudbyder forbundet. recipients er en liste af e-mailadresser (op til 50). Arbejdsområdets medlemmer er aktive med det samme, enhver anden adresse er pending og får en invitationsmail og modtager først rapporter, når den har accepteret. Adresser, der har frameldt sig, afvises. Hvis recipients udelades, tilføjes den kaldende bruger. En aktiveret rapport kræver mindst én modtager. Free tillader 3 rapporter, betalte abonnementer er ubegrænsede. Returnerer rapporten med next_run_at. Brug email_reports_send_test til at få vist den på forhånd.

Tilladelse: 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 Leveringslog for en e-mailrapport email_reports_deliveries

Viser afsendelseslogben for én e-mailrapport, nyeste først og med sideinddeling. Hver post har status (sent for en planlagt afsendelse, test, failed eller skipped), recipients_count, error (årsagen til en fejl, ellers null) og sent_at. Filtrér med status. Brug den til at bekræfte, at en planlagt rapport blev sendt, eller for at se, hvorfor den fejlede. Brug email_reports_send_test til at udløse en test-e-mail.

Tilladelse: analytics.read

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

Sletter en e-mailrapport permanent sammen med dens modtagere og leveringslog. Det kan ikke fortrydes, og der sendes ikke flere e-mails. Hvis du vil stoppe afsendelsen, men beholde rapporten, brug email_reports_update med enabled false. Id'et (rep_...) kommer fra email_reports_list. Returnerer den slettede rapport.

Tilladelse: 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 Vis e-mailrapporter email_reports_list

Viser et arbejdsområdes planlagte e-mailrapporter (stien tager workspace_id), sorteret efter navn og med sideinddeling. 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. Filtrér efter frequency (daily, weekly eller monthly). En kalder, der er begrænset til nogle websteder, ser kun rapporter, hvis websteder alle er deres. Kun modtagere med status active modtager faktisk rapporter. Brug email_reports_deliveries til afsendelseslogben.

Tilladelse: 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-mailrapport nu som en test email_reports_send_test

Sender rapporten til én adresse lige nu som en test, uden at ændre dens tidsplan eller last_sent_at. Sender en rigtig e-mail, så brug den kun, når brugeren ønsker det. recipient er som standard den kaldende bruger og må kun være kalderen, et andet medlem af arbejdsområdet eller en aktiv modtager af rapporten. Til enhver anden adresse går testen i stedet til kalderen. Testafsendelser er hastighedsbegrænsede pr. arbejdsområde og pr. ekstern adresse, og en afvist afsendelse returnerer en hastighedsgrænsefejl. Returnerer leveringen med status (test, eller failed med årsagen i error), recipients_count og sent_at. Brug email_reports_deliveries til den fulde log.

Tilladelse: 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-mailrapport email_reports_get

Returnerer én e-mailrapport via id (rep_..., fra email_reports_list). Svaret har name, site_ids, frequency, hour, weekday, recipients, recipient_details med hver adresse og dens tilmeldingsstatus, blocks, attach_pdf, intro, enabled, last_sent_at og next_run_at (UTC-tidsstempler). recipients viser alle adresser, også afventende, kun adresser med status active i recipient_details modtager rapporter. Brug email_reports_deliveries til, hvad der blev sendt.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/reports/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /reports/:id.json Opdatér en e-mailrapport email_reports_update

Ændrer en e-mailrapport (id fra email_reports_list). Kun de inputs, du sender, ændres. Hvis du sender recipients, erstattes hele listen. Adresser, du udelader, fjernes, nye følger de samme tilmeldingsregler som i email_reports_create (medlemmer er aktive med det samme, andre får en invitationsmail), og adresser, der allerede er på rapporten, beholder deres status. Hvis du ændrer frequency, hour, weekday eller enabled, genberegnes next_run_at. Sæt enabled til false for at sætte den på pause. Brug email_report_recipients_list til at se tilmeldingsstatus og email_report_recipients_resend eller email_report_recipients_delete til at håndtere enkelte adresser.

Tilladelse: 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 Acceptér en rapportinvitation report_invites_accept

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/reports/invites/:token/decline.json \
  -H "Content-Type: application/json" -d '{…}'
POST /reports/resubscribe/:token.json Modtag rapporter igen efter en afmelding report_resubscribes_confirm

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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 et link til at modtage rapporter igen report_resubscribes_create

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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

Eksperimenter

POST /sites/:site_id/experiments.json Opret et eksperiment som kladde experiments_create

Opretter en A/B-test eller split URL-test for et websted. Det gemmes som kladde og sender ingen besøgende nogen steder, før en person starter det i appen. Påkrævet er name, path (den oprindelige side, f.eks. /pricing), goal_id (fra goals_list) og variants: en liste af { name, path, weight }, hvor den første række er den oprindelige side (dens path ignoreres), og hver anden række er en side på samme websted. Udelad alle weight for en jævn fordeling, eller send weight, der tilsammen giver 100. Free-abonnementet tillader ét eksperiment ad gangen med originalen og én variant. Pro og opefter tilføjer flere varianter, automatisk fordeling, målretning, en * i stien, sekundære mål, planlagt start og eksklusive grupper. Kræver content.write. Returnerer eksperimentet.

Tilladelse: 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 Slet et eksperiment med dets resultater experiments_delete

Sletter permanent et eksperiment med dets varianter og resultater. Det kan ikke fortrydes. Brug experiments_pause for at stoppe det og beholde resultaterne. MCP-værktøjet kører det ikke og svarer med human_only og den side, hvor en person sletter det. Kræver content.write.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Kopiér et eksperiment som en ny kladde experiments_duplicate

Opretter en kladde med de samme sider, andele, mål og regler som et eksisterende eksperiment og uden nogen af dets resultater. Brug den til at ændre en test, der allerede er startet. Tæller med i abonnementets grænse som et nyt eksperiment. Kræver content.write. Returnerer det nye eksperiment.

Tilladelse: 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 Afslut et eksperiment for altid experiments_end

Afslutter et kørende eller pauset eksperiment. Det kan ikke startes igen, dets resultater bevares, og det tæller ikke længere med i abonnementets grænse. MCP-værktøjet kører det ikke og svarer med human_only og den side, hvor en person afslutter det. API'et kører det. Kræver content.write.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Vis et websteds eksperimenter experiments_list

Viser et websteds A/B-tests og split URL-tests, nyeste først. Filtrer med status (draft, scheduled, running, paused, ended eller all, standard all). Opdelt i sider med page og per_page (standard 25, op til 100). Hvert eksperiment har id (exp_...), name, status, path (den oprindelige side), goal_id, variants (id, name, path, weight, control), reglerne for at afslutte det og locked (true, når abonnementet ikke længere dækker det). Kræver analytics.read.

Tilladelse: 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 Sæt et eksperiment på pause og behold dets resultater experiments_pause

Sætter et kørende eller planlagt eksperiment på pause. Alle besøgende får straks den oprindelige side igen, og resultaterne indtil nu bevares. experiments_start genoptager det. Kræver content.write. Returnerer eksperimentet.

Tilladelse: 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 ét eksperiment med dets resultater experiments_get

Returnerer ét eksperiment efter id (exp_..., fra experiments_list) med dets resultater: pr. variant besøg, konverteringer og konverteringsrate på målet, og i forhold til originalen løftet, det sandsynlige interval for forskellen, p-værdien, om den er signifikant ved den valgte konfidens, og sandsynligheden for, at den slår originalen. results.progress fortæller, hvor langt der er til, at en vinder kan udpeges, og results.mismatch.found true betyder, at besøgene ikke er fordelt, som andelene siger, så resultatet bør ikke stoles på. split opdeler resultaterne efter enhed, kanal eller land (Pro og opefter), og humans_only beholder besøg, som bot-scoren vurderer som sandsynligvis menneskelige (Business). Et besøg tæller for en variant, når det har set den variant, og en konvertering tæller først derefter. Kræver analytics.read.

Tilladelse: 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 eksperiment, der er en kladde eller på pause, så de besøgende på den oprindelige side begynder at blive sendt til varianterne. Med starts_at i fremtiden venter det til det tidspunkt. Fordi det omdirigerer rigtige besøgende, kører MCP-værktøjet det ikke og svarer med human_only og den side, hvor en person starter det. API'et kører det. Kræver content.write.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Opdater et eksperiment experiments_update

Ændrer et eksperiment. Kun de inputs, du sender, ændres, og variants erstatter hele listen. Når et eksperiment er startet, kan kun name og send_to_winner ændres, fordi nye sider, andele eller mål midt i forløbet ville ødelægge resultatet: brug experiments_duplicate og redigér kopien. Kræver content.write. Returnerer eksperimentet.

Tilladelse: 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 '{…}'

Eksport

POST /workspaces/:workspace_id/exports.json Sæt en eksport i kø (bygges i baggrunden) exports_create

Sætter en dataeksport i kø, som bygges i baggrunden, og returnerer den med det samme med status queued. Vælg den, når du har brug for en fil (CSV, JSON, XLSX, NDJSON eller en ZIP af dashboardpaneler), og brug først exports_preview til at tjekke kolonner og størrelse uden at oprette noget. Til lette tal, brug i stedet statistikværktøjerne. Påkrævede inputs er workspace_id (sti), site_id, from og to (YYYY-MM-DD, inklusive, i eksportens tidszone). kind afgør, hvad der eksporteres, og hvilke indstillinger der gælder. aggregated (standard) giver besøgsmålinger pr. tidsinterval og bruger grouping, dimensions (op til 6), metrics, filters og segment_id. pageviews, events og raw giver én række pr. hit og bruger fields, filters og segment_id, kræver Pro-abonnementet eller derover og er begrænset til 400 dage (raw til 93 dage). imported giver importerede daglige statistikker og bruger kun dimensions. dashboard giver en ZIP af oversigtspanelerne (kun format zip). De tilladte file_format pr. kind er csv, json eller xlsx for aggregated, pageviews, events og imported, csv eller ndjson for raw og zip for dashboard. Indstillinger, der ikke gælder for den valgte kind, ignoreres. Et arbejdsområde kan højst have 5 eksporter i kø eller i gang ad gangen. Svaret er eksporten med id (exp_...), status, row_count og expires_at (null, indtil den er bygget). Hent exports_get gentagne gange, indtil status er complete, og kald derefter exports_download. Den bruger, der anmodede om den, får en e-mail, når den er klar, en webhook export.ready sendes, og handlingen skrives i revisionsloggen. Hændelsesegenskaber i kolonnen props omfatter kun egenskaber, der er markeret som sikre at eksportere (se event_properties_list).

Tilladelse: 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 Slet en eksport og dens fil exports_delete

Sletter en eksport og dens genererede fil permanent. Downloadlinket holder op med at virke med det samme, og det kan ikke fortrydes, men du kan oprette eksporten igen. Brug den til at fjerne en færdig eller fejlet eksport, du ikke længere har brug for, da filer også slettes automatisk 7 dage efter, de er bygget. Id'et kommer fra exports_list. Returnerer det slettede eksportobjekt, som det var før sletningen.

Tilladelse: analytics.export · Kun HTTP (ikke et MCP-værktøj)

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 Hent et signeret link til filen (gyldigt i 10 minutter) exports_download

Returnerer et kortlivet downloadlink til en færdig eksport. Vælg den, efter exports_get viser status complete. Svaret har url (et signeret link, der er gyldigt i 10 minutter, hent det med det samme), expires_at (hvornår linket holder op med at virke, ISO 8601), filename og byte_size (bytes). Den fejler med fejlkoden ikke fundet expired, når eksporten er ældre end 7 dage, og med en valideringsfejl, når eksporten stadig er i kø eller i gang, eller når den fejlede (fejlmeddelelsen siger hvorfor). Kald den igen for at få et nyt link, så længe selve eksporten ikke er udløbet. Id'et kommer fra exports_list.

Tilladelse: analytics.export

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

Viser et arbejdsområdes eksporter for de websteder, du kan tilgå, nyeste først. Brug den til at finde et eksport-id, tjekke hvilke eksporter der stadig kører, eller se, hvad der er udløbet. Filtrér med site_id, status (queued, running, complete, failed eller expired) og kind (aggregated, pageviews, events, imported, raw eller dashboard). Med sideinddeling via page og per_page (op til 100), og returnerer data (en liste af eksporter, se exports_get for felterne) plus meta for sideinddeling. Kræver workspace_id fra workspaces_list.

Tilladelse: analytics.export

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/exports.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /workspaces/:workspace_id/exports/preview.json Få vist en eksport: de første 20 rækker og det anslåede antal rækker exports_preview

Prøvekørsel af en eksport, der ikke opretter noget. Den tager de samme inputs som exports_create og returnerer kind, file_format, columns (kolonnenavnene i rækkefølge), rows (op til 20 eksempelrækker som objekter med kolonnen som nøgle) og estimated_rows (et omtrentligt antal rækker i den fulde fil). For kind dashboard viser eksempelrækkerne hvert filnavn med dets antal rækker. Brug den til at validere dimensioner, felter, filtre og datointervallet og til at se, hvor stor eksporten ville blive, før du kalder exports_create. Den kører synkront, så hold datointervallet rimeligt. Valideringsfejl er de samme som for exports_create, inklusive kravet om Pro-abonnement for kind på rækkeniveau. Intet gemmes, og der sendes ingen e-mail.

Tilladelse: 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 dens status exports_get

Returnerer én eksport, inklusive dens fremdrift. Brug den til at hente en eksport startet med exports_create gentagne gange, indtil status er complete eller failed. Statusserne er queued, running, complete, failed og expired. Felterne omfatter id (exp_...), site_id (pa_...), kind, format, status, params (eksportens gemte definition), row_count (null, indtil den er færdig), error (sat, når den fejlede), completed_at, expires_at (filer gemmes 7 dage efter færdiggørelse), download_url (kun sat, mens filen kan downloades, brug exports_download for at få et signeret link) og created_at. Id'et kommer fra exports_create eller exports_list.

Tilladelse: analytics.export

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

Fakturering

POST /workspaces/:workspace_id/billing/badge.json Til- eller framelding af badge-bonussen (gratis abonnement) billing_badge

Tilmelder eller afmelder et Free-arbejdsområde Privatus Analytics-badgebonussen, som hæver den månedlige hændelseskvote. Sæt enabled til true for at tilmelde. Et baggrundstjek leder derefter efter badget på arbejdsområdets websteder og verificerer det, hvilket kan tage et øjeblik, så læs billing_get bagefter og se på badge.verified_at. Sæt enabled til false for at afmelde, hvilket rydder tjekket og verificeringsdatoerne og fjerner bonussen. Tilmelding på et Pro- eller Business-arbejdsområde afvises, fordi betalte abonnementer ikke har nogen bonus. Returnerer arbejdsområdets faktureringsobjekt som billing_get. Kræver billing.manage.

Tilladelse: billing.manage · Kun HTTP (ikke et MCP-værktøj)

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 Opsig ved udgangen af faktureringsperioden billing_cancel

Opsiger det betalte abonnement ved udgangen af den nuværende betalte periode. Intet refunderes, og abonnementet forbliver aktivt til current_period_ends_at, hvorefter arbejdsområdet skifter til Free. Brug billing_resume til at fortryde det inden da. Fejler, hvis arbejdsområdet ikke har noget abonnement, eller en opsigelse allerede er planlagt. Den valgfrie reason (en af enum-værdierne) og comment er en afgangsundersøgelse. En kommentar, hvis den angives, sendes på e-mail til Privatus Analytics-teamet som en feedbackbesked fra medlemmet og gemmes ikke. Returnerer faktureringsobjektet med cancel_at_period_end true. Kræver billing.manage.

Tilladelse: billing.manage · Kun HTTP (ikke et MCP-værktøj)

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 Skift abonnement, niveau eller interval (forholdsmæssigt) billing_change_plan

Flytter det eksisterende abonnement til et andet abonnement, hændelsesniveau eller faktureringsinterval. Det koster penge. Ændringen træder i kraft med det samme, og Paddle beregner den forholdsmæssigt, så et gebyr eller en kredit bliver anvendt på det registrerede betalingsmiddel med det samme. Kør først billing_preview med de samme inputs for at se de nøjagtige beløb. Fejler, hvis arbejdsområdet ikke har noget abonnement (brug billing_checkout til det), hvis målet er det nuværende abonnement, niveau og interval, eller hvis der ikke findes en pris for kombinationen af abonnement og hændelser. Værdien events skal være et af niveauerne fra plans_list. Returnerer det opdaterede faktureringsobjekt. Kræver billing.manage.

Tilladelse: billing.manage · Kun HTTP (ikke et MCP-værktøj)

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-betaling for et betalt abonnement billing_checkout

Starter et Paddle-checkout for et arbejdsområde, der endnu ikke har noget abonnement, og returnerer en hostet checkout-URL. Intet bliver trukket, før en person gennemfører checkout i en browser, så giv url'en til personen. Brug billing_change_plan i stedet, når arbejdsområdet allerede har et abonnement. Inputs er plan (pro eller business), events (et niveau for hændelser pr. måned fra plans_list) og interval (month eller year, standard month). Priserne er inklusive moms eller salgsafgift. Et godkendt rabatprogram anvendes 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, bruges af Paddle-overlayet), custom_data og discount_id (kan være null). Fejler, hvis arbejdsområdet allerede har et abonnement. Kræver billing.manage.

Tilladelse: billing.manage · Kun HTTP (ikke et MCP-værktøj)

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 Ansøg om rabat for nonprofit, uddannelse eller open source billing_discount

Ansøger om et rabatprogram for arbejdsområdet. Det indsender en ansøgning til gennemgang af personalet og sender en e-mail til Privatus Analytics-teamet, det giver ikke selv en rabat. Programmerne er nonprofit, education, open_source (50 procent rabat), open_source_free (gratis Pro op til 1M hændelser om måneden) og agency (20 procent rabat på alle arbejdsområder, du ejer). Der er kun tilladt én åben ansøgning (pending, approved eller active) pr. arbejdsområde, og du kan ansøge igen efter en afvisning eller tilbagekaldelse. license gemmes kun for de to open source-programmer. Returnerer ansøgningen 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, kan være null). Tjek fremdriften senere i feltet discount i billing_get. Kræver billing.manage.

Tilladelse: billing.manage · Kun HTTP (ikke et MCP-værktøj)

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 Hent et link til at opdatere betalingsmetoden billing_payment_method

Returnerer et Paddle-link, hvor en person kan opdatere abonnementets betalingsmiddel. Selve kaldet ændrer intet. Giv url'en til personen, så den kan åbnes i en browser. Resultatet har kind (payment_method) og url. Fejler, når arbejdsområdet ikke har noget aktivt abonnement. Brug billing_portal til fakturaer, adresser og alle andre faktureringsoplysninger. Kræver billing.manage.

Tilladelse: billing.manage · Kun HTTP (ikke et MCP-værktøj)

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 Hent et link til Paddles kundeportal billing_portal

Returnerer et link til Paddles kundeportal, hvor en person kan se fakturaer, betalingsmidler og adresser. Selve kaldet ændrer intet. Giv url'en til personen, så den kan åbnes i en browser. Resultatet har kind (portal) og url. Fejler, hvis arbejdsområdet endnu ikke har nogen Paddle-kunde (det er aldrig gået til checkout), eller når kunden deles med andre arbejdsområder, som kalderen ikke kan tilgå, fordi portalen afslører alle kundens data. Brug billing_payment_method til kun kortet. Kræver billing.manage.

Tilladelse: billing.manage · Kun HTTP (ikke et MCP-værktøj)

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 Få vist en ændring af abonnementet med forholdsmæssig afregning billing_preview

Viser, hvad det ville koste lige nu at flytte abonnementet til et andet abonnement, niveau eller interval, uden at ændre noget. Kør den altid før billing_change_plan med de samme inputs plan, events og interval. Fejler, hvis arbejdsområdet ikke har noget abonnement, eller målet svarer til den nuværende pris. Returnerer plan, events, interval, price_id, amount (hele USD i listepris for intervallet), currency, charge_minor (hvad der ville blive trukket nu), credit_minor (kredit for ubrugt tid) og result_minor (nettobeløb), alle i mindste valutaenhed, result_action (charge eller credit, kan være null), next_billed_at (kan være null) og warnings (strenge, fx at sidste måneds forbrug overstiger det nye niveau, eller abonnementsgrænser som websteder eller medlemmer, som det nye abonnement ville overskride). Kræver billing.manage.

Tilladelse: 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 Fortryd en planlagt opsigelse eller genoptag en pause billing_resume

Fortryder en planlagt opsigelse eller genoptager et sat på pause abonnement, så abonnementet fortsætter med at forny. Brug den efter billing_cancel og før current_period_ends_at. Et abonnement på pause genoptages med det samme. Fejler, når der ikke er nogen planlagt opsigelse, og abonnementet ikke er på pause. Returnerer det opdaterede faktureringsobjekt. Kræver billing.manage.

Tilladelse: billing.manage · Kun HTTP (ikke et MCP-værktøj)

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 abonnement, betaling og forbrug billing_get

Returnerer arbejdsområdets abonnement og faktureringstilstand. Brug den, før du ændrer noget i faktureringen, og for at se, om abonnementet er aktivt eller ved at blive opsagt. Felterne omfatter workspace_id, plan (free, pro, business eller enterprise), plan_events (det solgte niveau for hændelser pr. måned), allowance (hændelser pr. måned, der faktisk er tilladt, inklusive en eventuel badgebonus), 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 opsigelse er planlagt), canceled_at, auto_upgrade, discount (den seneste rabatansøgning, kan være null), discount_percent, billing_emails (array), tax_id, badge (opted_in, verified_at, checked_at og bonussens størrelse) og usage (det samme objekt, som billing_usage returnerer). Kræver billing.manage. Fakturaer findes i billing_invoices_list, og en månedsvis oversigt over forbrug er billing_usage.

Tilladelse: billing.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/billing.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/billing.json Opdatér faktureringsmails, momsnummer og automatisk opgradering billing_update

Opdaterer arbejdsområdets faktureringsindstillinger. Kun de inputs, du sender, ændres. billing_emails er et array med op til 5 ekstra adresser til fakturaer og faktureringsmeddelelser og erstatter hele listen. tax_id gemmes på arbejdsområdet og føjes ikke til fakturaer, så det skal også indtastes i checkout. auto_upgrade er som standard false. Når den er true, flytter arbejdsområdet til det næste niveau og trækker forskellen, når den månedlige hændelsesgrænse nås, i stedet for at sætte indsamlingen på pause. Hvis du slår den til, mens indsamlingen allerede er sat på pause ved grænsen, opgraderes og trækkes der med det samme, og der sendes en bekræftelsesmail. Hvis Paddle afviser opgraderingen, gemmes intet. Returnerer faktureringsobjektet som billing_get. Kræver billing.manage.

Tilladelse: billing.manage · Kun HTTP (ikke et MCP-værktøj)

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 denne måneds forbrug, prognose og fordeling pr. websted billing_usage

Returnerer arbejdsområdets hændelsesforbrug for én måned. Brug den til at tjekke, hvor tæt arbejdsområdet er på sin hårde månedlige grænse. Inputtet er month (en vilkårlig dag i måneden, standard den nuværende måned). Kun sidevisninger og brugerdefinerede hændelser tælles med. Felterne er month, events, bots (samlet antal bots, faktureres ikke), allowance, percent (0 til 100 og derover, én decimal), forecast og forecast_percent (lineær fremskrivning til månedens slutning, null for tidligere måneder), days_left, status (ok, warning ved 80 procent, over ved 100 procent, paused eller locked), sites (pr. websted site_id, domain, name, events og share i procent, største først), history (tidligere måneder som month og events), access_locked_at, collection_paused (true, når nye hændelser droppes), pause_reason (limit eller staff, kan være null), collection_paused_at og resumes_at (den 1. i næste måned, når pausen skyldes grænsen). Kræver billing.manage.

Tilladelse: 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 Vis fakturaer billing_invoices_list

Viser arbejdsområdets faktureringstransaktioner, nyeste først. Hvert element har id (bruges med billing_invoices_get), invoice_number (kan være null), status, amount_minor (heltal i mindste valutaenhed, så 900 betyder 9,00), currency (ISO-kode som USD) og billed_at (ISO 8601, kan være null). Med sideinddeling via page og per_page (maksimum 100). Den viser kun transaktioner. Kald billing_invoices_get for at få PDF'en, og brug billing_payment_method til at opdatere kortet. Kræver billing.manage.

Tilladelse: 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-linket til en faktura billing_invoices_get

Returnerer et link til PDF-fakturaen for én faktureret transaktion. Hent fakturaens id fra billing_invoices_list (feltet id, et Paddle-transaktions-id). Resultatet har kind (invoice) og url, som er et link til PDF'en fra Paddle, så hent eller del den kort efter kaldet. Fejler, hvis id'et ikke tilhører dette arbejdsområde, eller Paddle ikke har nogen faktura til det. Kræver billing.manage.

Tilladelse: billing.manage

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

Formularer

POST /sites/:site_id/testimonials/forms.json Opret en formular testimonial_forms_create

Ét kald bærer hele formularen: trin, spørgsmål, spring-logik, samtykketekst og sprog. Alt, der udelades, starter fra en fornuftig standard på formularens sprog, og slug kommer fra navnet. Linket er https://privatus.page/f/<slug>. Routing af lave vurderinger og brugerdefineret CSS kræver Business-planen (402 plan_limit uden). Video- og lydsvar tilbydes giveren på Pro og op.

Tilladelse: 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 Slet en formular for altid testimonial_forms_delete

Sletter formularen, dens indsendelsesposter, dens belønning og dens private feedback. De udtalelser, den indsamlede, beholdes. Det kan ikke fortrydes, så det gøres af en person på siden. API'et tager confirm (formularens navn eller id).

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 Flyt en formular til papirkurven testimonial_forms_trash

Dens link responderer, at formularen er lukket, indtil den gendannes. Papirkurven tømmes efter 30 dage. Over MCP ændrer værktøjet intet og responderer med den side i appen, hvor en person gør det.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Kopiér en formular, eventuelt til et andet sprog testimonial_forms_duplicate

Kopierer hver indstilling undtagen slug, statistikken og belønningen.

Tilladelse: 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 et steds formularer testimonial_forms_list

Formularer i papirkurven listes med trashed true og udelades ellers. Hver formular bærer sine indstillinger, sin belønning og hvor mange indsendelser den har haft.

Tilladelse: 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 en formulars QR-kode som SVG eller PNG testimonial_forms_qr

Koden rummer formularens link med ?src=qr, så scanninger tælles som en kanal for sig. En ændret slug holder en trykt kode i live.

Tilladelse: 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 Gendan en formular fra papirkurven. Dens link virker igen testimonial_forms_restore

Tager en formular ud af papirkurven, som den var, med dens spørgsmål, indsendelser og private feedback. Dens link (/f/<slug>) og dens indlejringer tager imod svar igen. Serveren responderer med 422 og koden not_in_trash for en formular, der ikke er i papirkurven.

Tilladelse: 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 en formulars link, links til QR-kode og indlejringskoder testimonial_forms_share

Returnerer linket, indlejringskoden til inline og indlejringskoden til popup. Popup-inputtene (trigger, label, position, accent) ændrer popup-koden.

Tilladelse: 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 én formular med hvert trin, spørgsmål, regel og indstilling testimonial_forms_get

Returnerer hele formularen, som testimonial_forms_create og testimonial_forms_update tager den, med dens slug, dens link, dens belønning og hvor mange indsendelser den har. En formular i papirkurven findes ikke her: gendan den først.

Tilladelse: 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 Ændr en formular. Kun de sendte inputs ændres testimonial_forms_update

En ændring af et trin, et spørgsmål eller samtykketeksten hæver formularens version, som hver samtykkepost gemmer. En ændret slug lader det gamle link omdirigere. Send questions som hele listen.

Tilladelse: 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 '{…}'

Fortrydelsesliste for udtalelser

GET /sites/:site_id/testimonials/settings/undo.json List det, der blev ændret de seneste 7 dage og kan fortrydes testimonial_undo_records_list

Nyeste først. Hver post fortæller, hvad der kørte, hvem der kørte det, hvor mange den ændrede og sprang over og hvorfor, og indtil hvornår den kan fortrydes.

Tilladelse: 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 Læs én fortrydelsespost testimonial_undo_records_get

For en kørsel i baggrunden er state running, og processed fortæller, hvor langt den er.

Tilladelse: 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 Fortryd en massehandling eller en enkelt ændring inden for 7 dage testimonial_undo_records_undo

Sætter den tidligere værdi tilbage på alt, kørslen ændrede. Det, der er ændret igen siden, lades være og tælles i left. En fletning af personer eller af dubletter fortrydes på samme måde. Over MCP køres en fortryd, der ville slette eller flytte til papirkurven, ikke (fortrydelse af en gendannelse, af en oversættelseskørsel og af en billedkørsel): værktøjet responderer med human_only og den side i appen, hvor en person gør det.

Tilladelse: 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 '{…}'

Gemte visninger af udtalelser

POST /sites/:site_id/testimonials/views.json Gem et filter, en søgetekst, en sortering og et layout i indbakken under et navn testimonial_saved_views_create

En personlig visning kræver kun analytics.read. En delt kræver content.write og afvises ellers med koden not_allowed. En fastgjort visning sidder i sidebjælken med sit antal. Åbn den med testimonials_list og view_id.

Tilladelse: 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 Slet en gemt visning. Ingen udtalelse berøres testimonial_saved_views_destroy

En gemt visning er et gemt filter, så kun visningen forsvinder. En widget eller væg, der fodres af visningen, beholder sine indstillinger og har intet at vise, før den får en anden kilde. En personlig visning slettes af sin ejer, og en delt kræver content.write. Ellers afvises kaldet med koden not_allowed. Over MCP ændrer værktøjet intet og responderer med den side i appen, hvor en person gør det.

Tilladelse: analytics.read · Kun HTTP (ikke et MCP-værktøj)

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 gemte visninger på et sted, som den kaldende kan åbne testimonial_saved_views_list

Returnerer den kaldendes egne visninger og alle delte, fastgjorte først i deres rækkefølge, derefter efter navn. scope er all (standard), mine eller shared. Giv en visnings id som view_id til testimonials_list for at læse de udtalelser, den rummer.

Tilladelse: 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 Omdøb en gemt visning, ændr det, den gemmer, fastgør den eller del den testimonial_saved_views_update

Kun de sendte inputs ændres: name, den gemte søgning (q), filters, sort, layout, columns, position, pinned og shared. En personlig visning ændres af sin ejer. At ændre en delt visning og at dele eller ophøre med at dele en visning kræver content.write.

Tilladelse: 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 '{…}'

Hjælp og feedback

POST /help.json Send et spørgsmål eller feedback til teamet bag Privatus Analytics support_message_send

Beskeden sendes med e-mail til teamet sammen med oplysninger om din konto, dit arbejdsområde og din plan. Svaret og en kvittering sendes til din kontos e-mailadresse. Op til 10 beskeder om dagen.

Tilladelse: member

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

Hændelser

GET /sites/:site_id/events/properties.json Vis nøgler til hændelsesegenskaber set inden for de seneste 30 dage event_properties_list

Viser de egenskabsnøgler, som brugerdefinerede hændelser har båret inden for de seneste 30 dage, med visningsindstillinger. Returnerer en liste af {key, events, display_name, hidden, export_safe}. events er, hvor mange brugerdefinerede hændelser der bar nøglen (0 for en nøgle, der har indstillinger, men ikke er set for nylig), display_name er omdøbningen (null, når der ingen er), hidden siger, at nøglen er skjult i rapporter, og export_safe siger, at den er markeret som uden personoplysninger. Der returneres højst 200 nøgler, de mest brugte først. Angiv event for kun at se nøgler set på ét rå hændelsesnavn. Egenskabsværdier returneres aldrig her, brug stats_breakdown med dimension prop:<key> eller events_get til værdier. Ændr indstillinger med event_properties_update.

Tilladelse: 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 Omdøb eller skjul en nøgle til en hændelsesegenskab event_properties_update

Omdøber, skjuler eller markerer én hændelsesegenskabsnøgle som eksportsikker, for hele webstedet. Kun de inputs, du sender, ændres. key skal være nøglen, som den er gemt (små bogstaver, cifre og understregninger, op til 64 tegn, fx plan). display_name er en etiket på op til 64 tegn (send den tom for at fjerne omdøbningen). hidden fjerner nøglen fra rapporter og hændelsesdetaljens pivot, mens data bevares. export_safe erklærer, at nøglen aldrig indeholder personoplysninger, hvilket tager dens værdier med i rå eksporter og warehouse-synkroniseringer, så sæt den kun, når det er sandt. Omdøbninger og skjulning gælder, når rapporter læses, og omskriver ingen gemte data. Returnerer {key, display_name, hidden, export_safe}. Kræver rettigheden sites.manage. Vis nøglerne med event_properties_list.

Tilladelse: 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 Slet en hændelse og dens historik (kører i baggrunden, bekræft ved at skrive navnet) events_delete

Sletter en brugerdefineret hændelse og hele dens historik permanent. Det kan ikke fortrydes. Det rå hændelsesnavn skal sendes to gange, i name og igen i confirm, som en sikkerhedskontrol. Returnerer {name, status: queued} med HTTP 202, fordi rækkerne fjernes i baggrunden i bidder, så tallene bliver ved med at ændre sig, indtil det er færdigt. Hændelsen skjules også med det samme, og sletningen noteres i revisionsloggen. Sidevisninger påvirkes ikke. Hvis du blot vil holde op med at vise en hændelse, brug events_update med hidden true, som bevarer data. Kræver rettigheden sites.manage. Navne kommer fra events_list (brug feltet raw_names, hvis hændelsen blev omdøbt eller slået sammen).

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 Vis hændelser med gennemførelser, besøg, konverteringsrate og først/sidst set events_list

Hændelsesudforskeren: alle brugerdefinerede hændelser i perioden. Returnerer period, events og hidden. Hver hændelse har name (visningsnavnet efter omdøbninger og sammenlægninger), raw_names (de navne, trackeren sendte), completions, visits, conversion_rate (procent af besøg, 0 til 100), revenue (mindste enhed, cent), first_seen og last_seen (ISO 8601-tidsstempler inden for perioden) og currency (omsætningens valuta, null når den ikke er sat). hidden viser hændelser, du har skjult, som {name, display_name}. Brug search til at beholde hændelser, hvis navn indeholder noget tekst. Sidevisninger er ikke hændelser her. Brug events_get til én hændelse i dybden og stats_breakdown med dimension event til en rangeret liste med sideinddeling. Tager de fælles inputs period, compare, filters og segment.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/events.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /sites/:site_id/events/merge.json Flet flere hændelser til ét visningsnavn events_merge

Slår flere rå hændelsesnavne sammen til ét visningsnavn, fx signup_click og signup_button til Signup. Rapporter viser derefter én hændelse med de samlede antal. Det virker, når rapporter læses, og de gemte hændelser ændres eller slettes ikke. Angiv names (de rå navne, mindst ét) og into (visningsnavnet). Returnerer ét indstillingsobjekt pr. sammenlagt navn, hver {name, display_name, hidden, currency, updated_at}. For at fortryde, kald events_update for et navn med en tom display_name. Kræver rettigheden sites.manage. Navne kommer fra events_list (raw_names).

Tilladelse: 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 hændelse: diagram, egenskabspivot, aggregater for talegenskaber, sider og kilder events_get

Detaljer om én brugerdefineret hændelse. Angiv name præcis som vist i events_list (visningsnavnet efter omdøbninger og sammenlægninger). Returnerer period, name, raw_names (de gemte navne bag den), interval, totals, setting, series, property_keys, pivot, numeric, pages, channels og referrers. totals har completions, visits (besøg, der udløste den), revenue (mindste enhed, cent) og conversion_rate (procent af alle besøg i perioden). series er gennemførelser pr. tidsinterval. setting har display_name, hidden og currency. property_keys viser de egenskabsnøgler, der er set. Send properties (op til 3 nøgler) for at få pivot, rækker af {values, completions, visits} for hver værdikombination, de øverste 100. numeric giver sum, gennemsnit og andre tal for egenskaber, der holder tal. pages, channels og referrers er de 10 øverste steder, hvor hændelsen blev udløst, som {value, completions, visits}. Brug events_list til alle hændelser, stats_breakdown med dimension prop:<key> til én egenskab på tværs af webstedet og events_update til at omdøbe den.

Tilladelse: 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 Omdøb, skjul eller vis en hændelse, eller angiv dens valuta events_update

Ændrer, hvordan én brugerdefineret hændelse vises: omdøb den med display_name, skjul eller vis den med hidden, eller sæt omsætningsvalutaen. name er det rå hændelsesnavn, som trackeren sendte det (se raw_names i events_list). Kun de inputs, du sender, ændres. En tom display_name fjerner omdøbningen. hidden fjerner hændelsen fra lister og rapporter, mens dens data bevares. currency er en ISO 4217-kode på tre bogstaver som USD, gemt med store bogstaver. Det virker, når rapporter læses, og ingen gemte hændelser omskrives. Returnerer {name, display_name, hidden, currency, updated_at}. Brug events_merge til at kombinere flere hændelser og events_delete til at slette data. Kræver rettigheden sites.manage.

Tilladelse: 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 '{…}'

Importer

DELETE /sites/:site_id/imports/google/connection.json Afbryd din Google Analytics-konto, og slet dens gemte adgangstokens imports_google_disconnect

Fjerner det kaldende medlems gemte Google Analytics-forbindelse for dette websteds arbejdsområde, så GA4-importer ikke længere kan læse fra Google, før den tilsluttes igen i appen. Data, der allerede er importeret, bliver og fjernes kun ved at slette dets import med imports_delete. Tilladelsen tilbagekaldes ikke hos Google. Den fejler med en valideringsfejl, når der ingen forbindelse er, eller mens en af medlemmets GA4-importer er i kø eller i gang. Returnerer et objekt med disconnected true. Tilslutning sker i appen (Google-loginskærmen), der er intet værktøj til det.

Tilladelse: 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 Vis Google Analytics 4-ejendomme, der kan importeres imports_google_properties

Viser de Google Analytics 4-egenskaber, som det kaldende medlems tilsluttede Google-konto kan læse. Kald den før imports_create med source ga4 for at få det property_id, der skal bruges. Returnerer en liste af objekter med id (som properties/123456789, send det som property_id), name og account. Den fejler med en valideringsfejl, når medlemmet ikke har tilsluttet Google for dette arbejdsområde (det sker i appen, der er intet værktøj til det), eller når Google afviser forespørgslen. Den foretager et live-kald til Google og ændrer intet.

Tilladelse: 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-ejendom eller CSV-upload) imports_create

Starter en import af historiske data fra et andet analyseværktøj til et websted, behandlet i baggrunden, og returnerer importen med status queued. Vælg source ga4 for at hente fra Google Analytics 4 API, som kræver en Google-forbindelse oprettet i appen, property_id (fra imports_google_properties) og date_from. date_to er som standard dagen før webstedets første sporede hændelse eller i går. Andre kilder (universal_analytics, fathom, simple_analytics, plausible, matomo, umami, clicky) tager en CSV-eksport uploadet som inputtet file (multipart-formularupload, op til 50 MB), hvilket gør dem upraktiske at starte over MCP og bedst at gøre i appen. dimension er kun nødvendig for at tilsidesætte registreringen af, hvad CSV-rækkerne opdeles efter, fx Matomo Label-eksporter. Importerede rækker tæller aldrig med i hændelseskvoten og vises kun i statistikker, når du angiver include_imported true. Et arbejdsområde kan højst have 5 importer i kø eller i gang ad gangen. Hent imports_get gentagne gange, indtil status er complete eller failed. Kræver rettigheden sites.manage.

Tilladelse: 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 Slet en import og alle dens importerede data imports_delete

Sletter en import permanent sammen med alle de rækker, den bragte ind, og dens uploadede fil. Statistikker, der indeholdt de importerede data, ændres med det samme, når include_imported er slået til, og det kan ikke fortrydes, selvom du kan importere igen. Id'et kommer fra imports_list og kræver site_id. Returnerer den slettede import. Kræver rettigheden sites.manage. Data indsamlet af trackeren berøres ikke.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 Vis importer for et websted imports_list

Viser et websteds importer, nyeste først. Brug den til at finde et import-id eller tjekke, om en stadig kører. Filtrér eventuelt efter status (queued, running, complete eller failed). Med sideinddeling via page og per_page (op til 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 at starte en.

Tilladelse: 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 dens status imports_get

Returnerer én import for et websted, bruges til at hente en import startet med imports_create gentagne gange. Felterne er id (imp_...), site_id, source, status (queued, running, complete eller failed), date_from og date_to (YYYY-MM-DD, null når ukendt), rows_imported (antal importerede daglige rækker), error (sat, når den fejlede), completed_at og created_at. Id'et kommer fra imports_create eller imports_list. Importerede rækker vises kun i statistikker, når statistikkaldet angiver include_imported true.

Tilladelse: analytics.read

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

Importkilder til udtalelser

POST /sites/:site_id/testimonials/imports/sources.json Tilføj en importkilde fra et link, og start dens første kørsel testimonial_import_sources_create

Platformen registreres ud fra linket. Det, kørslen finder, venter i gennemgangstrinnet (testimonial_import_sources_review), og intet gemmes før testimonial_import_sources_keep. Intet importeret tæller med i de månedlige udtalelser. Free-planen henter 1 import om måneden fra et anmeldelsessted eller en side. Ud over det er svaret 402 plan_limit.

Tilladelse: 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 Slet en kilde. De udtalelser, den bragte ind, bliver testimonial_import_sources_delete

Sletter kilden med dens kørselshistorik, det der venter i dens gennemgangstrin og dens uploadede fil. Udtalelser, der allerede er beholdt fra den, bliver på stedet. En person gør dette på kildens side, så værktøjet kører intet og returnerer den side.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Kassér fundne poster testimonial_import_sources_discard

Angiv item_ids (id'er fra testimonial_import_sources_review) eller all true for alt, der stadig venter, aldrig begge. En kasseret post forlader gennemgangstrinnet, og det, der blev læst om personen, slettes. Ingen udtalelse slettes. Serveren responderer ellers med 422 og koden selection eller unknown_ids.

Tilladelse: 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 Find udtalelser på stedets eget websted testimonial_import_sources_find

Læser stedets domæne og de sider, det linker til, som ser ud til at rumme udtalelser, én gang pr. sted. Det er gratis: det er ikke en af Free-planens hentede importer. Det, den finder, venter i gennemgangstrinnet for den kilde, den returnerer.

Tilladelse: 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 et steds importkilder testimonial_import_sources_list

meta indeholder fetched_imports (used, limit og resets_on for måneden, limit null er ubegrænset) og sync (det tempo, planen tillader).

Tilladelse: 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 fundne poster som udtalelser testimonial_import_sources_keep

Angiv item_ids (op til 100) eller all. Hver beholdt post gemmes gennem samme rute som enhver anden udtalelse, så dubletter aldrig gemmes to gange. Intet beholdt tæller med i de månedlige udtalelser. meta fortæller, hvor mange der blev beholdt.

Tilladelse: 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 de platforme, en import kan læse testimonial_import_platforms_list

Registret over testede kilder. En platform listes først, når dens import er bevist mod en rigtig side. Hver post fortæller, hvilket link der skal indsættes.

Tilladelse: 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 fandt, og som endnu ikke er afgjort testimonial_import_sources_review

meta indeholder antallene efter mærke (new, already_here, likely_duplicate).

Tilladelse: 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 Læs en kilde igen nu testimonial_import_sources_run

En kørsel i hånden er en hentet import og tæller som én af månedens på Free-planen (402 plan_limit derudover). Afvist, mens en kørsel er aktiv (422 in_progress) og efter 3 kørsler af kilden på 24 timer på enhver plan (422 too_many_runs). På en kilde med fejl rydder den antallet af fejl.

Tilladelse: 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 dens tilstand og antal testimonial_import_sources_get

Returnerer platformen, navnet, den læste adresse, hvor ofte den læses igen, tilstanden, hvor mange poster der venter i gennemgangstrinnet, hvor mange der blev beholdt, fejlene i træk og hvornår den sidst kørte og kører næste gang.

Tilladelse: 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 Ændr en kildes link, navn, synkronisering, automatisk godkendelse, eller sæt den på pause testimonial_import_sources_update

En synkronisering over planen (enhver på Free, ugentlig på Pro) afvises med 402 plan_limit.

Tilladelse: 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 '{…}'

Importkørsler til udtalelser

GET /sites/:site_id/testimonials/imports/sources/:import_source_id/runs.json List en kildes kørsler, nyeste først testimonial_import_runs_list

Hver kørsel har sit nummer, hvad der startede den, sin status, de læste sider og hvor mange udtalelser den fandt, hvor mange der var nye, dubletter, mislykkede og beholdte, med tidspunkterne for start og afslutning.

Tilladelse: analytics.read

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

Indsamling

POST /embed/ads/e.json Registrer, at en kreativ blev vist, set eller klikket på, kaldt af annonceloaderen ad_serving_event

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/embed/ads/e.json \
  -H "Content-Type: application/json" -d '{…}'
GET /embed/ads/:site.json Et websteds annoncepladser og de kreativer, hver af dem viser, kaldt af annonceloaderen ad_serving_slots

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl https://privatusanalytics.com/embed/ads/:site.json
POST /api/overlay.json Klikkene på én side til klikkortet på siden, kaldt af pa.overlay.js med dens adgangsnøgle click_overlays_read

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/api/overlay.json \
  -H "Content-Type: application/json" -d '{…}'
POST /api/logs.json Send serveradgangslogs til rapportering om AI-crawlere (JSON {lines: [...]} eller kombineret logtekst, med webstedets nøgle til crawlerlogge som Bearer-token) crawler_logs_create

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/api/logs.json \
  -H "Content-Type: application/json" -d '{…}'
POST /api/event.json Indsaml et browserhit (bruges af /js/pa.js) ingest_event

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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øgende til en variantside, kaldt af eksperimentets head-script ingest_experiment

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl https://privatusanalytics.com/api/experiment.json
GET /js/exp/:site.json Scriptet, som det valgfrie head-tag for eksperimenter indlæser for et websted ingest_experiment_script

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl https://privatusanalytics.com/js/exp/:site.json
POST /api/survey.json Registrer, at et undersøgelseskort blev vist, afvist eller besvaret ingest_survey

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/api/survey.json \
  -H "Content-Type: application/json" -d '{…}'
GET /api/surveys.json Hvilken undersøgelse der skal vises på en side, kaldt af trackerens ask-modul ingest_surveys

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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

Kampagner

POST /sites/:site_id/campaigns/costs.json Angiv udgiften for en kampagne i en måned campaign_costs_create

Registrerer annonceforbrug for én kampagne i én måned, så campaigns_list kan vise pris pr. erhvervelse og afkast af annonceforbrug. Hvis der allerede findes en post for samme kampagne og måned, erstattes den i stedet for at blive duplikeret, så det er også sikkert at kalde to gange. campaign er værdien af utm_campaign, som den står i dine sporede links, month er YYYY-MM (en fuld dato som 2026-09-15 accepteres og rundes til månedens første dag), og amount er i hele enheder som tal (1250.50, ikke mindste enhed). currency er en valgfri ISO-kode på 3 bogstaver og er som standard webstedets valuta. Svaret returnerer den gemte post med amount_minor i mindste enhed. Brug campaign_costs_import til mange rækker på én gang. Kræver content.write. Kræver Business- eller Enterprise-abonnementet (ellers 402 plan_limit).

Tilladelse: 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 Slet en post for kampagneomkostninger campaign_costs_delete

Sletter én forbrugspost permanent, fundet via dens id fra campaign_costs_list. Det kan ikke fortrydes, og CPA og ROAS for den kampagne og måned holder med det samme op med at medregne forbruget. Andre måneder og kampagner berøres ikke. Returnerer den slettede post. Kræver content.write. Kræver Business- eller Enterprise-abonnementet (ellers 402 plan_limit).

Tilladelse: 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 Importér kampagneomkostninger fra CSV (campaign,month,amount[,currency]) campaign_costs_import

Importerer annonceforbrug i bulk fra CSV, den hurtige måde at indlæse mange kampagner og måneder på. Send CSV-teksten i csv (bedst til værktøjer og API-kald) eller upload en fil i file (kun multipart). Den første række skal være en overskrift med campaign, month og amount, med en valgfri kolonne currency, fx campaign,month,amount,currency og derefter spring_sale,2026-09,1250.50,USD. Month er YYYY-MM, amount er i hele enheder, currency er som standard webstedets valuta. Rækker opdateres eller oprettes efter kampagne og måned, så en ny import af samme fil duplikerer ikke. Grænserne er 1 MB og 5.000 rækker. En dårlig række stopper ikke importen. Svaret har imported (antal gemt), failed (antal afvist) og errors (de første 50 meddelelser, hver med sin række, hvor række 2 er den første datarække). En manglende overskriftskolonne, en for stor fil eller fejlformateret CSV får hele forespørgslen til at fejle. Kræver content.write. Kræver Business- eller Enterprise-abonnementet (ellers 402 plan_limit).

Tilladelse: 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 Vis poster for kampagneomkostninger campaign_costs_list

Viser de annonceforbrugsposter, der er registreret for et websted, nyeste måned først og derefter efter kampagnenavn. Hver række er én kampagne i én måned med amount_minor (et heltal i mindste valutaenhed, så 125050 betyder 1.250,50), currency (ISO 4217, store bogstaver), month som YYYY-MM og postens id (et UUID, bruges til campaign_costs_update og campaign_costs_delete). Angiv campaign for kun at se én kampagne (match uden forskel på store og små bogstaver på værdien af utm_campaign). Med sideinddeling via page og per_page (maks. 100). Omkostninger indgår i CPA og ROAS i campaigns_list, så her kan du tjekke, hvilket forbrug en kampagne har. Kræver analytics.read. Kræver Business- eller Enterprise-abonnementet (ellers 402 plan_limit).

Tilladelse: 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 Ændr en post for kampagneomkostninger campaign_costs_update

Ændrer en eksisterende forbrugspost, fundet via dens id fra campaign_costs_list. Kun de inputs, du sender, ændres, så send blot amount for at rette et tal. amount er i hele enheder (1250.50) og gemmes som mindste enheder, month er YYYY-MM, currency er en ISO-kode på 3 bogstaver. Hvis du ændrer campaign eller month til en kombination, som en anden post allerede har, fejler det med en valideringsfejl i stedet for at flette. For at rette forbruget for en kampagne og måned uden at kende id'et, kald campaign_costs_create, som erstatter den eksisterende post. Kræver content.write. Kræver Business- eller Enterprise-abonnementet (ellers 402 plan_limit).

Tilladelse: 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 Opbyg og valider en URL med UTM-tags campaigns_builder

Bygger en UTM-tagget URL til en landingsside og tjekker værdierne. Intet gemmes, og ingen data læses, så den er sikker at kalde gentagne gange. Angiv destination (en fuld https://-URL) samt utm_source, utm_medium, utm_campaign, utm_content og utm_term efter behov, eller vælg en forudindstilling (newsletter, social, paid_search og så videre), som udfylder utm_source og utm_medium, når du lader dem stå tomme. Returnerer url (null, når der er en fejl), valid, destination, preset, de rensede utm_*-værdier, issues (en liste af {field, level, message}, hvor level error blokerer URL'en, og warning blot foreslår en rettelse som små bogstaver) og presets (de tilgængelige værdier for forudindstillinger). Værdier renses til små bogstaver uden mellemrum. Brug campaigns_hygiene til at finde rodede UTM-værdier, der allerede findes i din trafik, og campaigns_list til at rapportere om kampagner, der har kørt. Brug links_create i stedet, hvis du vil beholde et tagget link med en kort URL og klikantal.

Tilladelse: 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-hygiejne: næsten identiske værdier, stilproblemer og ukendte kilder campaigns_hygiene

Finder rodede UTM-værdier i en periodes trafik, så du kan rette tagningen. Returnerer period, duplicates, style_issues og unknown_sources. duplicates grupperer værdier af utm_source, utm_medium eller utm_campaign, der kun adskiller sig i store og små bogstaver, mellemrum eller tegnsætning (Facebook, facebook og face-book), hver som {field, suggestion, variants: [{value, visits}]}, hvor den mest besøgte stavemåde foreslås. style_issues viser værdier, der bryder konventionen om små bogstaver og ingen mellemrum, som {field, value, visits, suggestion} (op til 50). unknown_sources viser utm_source-værdier, der ikke er en genkendt kanal, som {value, visits} (op til 50). Kun de 500 øverste værdier pr. felt scannes. Antal er besøg. Forslag er kun råd, og intet ændres. Brug channel_rules_create til at slå varianter sammen til én kanal. Tager de fælles inputs period og filters. Brug campaigns_list til resultater og campaigns_builder til at oprette rene taggede URL'er.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/campaigns/hygiene.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/campaigns.json Kampagneoversigt med konverteringer, omsætning, omkostninger, CPA og ROAS campaigns_list

Kampagnerapport bygget på utm_campaign, med omkostning og afkast af annonceforbrug. Returnerer period, currency (webstedets valuta), goal_id og goal_name (det mål, hvis konverteringer tælles), campaigns, totals og unconverted_costs. Hver kampagne har visitors, visits, conversions, conversion_rate (procent fra 0 til 100, konverteringer divideret med besøg), revenue og sources (rækker pr. kilde og medium med de samme målinger). Når der findes omkostninger (fra campaign_costs_list), har en kampagne også cost, cpa (pris pr. konvertering, null når der ingen konverteringer er) og roas (omsætning divideret med omkostning, et forhold som 2.5, null når der ingen omkostning er). Penge (revenue, cost, cpa) er et heltal i mindste enhed (cent) i webstedets valuta. Omkostninger matches med kampagnenavne uden forskel på store og små bogstaver og fordeles forholdsmæssigt efter dage i hver måned inden for perioden. En kampagne med omkostning, men uden trafik, vises stadig. Højst 100 kampagner, de travleste først. Kun besøg med en utm_campaign er med. goal_id er som standard det første aktive mål, så angiv det eksplicit for at måle et bestemt mål (id'er kommer fra goals_list). Brug campaigns_hygiene til at rydde op i navne og stats_breakdown med dimension utm_campaign til en almindelig trafikopdeling.

Tilladelse: 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 Tilføj en kanalregel channel_rules_create

Tilføjer en brugerdefineret kanalregel i slutningen af listen, så den kører efter alle eksisterende regler, og den indbyggede taksonomi kun gælder, når ingen regel matcher. channel er det navn, der skal tildeles (op til 32 tegn, fx Partners). conditions er en ikke-tom liste af 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 skal matche, for at reglen gælder, og matchningen skelner ikke mellem store og små bogstaver. En betingelse med en tom value droppes, og en regel uden betingelser afvises. Et regex, der ikke kan kompileres, afvises. Reglen gælder for nye besøg inden for få minutter og ændrer ikke historikken. Brug channel_rules_move til at ændre rækkefølgen og channel_rules_preview til at teste den. Kræver sites.manage.

Tilladelse: 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 Slet en kanalregel channel_rules_delete

Sletter en brugerdefineret kanalregel, fundet via dens id fra channel_rules_list. Besøg, den allerede har klassificeret, beholder deres kanal, og nye besøg falder igennem til den næste matchende regel eller den indbyggede taksonomi. De resterende regler beholder deres rækkefølge. Returnerer den slettede regel. Kræver sites.manage.

Tilladelse: 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 Vis kanalregler i rækkefølge channel_rules_list

Viser et websteds brugerdefinerede kanalregler i evalueringsrækkefølge (position 1 først). Regler køres oppefra og ned mod hvert nyt besøg, og den første regel, hvis betingelser alle matcher, afgør kanalen. Et besøg, der ikke matcher nogen regel, får den indbyggede kanal (direct, organic_search, paid_search, email og så videre). Hver regel har id (et UUID), channel (det navn, den tildeler), position (fra 1), conditions (en liste af objekter med field, operator og value, som alle skal matche) og created_at. Regler påvirker kun besøg, der er registreret, efter reglen findes, og omskriver aldrig gamle data. Brug channel_rules_preview til at teste et eksempelbesøg. Kræver analytics.read.

Tilladelse: 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 Flyt en kanalregel op eller ned channel_rules_move

Flytter en kanalregel inden for evalueringsrækkefølgen, fordi den første matchende regel vinder, og rækkefølgen afgør, hvilken kanal et besøg får. direction er up eller down (én plads) eller top eller bottom (til enderne). En regel, der allerede står i kanten, bliver stående uden fejl. Positionerne nummereres om fra 1 til n, og den opdaterede regel returneres med sin nye position. Brug først channel_rules_list til at se den nuværende rækkefølge. Kræver sites.manage.

Tilladelse: 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 Få vist kanalen for en eksempelhenviser og UTM-tags channel_rules_preview

Prøvekørsel, der fortæller, hvilken kanal et eksempelbesøg ville få med webstedets nuværende regler. Intet gemmes. Send et af følgende: referrer (en URL eller et rent værtsnavn, præfikserne www og m ignoreres), utm_source, utm_medium, utm_campaign, ref, path (landingssti som /pricing) og paid_click (true, hvis URL'en indeholdt et klik-id som gclid). Resultatet har channel (den vindende kanals navn), custom_rule (true, når en brugerdefineret regel afgjorde det, false, når den indbyggede taksonomi gjorde) og referrer_host (det rensede værtsnavn, der blev brugt til matchning). En henviser fra webstedets egne domæner tæller som intern. Brug den efter channel_rules_create eller channel_rules_move for at bekræfte effekten. Kræver analytics.read.

Tilladelse: 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 Ændr en kanalregel channel_rules_update

Ændrer en brugerdefineret kanalregel, fundet via dens id fra channel_rules_list. Send channel for at omdøbe den kanal, den tildeler, og conditions for at erstatte hele betingelseslisten (listen erstattes, den flettes ikke, så send alle de betingelser, du vil beholde). Udeladte inputs berøres ikke. Betingelsesfelter, operatorer og regex-gyldighed kontrolleres på samme måde som i channel_rules_create. Ændringen gælder kun for nye besøg. Brug channel_rules_move til at ændre rækkefølgen. Kræver sites.manage.

Tilladelse: 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 '{…}'

Konto

GET /account.json Hent din profil og dine indstillinger account_get

Returnerer det loggede medlems egen profil og indstillinger. Brug den til at læse indstillinger, før du ændrer dem med account_update. Det handler om personen, ikke et arbejdsområde. Arbejdsområdets abonnement og fakturaer findes under billing_get. Felterne er email, unconfirmed_email (sat, mens en ændring af e-mailadressen afventer bekræftelse, ellers null), name (kan være null), theme (system, light eller dark), default_landing (sites eller last_site), locale (sprogkode til den loggede app), timezone (IANA-navn, kan være null), shortcuts_enabled, reduce_motion, product_emails, site_audit_emails, marketing_emails, newsletter (alle booleans, hvor true betyder tilmeldt), two_factor (boolean), passkeys (antal registrerede adgangsnøgler) og created_at (ISO 8601). En session, der kun er åbnet via et arbejdsområdes identitetsudbyder, ser kun email og visningsindstillingerne.

Tilladelse: member

Eksempel
curl https://privatusanalytics.com/account.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /account.json Opdatér din profil og dine indstillinger account_update

Opdaterer det loggede medlems egen profil, visningsindstillinger og e-mailabonnementer. Kun de felter, du sender, ændres, alt andet forbliver, som det er. Hvis du ændrer email, træder det ikke i kraft med det samme. Der sendes en bekræftelsesmail til den nye adresse (med hastighedsbegrænsning), og unconfirmed_email viser den afventende adresse, indtil den er bekræftet. API-tokens kan ikke ændre e-mailadressen og kan ikke slå marketing_emails til igen efter en afmelding, begge dele kræver en logget browser. Du må gerne slå marketing_emails fra. Sessioner åbnet af et arbejdsområdes identitetsudbyder må kun ændre visningsindstillingerne (theme, default_landing, locale, timezone, shortcuts_enabled, reduce_motion). Returnerer den opdaterede konto i samme form som account_get. Det sletter ikke kontoen og kan ikke ændre arbejdsområdets indstillinger.

Tilladelse: member

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

Kærlighedsvægge

POST /sites/:site_id/testimonials/walls.json Opret en Kærlighedsvæg testimonial_walls_create

En hostet side på https://privatus.page/w/<slug>. Alt, der udelades, starter fra en standard: titlen Wall of Love, masonry-layoutet, sluggen fra navnet.

Tilladelse: 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 Flyt en væg til papirkurven testimonial_walls_trash

Dens side responderer, at den er taget ned, indtil den gendannes, og en indlejret kopi gengiver intet. At gendanne bringer den tilbage på samme adresse. Den slettes for altid efter 30 dage. Over MCP ændrer værktøjet intet og responderer med den side i appen, hvor en person gør det.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Kopiér en væg under et nyt navn og en ny adresse testimonial_walls_duplicate

Laver en kopi med et nyt id, navnet sluttende på "copy" og en slug for sig, så den har sin egen adresse. Originalen og dens adresse ændres ikke.

Tilladelse: 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 linket til en væg og koden til at placere den inde i en anden side testimonial_walls_embed

Vægens offentlige adresse og script-, frame- og linkkoderne, der placerer den inde i en anden side. Koderne ændres aldrig, når væggen redigeres.

Tilladelse: 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 et steds Kærlighedsvægge testimonial_walls_list

Hver Kærlighedsvæg på stedet, der ikke er i papirkurven, med dens adresse, hvad der fodrer den, og hvor mange udtalelser den viser. Brug q til at søge efter navn eller slug og sort til at sortere efter navn eller nyeste.

Tilladelse: 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 Gendan en væg fra papirkurven testimonial_walls_restore

Tager en væg ud af papirkurven. Dens side responderer igen på samme adresse, og hver indlejret kopi viser den igen uden en ændring af den kode, der blev indsat.

Tilladelse: 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 væg med hver indstilling testimonial_walls_get

Alt, hvad byggeren gemmer: adressen (/w/<slug>), overskriften og knappen, layoutet, hvad der fodrer væggen, hvad hvert kort viser, stilen og søgemaskineindstillingerne. En væg i papirkurven responderer med 404.

Tilladelse: 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 Ændr en væg testimonial_walls_update

Kun de sendte inputs ændres. En ændret slug lader den gamle adresse omdirigere.

Tilladelse: 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 '{…}'

Købsforbindelser til udtalelser

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

Sletter forbindelsen og dens nøgle. Købere, der stadig venter på deres første e-mail, bliver ikke spurgt. Den stående anmodning bliver som optegnelsen over det, der blev sendt.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 et steds købsforbindelser testimonial_purchase_connections_list

Hver med sin regel, sin tilstand og sin stående anmodning. Nøglen returneres aldrig. paused er true på en plan uden anmodninger efter et køb: forbindelsen beholdes, læser ingen betalinger og spørger ingen.

Tilladelse: sites.manage

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

Live

GET /sites/:site_id/live.json Live-besøgende, aktivitetsstrøm og hvad der er populært lige nu (de seneste 30 minutter) live_get

Hvad der sker på webstedet lige nu. Returnerer live_visitors (besøgende inden for de seneste 5 minutter), window_minutes (30), sparkline (besøg pr. minut for de seneste 30 minutter, ældste først, hver {minute, visits}), feed (den seneste aktivitet), top_pages, top_referrers, top_countries (hver op til 8 rækker af {value, visits}) og top_events (op til 8 af {value, completions}) for de seneste 30 minutter. feed-poster har occurred_at, kind, name, path, channel, referrer_host, country, device og browser. De er anonyme, uden IP, by eller besøgsspor. feed viser som standard alle hits eller kun sidevisninger eller hændelser, med limit poster (standard 50, op til bufferens størrelse på 100). Tallene caches ikke og tager ingen periode. Send filters (samme format som i stats_aggregate) for at begrænse alle tal og feedet til de matchende hits. Brug live_wallboard til en kompakt visning af flere websteder og stats_overview til en hel periode.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/live.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/live/wallboard.json Wallboard-kort (live og i dag) for ét eller flere websteder live_wallboard

Kompakte kort med store tal for ét eller flere websteder, bygget til en kontorskærm. Returnerer rotate_seconds, generated_at og sites. Hvert webstedskort har id (pa_...), name, domain, live_visitors (seneste 5 minutter), sparkline (pr. minut, seneste 30 minutter), visitors_today, pageviews_today, bounce_rate_today (procent, 0 til 100), top_pages, top_countries og top_referrers (5 rækker hver). I dag betyder webstedets egen tidszone, og tallene læses fra live-data. site_ids viser de websteder, der skal medtages (op til 12, kun websteder, dit token kan åbne), ellers bruges webstedet i stien. rotate_seconds begrænses til mellem 5 og 300 og fortæller kun en skærm, hvor længe hvert kort skal vises. Til en delbar offentlig skærm, brug wallboard_links_create. Brug live_get til den fulde live-visning af ét websted.

Tilladelse: analytics.read

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

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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

Medlemmer

POST /workspaces/:workspace_id/invitations.json Inviter personer via e-mail invitations_create

Inviterer en eller flere personer til et arbejdsområde via e-mail og sender hver en invitationsmail med et link, der er gyldigt i 14 dage. emails er en liste af op til 50 adresser (en streng adskilt af komma, mellemrum eller semikolon virker også i appens formular), og adresser, der allerede er medlemmer, springes over, men det er en fejl, hvis alle er medlemmer. Hvis du inviterer en adresse, der allerede har en afventende invitation, erstattes den invitation, og der sendes en ny e-mail. role er en af rollerne i members_list (standard viewer, owner kan ikke inviteres). Brug rollen custom sammen med custom_role_id (id'et fra roles_list, Business-abonnement). Som standard dækker adgangen alle websteder, også fremtidige. For at begrænse adgangen, sæt all_sites til false og angiv site_ids som offentlige websteds-id'er (pa_...). Afventende invitationer tæller med i abonnementets medlemsgrænse (Free tillader 3 medlemmer), og kaldet fejler, hvis grænsen ville blive overskredet. Invitationsmails er hastighedsbegrænsede. Du kan ikke give en rolle med flere rettigheder eller websteder end dine egne. Kræver members.manage. Returnerer de oprettede invitationer (se invitations_list for felterne).

Tilladelse: members.manage · Kun HTTP (ikke et MCP-værktøj)

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 Tilbagekald en afventende invitation invitations_delete

Tilbagekalder en afventende invitation, så dens link ikke længere virker, og frigør den plads, den holdt. Sletningen kan ikke fortrydes, inviter personen igen med invitations_create. Tag id'et (et uuid) fra invitations_list. En kalder begrænset til nogle websteder kan kun tilbagekalde invitationer, der ikke giver adgang til flere websteder end deres egne. Kræver members.manage. Returnerer den tilbagekaldte invitation.

Tilladelse: members.manage · Kun HTTP (ikke et MCP-værktøj)

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 Vis afventende invitationer invitations_list

Viser et arbejdsområdes afventende teaminvitationer, nyeste først og med sideinddeling. Accepterede og tilbagekaldte invitationer vises ikke (brug members_list til personer, der er kommet med), og udløbne bliver, indtil de erstattes eller tilbagekaldes. Kræver members.manage. En kalder begrænset til nogle websteder ser kun invitationer inden for deres rækkevidde. Hvert element har id (uuid, bruges af invitations_delete), email, role, custom_role (den brugerdefinerede rolles navn, når role er custom, ellers null), all_sites, site_ids (offentlige websteds-id'er pa_..., tomt når all_sites er true), invited_by (afsenderens e-mail), expires_at og created_at.

Tilladelse: 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 forlad arbejdsområdet) members_delete

Fjerner et medlem fra et arbejdsområde eller lader kalderen forlade det, når id'et er kalderens eget medlemskab. Det sker med det samme og kan ikke fortrydes, personen mister adgangen, deres API-tokens til dette arbejdsområde tilbagekaldes, og et eventuelt SCIM-link fjernes. Deres noter og tidligere revisionsposter bliver. Ejeren kan ikke fjernes eller forlade det, overfør først ejerskabet med ownership_transfers_create. For at fjerne en anden kræves members.manage, og du kan ikke fjerne en person med flere rettigheder eller websteder, end du har. Hvis du forlader det, kræves ingen rettighed, men et token, der er begrænset i rettigheder eller websteder, kan ikke bruges til at forlade. Personen kan inviteres igen senere med invitations_create. Tag id'et (medlemskabets uuid) fra members_list. Returnerer det fjernede medlem.

Tilladelse: member · Kun HTTP (ikke et MCP-værktøj)

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 Vis medlemmer af arbejdsområdet members_list

Viser et arbejdsområdes medlemmer i den rækkefølge, de kom med, med sideinddeling. Brug query til at søge efter navn eller e-mail (delvist, uden forskel på store og små bogstaver) og role til at filtrere efter rolle. Afventende invitationer er ikke med (brug invitations_list). Hvert medlem har id (medlemskabets uuid, bruges af members_update, members_delete og ownership_transfers_create), email, name (kan være null), role, custom_role (navn, null medmindre role er custom), custom_role_id, all_sites, include_future_sites, site_ids (offentlige websteds-id'er pa_..., tomt når all_sites er true), two_factor (om medlemmet har en godkendelsesapp eller en adgangsnøgle), last_active_at (kan være null) og created_at. Kaldere begrænset til nogle websteder ser kun medlemmer inden for deres rækkevidde.

Tilladelse: member

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/members.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/members/:id.json Ændr et medlems rolle eller adgang til websteder members_update

Ændrer et medlems rolle og/eller webstedsadgang i et arbejdsområde. Kun de inputs, du sender, ændres. For at ændre rollen send role (admin, editor, analyst, viewer eller billing, og custom med custom_role_id fra roles_list på Business-abonnementet). Ejerens rolle kan ikke ændres her, brug i stedet ownership_transfers_create, og du kan ikke redigere dit eget medlemskab eller en, der har højere rang end dig. For at begrænse websteder send all_sites false sammen med site_ids (offentlige websteds-id'er pa_...), og tilføj include_future_sites true for også at give adgang til websteder oprettet senere. Send all_sites true for at give adgang til alle websteder. En site_ids-liste sendt uden all_sites false er en fejl for et medlem, der aktuelt har alle websteder. Du kan ikke give flere rettigheder eller websteder, end du selv har. Kræver members.manage. Tag id'et fra members_list. Returnerer det opdaterede medlem.

Tilladelse: members.manage · Kun HTTP (ikke et MCP-værktøj)

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 Overdrag ejerskabet af arbejdsområdet til et andet medlem (kun ejeren, du bliver administrator) ownership_transfers_create

Overfører ejerskabet af et arbejdsområde til et andet medlem og nedgraderer kalderen til admin, hvilket er svært at fortryde, fordi kun den nye ejer kan overføre det tilbage. Kun den nuværende ejer kan kalde den, og et token må ikke være begrænset til bestemte websteder eller rettigheder. membership_id er den nye ejers medlemskabs-uuid fra members_list (ikke et bruger-id eller en e-mail), og personen skal allerede være medlem, inviter dem først, hvis de ikke er det. Den nye ejer får rollen owner med adgang til alle websteder, og rollen owner kan ikke gives via members_update. Et Free-arbejdsområde kan ikke gives til en, der allerede ejer et andet Free-arbejdsområde. Faktureringen bliver hos arbejdsområdet. Et token, der kalder dette, skal have members.manage. Returnerer den nye ejers medlemspost.

Tilladelse: member · Kun HTTP (ikke et MCP-værktøj)

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

Migreringer af udtalelser

POST /sites/:site_id/testimonials/imports/migrations/:id/discard.json Kassér det, en migrering læste testimonial_migrations_discard

Angiv item_ids (id'er fra testimonial_migrations_review) eller all true for alt, der stadig venter, aldrig begge. En kasseret post forlader gennemgangstrinnet, og det, der blev læst om personen, slettes. Ingen udtalelse slettes. Serveren responderer ellers med 422 og koden selection eller unknown_ids.

Tilladelse: 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 et steds migreringer testimonial_migrations_list

Nyeste først. En migrering er én eksportfil fra et andet værktøj til udtalelser. Hver har det værktøj, den kom fra, sin status og hvor mange udtalelser der blev fundet, beholdt, dubletter og mislykkede.

Tilladelse: 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 migrering læste, som udtalelser testimonial_migrations_keep

Angiv item_ids (op til 100 pr. kald, fra testimonial_migrations_review) eller all true, aldrig begge. Hver beholdt post bliver en udtalelse med status pending eller approved, og keep_approval true beholder den godkendelse, den havde i det andet værktøj. Med all udelades sandsynlige dubletter, medmindre include_likely_duplicates er true. Intet beholdt tæller med i de månedlige udtalelser. Det, der ikke beholdes, bliver i gennemgangstrinnet i 30 dage.

Tilladelse: 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 migrering læste, og som endnu ikke er afgjort testimonial_migrations_review

Lister de poster, der stadig venter på en beslutning, nyeste kørsel først. show er new, duplicates eller all (standard), og rating beholder kun de angivne stjernevurderinger. Giv post-id'erne videre til testimonial_migrations_keep eller testimonial_migrations_discard.

Tilladelse: 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 en migrerings fremdrift og antal testimonial_migrations_get

Returnerer det værktøj, filen kom fra, status, hvor mange udtalelser der blev fundet, beholdt, dubletter og mislykkede, hvor mange mediefiler den medbringer, og hvornår den startede og sluttede. Poll den, mens status siger, at filen stadig læses.

Tilladelse: analytics.read

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

Mobilapp

GET /workspaces/:workspace_id/app.json Hent det, mobilappen har brug for for at åbne et workspace mobile_bootstraps_get

Returnerer for ét workspace (path tager workspace_id) den rolle og de tilladelser, den, der kalder, har dér, features (hvilke afgrænsede rapporter planen indeholder: traffic_quality, bot_detection, external_experiments, campaign_costs, status_pages, traffic_rules, experiment_advanced (de avancerede indstillinger for et eksperiment) og survey_ai_themes (temaer for de skrevne svar i en undersøgelse) som true eller false, og retention_months som et antal måneder eller null for ingen grænse), sites_count (de sites, den, der kalder, kan åbne) og min_app_version (den ældste version af mobilappen, som API'et stadig betjener). Mobilappen læser det én gang, når den åbner et workspace, så den kan vise en rapport, som planen ikke har, som ikke inkluderet i stedet for at bede om den. Kræver analytics.read.

Tilladelse: analytics.read · Kun HTTP (ikke et MCP-værktøj)

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

Fjerner push-registreringen for det mobilapp-login, der kalder, så enheden ikke får flere push. Selve loginet bevares, og appen kan registrere sig igen. Hvis du logger ud (POST /oauth/revoke med refresh-tokenet), fjernes den også. Kun et token fra mobilappen kan kalde det.

Tilladelse: member · Kun HTTP (ikke et MCP-værktøj)

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 mobilappens push-registrering mobile_devices_get

Returnerer enheden for det mobilapp-login, der kalder: registered (false indtil appen har registreret et push-token), platform, locale, timezone, app_version, kinds (alle slags push, der findes), muted_kinds og muted_site_ids (det, personen har slået fra). Kun et token fra mobilappen kan kalde det.

Tilladelse: member · Kun HTTP (ikke et MCP-værktøj)

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

Registrerer enheden for det mobilapp-login, der kalder, til push-notifikationer, eller ændrer, hvad den modtager. Kun de felter, du sender, ændres. Det første kald kræver platform og push_token. En enhed får en push for uptime (et tjek gik ned eller kom op igen), alert (en alarm blev udløst eller løst), site_audit (en site-audit blev færdig), experiment (et eksperiment har et resultat eller blev afsluttet) og usage (den månedlige kvote er næsten eller helt brugt), for hvert site, dens medlem kan åbne, på alle planer. muted_kinds og muted_site_ids slår slags og sites fra, og hver erstatter hele sin liste. Hvis du registrerer et push-token, som et andet login i appen har, flyttes det til dette. Kun et token fra mobilappen kan kalde det. Det er en af de to skrivninger, sådan et token må foretage.

Tilladelse: member · Kun HTTP (ikke et MCP-værktøj)

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

Modtagere af anmodninger om udtalelser

POST /sites/:site_id/testimonials/requests/:request_id/recipients.json Tilføj personer til en anmodning testimonial_request_recipients_create

Op til 500 i ét kald. Tilføjet til en kladde venter de på testimonial_requests_send. Tilføjet til en kørende anmodning får de deres første e-mail med det samme. Svaret fortæller, hvor mange der blev stillet i kø, og hvor mange der blev sprunget over, efter årsag. At tilføje til en kørende anmodning sender e-mails til personer uden for arbejdsområdet, så medlemmet får besked på e-mail.

Tilladelse: 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 udvalgte personer fra en anmodning testimonial_request_recipients_delete

Kun personer, som intet blev sendt til (queued eller skipped). Tager op til 100 adresser i brødteksten. Over MCP ændrer værktøjet intet og responderer med den side i appen, hvor en person gør det.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Tilføj personer til en anmodning fra en CSV-fil testimonial_request_recipients_import

To kald. Send filen (eller dens tekst som csv) for at få kolonnerne, deres første rækker og en upload_token. Send derefter tilknytningen fra kolonnenummer til felt. Op til 5 MB og 10.000 rækker. At tilføje til en kørende anmodning sender e-mails til personer uden for arbejdsområdet, så medlemmet får besked på e-mail.

Tilladelse: 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 en anmodnings personer testimonial_request_recipients_list

Filtrér efter, hvor en person står nu: status opened er "åbnede og klikkede eller svarede ikke". E-mailadressen er null, medmindre den kaldende må redigere indhold.

Tilladelse: 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 Genoptag udvalgte personer i en anmodning testimonial_request_recipients_resume

De fortsætter, hvor de stoppede. Tager op til 100 adresser i brødteksten. Dette sender e-mails til personer uden for arbejdsområdet, så medlemmet får besked på e-mail.

Tilladelse: 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 Stop udvalgte personer i en anmodning testimonial_request_recipients_stop

De får ikke flere e-mails. Hver beholder sin status og får "stopped". Tager op til 100 adresser i brødteksten.

Tilladelse: 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 Arkivér et mål (skjult i rapporter) goals_archive

Arkiverer et mål. Et arkiveret mål er skjult i rapporter, tæller ikke med i abonnementets målgrænse og beholder sin definition, så det kan genoprettes senere med goals_unarchive. Ingen data slettes. Returnerer målet med archived true og archived_at sat. Hvis du arkiverer et allerede arkiveret mål, sker der ingenting. Brug goals_delete til at fjerne det for altid. Kræver rettigheden content.write.

Tilladelse: 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 Opret et mål goals_create

Opretter et konverteringsmål. Mål er definitioner, der anvendes, når rapporter læses, så et nyt mål straks tæller matchende hændelser i al eksisterende historik. Påkrævet er name og kind. kind afgør, hvilke andre inputs der gælder. page kræver pattern (en sti, fx /thank-you, med match_type exact, prefix, glob eller regex) og kan bruge hostname. event kræver event_name og kan bruge conditions (egenskabstests som {key: plan, operator: is, value: pro}, alle skal matche, operatorer is, is_not, contains, gt, lt). engagement kræver pattern samt scroll_threshold (procent 1 til 100) og/eller time_threshold_seconds (opnået, når en af dem er opfyldt). outbound matcher linkets domæne med pattern (fx stripe.com) og download matcher filen med pattern (fx *.pdf). value_mode er none (standard), fixed (bruger fixed_value, et decimalbeløb i webstedets valuta som 49.5, gemt som fixed_value_minor i cent) eller revenue (hændelsens egen omsætning). count_mode er once_per_visit (standard) eller every. Free-arbejdsområder tillader 10 aktive mål pr. websted, betalte abonnementer er ubegrænsede. Returnerer målet med id (goal_...). Kræver rettigheden content.write.

Tilladelse: 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 Slet et mål (data beholdes) goals_delete

Sletter en måldefinition permanent. Ingen hændelsesdata slettes, men målet forsvinder fra rapporter, og tragttrin, rejser og eksperimenter, der peger på det, holder op med at virke. Der er ingen fortryd. Brug goals_archive for at skjule et mål og beholde det. Returnerer det slettede mål. Id'er (goal_...) kommer fra goals_list. Kræver rettigheden content.write.

Tilladelse: 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 Kopiér et mål goals_duplicate

Kopierer et måls definition til et nyt aktivt mål. Kopien hedder name, hvis du sender den, ellers det oprindelige navn efterfulgt af (copy). Den tæller med i abonnementets målgrænse (10 aktive mål pr. websted på Free). Returnerer det nye mål med et nyt id. Brug den til at starte en variation af et mål og ændr det derefter med goals_update. Kræver rettigheden content.write.

Tilladelse: 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 Vis mål med gennemførelser, konverteringer, rate og værdi for en periode goals_list

Viser et websteds mål med deres resultater for perioden. Hvert mål er definitionen (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) plus stats {completions, conversions, conversion_rate, value, change}. conversion_rate er en procent (0 til 100), value er i mindste enhed (cent), og change er den procentvise ændring i konverteringer i forhold til den foregående periode (null, når det tidligere antal var 0). status filtrerer til active (standard), archived eller all. Med sideinddeling via page og per_page (maks. 100, standard 25). Brug goals_get til den fulde rapport for ét mål. Tager de fælles inputs period, compare og filters.

Tilladelse: 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, opdelinger og vejen til konvertering goals_get

Ét mål i dybden for en periode. Returnerer period, goal_id, goal (definitionen), metrics, interval, series, breakdowns, journey og, med compare, comparison_period, comparison og change. metrics har completions (hver matchende hændelse), conversions (besøg med mindst én gennemførelse), conversion_rate (procent fra 0 til 100) og value (mindste enhed, cent). conversion_rate divideres med besøg eller med besøgende, når webstedet er sat op sådan. series er en liste af {date, completions, conversions, conversion_rate} pr. tidsinterval (sæt interval for at ændre det). breakdowns indeholder de 10 øverste efter 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 sider set før konvertering, med visits og share). Brug goals_list til alle mål på én gang og funnels_get til forløb i flere trin. Tager de fælles inputs period, compare, filters og segment.

Tilladelse: 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 Gendan et arkiveret mål goals_unarchive

Genopretter et arkiveret mål, så det vises i rapporter igen. Det tæller igen med i abonnementets målgrænse (10 aktive mål pr. websted på Free), så kaldet fejler med en abonnementsgrænsefejl, når webstedet allerede er fuldt. Hvis du genopretter et mål, der ikke er arkiveret, sker der ingenting. Returnerer målet med archived false. Id'er kommer fra goals_list med status archived. Kræver rettigheden content.write.

Tilladelse: 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 Opdatér et mål goals_update

Ændrer et måls definition. Kun de inputs, du sender, ændres. Den nye definition gælder for al historik med det samme, så tidligere konverteringstal ændres. Inputs er de samme som i goals_create, og de samme kombinationer gælder, fx betyder event_name og conditions kun noget for hændelsesmål, og scroll_threshold og time_threshold_seconds kun for engagementsmål. fixed_value er et decimalbeløb i webstedets valuta (gemt i cent). Hvis du sender conditions, erstattes alle eksisterende betingelser. Returnerer målet. Id'er kommer fra goals_list. Kræver rettigheden content.write.

Tilladelse: 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 '{…}'

Noter

POST /sites/:site_id/notes.json Tilføj en note til et websted (brug kilden "deploy" til webhooks for udgivelser) notes_create

Tilføjer en annotation til ét websteds diagrammer, fx en lancering, en kampagne eller en udgivelse. Brug i stedet workspace_notes_create til en note, der vises på alle websteder. date er som standard i dag i webstedets tidszone, og end_date markerer et tidsrum (YYYY-MM-DD). title vises på diagrammet, body er ren tekst, og url kan pege på en PR eller en changelog. color er en af neutral, brand, blue, amber, red eller violet, standard neutral. source er som standard manual. Deploy-integrationer sender source deploy, og så er title som standard en tekst bygget af version (en udgivelsesversion eller commit), og color er som standard blue. Kræver content.write. Returnerer den oprettede note (se notes_list for felterne).

Tilladelse: 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 Slet en note notes_delete

Sletter en webstedsnote permanent, som forsvinder fra diagrammerne og ikke kan gendannes. Noten skal tilhøre dette websted, noter for hele arbejdsområdet slettes med workspace_notes_delete. Tag id'et (note_...) fra notes_list. Kræver content.write. Returnerer den slettede note.

Tilladelse: 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 Vis noter for et websted (inklusive noter for hele arbejdsområdet) notes_list

Viser de annotationer (noter), der vises på et websteds diagrammer, nyeste dato først og med sideinddeling. Den returnerer webstedets egne noter plus noter for hele arbejdsområdet, der gælder alle websteder. Filtrér med from og to (YYYY-MM-DD, en note matcher, når dens dato ligger i intervallet), source (manual, deploy, system, import eller incident) og query (en søgning uden forskel på store og små bogstaver i title, body og url). Brug workspace_notes_list til arbejdsområdets visning på tværs af alle websteder. Hver note har id (note_...), site_id (det offentlige websteds-id pa_..., null for en note for hele arbejdsområdet), date, end_date (null for en enkelt dag), title, body (ren tekst, kan være null), url (kan være null), color (neutral, brand, blue, amber, red eller violet), source og created_at. Kræver analytics.read.

Tilladelse: 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 en note notes_get

Returnerer én note via dens id (note_..., fra notes_list) for et websted, inklusive noter for hele arbejdsområdet, der gælder for webstedet. En note er en dateret annotation vist på diagrammer, fx en lancering, en kampagne eller en deploy. Felterne er id, site_id (null, når den gælder hele arbejdsområdet), date og end_date (YYYY-MM-DD, end_date er null for en 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. Kræver analytics.read.

Tilladelse: 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 Redigér en note notes_update

Redigerer en webstedsnote og ændrer kun de felter, du sender (date, end_date, title, body, url, color). source kan ikke ændres. Hvis du sender en tom url, fjernes linket, og en date med null ignoreres. Noten skal tilhøre dette websted, noter for hele arbejdsområdet redigeres med workspace_notes_update. Tag id'et (note_...) fra notes_list. Kræver content.write. Returnerer den opdaterede note.

Tilladelse: 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 Tilføj en note for hele arbejdsområdet (vises på alle websteder) workspace_notes_create

Tilføjer en annotation for hele arbejdsområdet, der vises på diagrammerne for alle websteder i arbejdsområdet, fx en lancering for hele virksomheden eller et nedbrud. Den oprettes uden websted (site_id er null). Brug notes_create til en note på ét websted. date er som standard i dag i arbejdsområdets tidszone, end_date markerer et tidsrum (YYYY-MM-DD), color er en af neutral, brand, blue, amber, red eller violet. Kræver content.write, og en kalder begrænset til nogle websteder kan ikke oprette noter for hele arbejdsområdet. Returnerer den oprettede note.

Tilladelse: 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 Slet en note for arbejdsområdet workspace_notes_delete

Sletter en note for hele arbejdsområdet permanent, så den forsvinder fra alle websteders diagrammer, og den kan ikke gendannes. Kun noter uden websted kan slettes her, brug notes_delete til en webstedsnote. Tag id'et (note_...) fra workspace_notes_list. Kræver content.write, og en kalder begrænset til nogle websteder kan ikke slette noter for hele arbejdsområdet. Returnerer den slettede note.

Tilladelse: 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 Vis noter på tværs af et arbejdsområde workspace_notes_list

Viser annotationerne på tværs af et arbejdsområde, nyeste dato først og med sideinddeling. Den returnerer noter for hele arbejdsområdet (som vises på alle websteder) plus noterne for hvert websted, kalderen kan tilgå, så tjek site_id på hvert element (null betyder hele arbejdsområdet). Brug notes_list til ét websted. Filtrér med from og to (YYYY-MM-DD), source (manual, deploy, system, import eller incident) og query (søger i title, body og url). Felterne er id (note_...), site_id, date, end_date, title, body, url, color (neutral, brand, blue, amber, red eller violet), source og created_at. Kræver analytics.read.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/notes.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/notes/:id.json Redigér en note for arbejdsområdet workspace_notes_update

Redigerer en note for hele arbejdsområdet og ændrer kun de felter, du sender (date, end_date, title, body, url, color). Kun noter uden websted kan redigeres her, brug notes_update til en webstedsnote. Tag id'et (note_...) fra workspace_notes_list. Kræver content.write, og en kalder begrænset til nogle websteder kan ikke redigere noter for hele arbejdsområdet. Returnerer den opdaterede note.

Tilladelse: 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 '{…}'

Notifikationskanaler

DELETE /channels/:id.json Slet en notifikationskanal notification_channels_delete

Sletter en notifikationskanal og fjerner den fra alle advarsler, der brugte den, så de advarsler holder op med at give besked dér. Det kan ikke fortrydes, og selve advarslerne bevares. Id'et (nch_...) kommer fra notification_channels_list. Returnerer den slettede kanal.

Tilladelse: 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 Vis notifikationskanaler notification_channels_list

Viser et arbejdsområdes notifikationskanaler (stien tager workspace_id), sorteret efter navn og med sideinddeling. En kanal er et sted, advarsler leveres til. Hver har id (nch_...), kind (email, slack, teams, discord, webhook, pagerduty, opsgenie eller push), name, target (en maskeret oversigt som e-mailadresserne eller enden af en webhook-URL, hemmeligheder returneres aldrig), last_used_at og created_at. Filtrér efter kind. Brug id'erne som channel_ids i alerts_create og alerts_update. Kaldere begrænset til nogle websteder ser kun kanaler, der bruges af advarsler på deres websteder.

Tilladelse: 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 testbesked gennem en kanal notification_channels_send_test

Sender en rigtig testbesked gennem kanalen (en e-mail, et chatindlæg, et webhook-kald og så videre), så brug den kun, når brugeren ønsker det. Kaldet fejler med en fejl, der nævner årsagen, hvis leveringen ikke virker, ellers returnerer det kanalen. Testafsendelser er hastighedsbegrænsede pr. arbejdsområde, og e-mailkanaler også pr. ekstern adresse. Brug den efter notification_channels_create eller notification_channels_update for at bekræfte, at en URL eller nøgle er rigtig.

Tilladelse: 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 notifikationskanal notification_channels_get

Returnerer én notifikationskanal via id (nch_..., fra notification_channels_list). Svaret har kind, name, target (en maskeret oversigt, hemmeligheder som webhook-URL'er og nøgler returneres aldrig), last_used_at og created_at. Brug notification_channels_send_test til at tjekke, at den leverer.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/channels/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /notifications/unsubscribe/:token.json Afmeld en adresse fra én alarmkanal eller ét oppetidstjek med tokenet fra en e-mail notification_unsubscribes_create

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/notifications/unsubscribe/:token.json \
  -H "Content-Type: application/json" -d '{…}'
POST /push_subscription.json Registrér en browser til push-notifikationer push_subscriptions_create

Registrerer den nuværende browser til web push-advarsler ved hjælp af de tre værdier fra browserens PushSubscription (endpoint, p256dh og auth). Et abonnement modtager advarsler fra alle arbejdsområder, medlemmet tilhører, for alle websteder, og derfor må et API-token kun bruge den, når det kan læse hele sit arbejdsområde, og medlemmet ikke har andre arbejdsområder. Hvis du kalder den igen med det samme endpoint, opdateres nøglerne, og abonnementet flyttes til kalderen. Endpointet skal være en offentlig https-URL til en push-tjeneste. Det registrerer kun browseren, så advarsler kræver stadig en notifikationskanal af typen push (notification_channels_create). Returnerer endpoint_host (push-tjenestens værtsnavn, ikke hele endpointet) og created_at. Sessioner åbnet via et arbejdsområdes identitetsudbyder kan ikke bruge den.

Tilladelse: 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 browsers push-registrering push_subscriptions_delete

Fjerner en af det loggede medlems browserregistreringer til push, så den browser holder op med at modtage advarselsnotifikationer. Angiv det samme endpoint, som blev brugt med push_subscriptions_create. Fejler med ikke fundet, når der ikke findes noget sådant abonnement for medlemmet. Returnerer det fjernede abonnement som endpoint_host og created_at. Den sletter ingen notifikationskanal. Underlagt de samme tokenbegrænsninger som push_subscriptions_create.

Tilladelse: member

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

Omtaler i udtalelser

GET /sites/:site_id/testimonials/mentions.json List de ord og fraser, der går igen på tværs af et steds udtalelser testimonial_mentions_list

Hvert udtryk kommer med, hvor mange udtalelser der indeholder det, dets andel, den gennemsnitlige vurdering af dem og de seneste 90 dage mod de 90 før. Sortér efter rating_asc for at læse, hvad folk klager over, eller efter rising for det, der er nyt. meta.refreshed_at fortæller, hvornår udtrykkene sidst blev genopbygget. Giv et udtryk til testimonials_list som mention for at læse udtalelserne.

Tilladelse: 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 Tag hver udtalelse, der nævner et ord eller en frase testimonial_mentions_tag

Én massehandling på hele resultatet, med fortryd. Udtrykket er ethvert ord eller en frase på to ord, matchet med stemming, som Omtaler tælles. Et tag, der navngives for første gang, oprettes. Responderer med et undo-id, som testimonials_bulk_undo accepterer i 7 dage. Mere end 100 kører i baggrunden.

Tilladelse: 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 udtryk, der kun er støj, eller vis det igen testimonial_mentions_update

Et skjult udtryk forlader Omtaler-listen og indbakkens Omtaler-facet og forbliver skjult, når udtrykkene genopbygges.

Tilladelse: 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 Tilføj en oppetidskontrol for et websted uptime_checks_create

Tilføjer en oppetidskontrol knyttet til ét websted. Brug workspace_uptime_checks_create til en kontrol, der ikke hører til noget websted. kind afgør målet. http tjekker statuskoden for url, keyword tjekker, at svarets body fra url indeholder keyword, tcp forbinder til host og port, og dns tjekker, at host kan opløses. Felter til andre typer ignoreres. url er som standard webstedets forside for http-kontroller. expected_status (100 til 599, standard 200), http_method (GET eller HEAD) og timeout_seconds (1 til 30, standard 20) gælder for http- og keyword-kontroller. interval_seconds er tiden mellem prober, den skal være mindst abonnementets minimum (Free 300, Pro 60, Business 30) og er som standard 300 eller minimummet, hvis det er højere. public true lader kontrollen vises på en statusside. Private og interne adresser afvises, og abonnementet begrænser antallet af kontroller pr. arbejdsområde (Free 3, Pro 20, Business 100). Den første probe kører inden for få øjeblikke, status starter som pending. Kræver rettigheden uptime.manage. Returnerer kontrollen med id (upc_...).

Tilladelse: 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 Slet en oppetidskontrol og dens historik uptime_checks_delete

Sletter en oppetidskontrol permanent med dens resultater og hændelseshistorik og fjerner den fra enhver statusside, der viser den. Det kan ikke fortrydes. Brug uptime_checks_pause til at stoppe probning, men beholde historikken. Id'et kommer fra uptime_checks_list. Kræver rettigheden uptime.manage. Returnerer den slettede kontrol.

Tilladelse: 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 Vis et websteds oppetidskontroller uptime_checks_list

Viser ét websteds oppetidskontroller, inklusive kontroller for hele arbejdsområdet, der prober webstedets domæne eller et underdomæne af det. Sorteret efter navn. Brug workspace_uptime_checks_list til alle kontroller i arbejdsområdet. Filtrér med status (up, down, pending eller paused) eller query (en del af name, url eller host). Med sideinddeling via page og per_page (op til 100). Hver kontrol har id (upc_...), workspace_id, site_id (null for kontroller for hele arbejdsområ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. Brug uptime_checks_get til oppetidsprocenter og hændelser.

Tilladelse: analytics.read

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

Sætter en oppetidskontrol på pause, så den ikke længere probes. Enhver åben hændelse lukkes med det samme, og der sendes ingen ned- eller op-advarsler, mens den er på pause. Historikken bevares, og dens status vises som paused. Genoptag den med uptime_checks_resume. Id'et kommer fra uptime_checks_list. Kræver rettigheden uptime.manage. Returnerer kontrollen.

Tilladelse: 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 Genoptag en pauset oppetidskontrol uptime_checks_resume

Genoptager en oppetidskontrol på pause. Den probes ved næste planlægningstik, og dens status er pending, indtil det første resultat kommer. Id'et kommer fra uptime_checks_list. Kræver rettigheden uptime.manage. Returnerer kontrollen.

Tilladelse: 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 oppetidskontrol: oppetid 24 t/7 d/30 d, svartider og hændelser uptime_checks_get

Returnerer én oppetidskontrol med dens historik, ikke kun dens indstillinger. Vælg range (24h standard, 7d eller 30d) til diagrammet over svartider. Svaret har check (indstillinger og live-tilstand, se uptime_checks_list), uptime (procent for 24h, 7d og 30d, null, indtil den første probe er kørt), range, response_times (enheden hour eller day, labels som ISO 8601-tidspunkter og series med gennemsnitlig svartid i millisekunder pr. placering, med null for huller) og incidents (de 50 seneste med started_at, resolved_at null, mens den stadig er åben, duration_seconds, cause og failed_locations). Kun vellykkede prober tæller med i svartider. Id'et kommer fra uptime_checks_list.

Tilladelse: analytics.read

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

Ændrer en oppetidskontrol. Kun de inputs, du sender, ændres. Regler og grænser er de samme som i uptime_checks_create (intervallet skal være mindst abonnementets minimum, private adresser afvises). Hvis du ændrer kind, ryddes de målfelter, der ikke længere gælder. Hvis du ændrer interval_seconds, planlægges den næste probe med det samme. Id'et kommer fra uptime_checks_list. Kræver rettigheden uptime.manage. Returnerer den opdaterede kontrol.

Tilladelse: 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 Datacenter, User-Agent og IP-områder for udgående trafik fra probes (til tilladelseslister for vores oppetidsprobes) uptime_probes_list

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl https://privatusanalytics.com/uptime/probes.json
POST /uptime/probes/results.json Indsend resultater fra en ekstern probe-agent (Bearer-token til oppetidsprobe) uptime_probes_results

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/uptime/probes/results.json \
  -H "Content-Type: application/json" -d '{…}'
POST /workspaces/:workspace_id/uptime.json Tilføj en oppetidskontrol for arbejdsområdet (ikke knyttet til et websted) workspace_uptime_checks_create

Tilføjer en oppetidskontrol, der hører til hele arbejdsområdet i stedet for ét websted. Brug uptime_checks_create til at knytte en kontrol til et websted. Inputs, abonnementsgrænser og regler er de samme, se uptime_checks_create. kind er http, keyword, tcp eller dns og afgør, hvilke af url, keyword, host og port der gælder. Da der ikke er noget websted, kræver en http-kontrol en eksplicit url. Kaldere begrænset til nogle websteder kan ikke oprette kontroller for hele arbejdsområdet. Kræver workspace_id fra workspaces_list og rettigheden uptime.manage. Returnerer kontrollen med id (upc_...) og site_id null.

Tilladelse: 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 Vis alle oppetidskontroller i et arbejdsområde workspace_uptime_checks_list

Viser alle oppetidskontroller i et arbejdsområde, inklusive kontroller uden tilknytning til et websted, sorteret efter navn. En kalder begrænset til nogle websteder ser kun kontroller for de websteder. Brug uptime_checks_list til ét websteds kontroller. Filtrér med status (up, down, pending eller paused) eller query (en del af name, url eller host). Med sideinddeling via page og per_page (op til 100). Hvert element har de felter, der er beskrevet i uptime_checks_list. Kræver workspace_id fra workspaces_list.

Tilladelse: analytics.read

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

Oversættelser af udtalelser

POST /sites/:site_id/testimonials/translations.json Oversæt udtalelser til de sprog, et sted tilbyder testimonial_translations_create

Kald først testimonial_translations_estimate. Dette sender brødtekst, titel og fremhævelse for de valgte udtalelser til Google Cloud Translation (aldrig et navn, en e-mail eller en virksomhed), og medlemmet får en e-mail om, at en assistent startede det. Oversættelsen sker i baggrunden, og en række, der allerede er gemt, hentes aldrig igen. Ved månedens tegnkvote gemmes resten som ventende og fortsætter den 1. Responderer med 402 plan_limit under Business og med 422 not_configured, mens oversættelse ikke er sat op.

Tilladelse: 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 gemt oversættelse testimonial_translations_delete

Udtalelsen vises i sine egne ord igen, hvor det sprog end blev brugt. Tegn, der allerede er brugt på den, gives ikke tilbage. Virker på enhver plan. Over MCP ændrer værktøjet intet og responderer med den side i appen, hvor en person gør det.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Tæl de tegn, en oversættelseskørsel ville sende, før den køres testimonial_translations_estimate

Sig hvilke udtalelser på én måde: testimonial_ids, collection_id eller all_approved. Svaret giver udtalelserne, de tegn, der ville blive sendt, de tegn, der allerede er gemt, og hvad der er tilbage af måneden. Det angiver tegn, aldrig en pris. Intet hentes.

Tilladelse: 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 et steds gemte oversættelser testimonial_translations_list

Én række pr. udtalelse og sprog, senest ændret først, 25 pr. side. Filtrér efter language, state, origin eller testimonial_id. Virker på enhver plan, så oversættelser lavet før en nedgradering stadig kan læses.

Tilladelse: 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 ret én oversættelse i hånden testimonial_translations_update

Rækken markeres som redigeret, og en senere kørsel overskriver den ikke, medmindre overwrite_edited sendes. Intet hentes, og intet tæller med i kvoten. Originalen ændres aldrig. Business og op (402 plan_limit andre steder).

Tilladelse: 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 til udtalelser

DELETE /sites/:site_id/testimonials/trash/permanent.json Slet op til 100 poster i papirkurven for altid testimonial_trash_delete_permanently

Dette kan ikke fortrydes. confirm er postens navn (personens navn for en udtalelse) eller dens id for én post og stedets navn for flere. Kun poster i papirkurven accepteres.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 Slet alt i papirkurven for altid testimonial_trash_empty

Dette kan ikke fortrydes. confirm er stedets navn. Op til 100 poster slettes ad gangen. En større papirkurv tømmes i baggrunden, og svaret har state running.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 det, der er i papirkurven, én slags ad gangen testimonial_trash_list

Responderer med posterne af én slags (testimonial som standard) og i meta.counts, hvor mange af hver slags der er i papirkurven. Hver post fortæller, hvad den vender tilbage til, hvad der viste den, hvem der slettede den, og hvornår den forlader papirkurven.

Tilladelse: 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 Gendan op til 100 poster fra papirkurven, præcis som de var testimonial_trash_restore

Id'erne skal være af én slags. At gendanne udtalelser responderer med et undo-id (data.id og meta.undo_id), som testimonial_undo_records_undo accepterer i 7 dage. En gendannelse tæller aldrig som en ny udtalelse.

Tilladelse: 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 bag udtalelser

POST /sites/:site_id/testimonials/people/:id/ask_again.json Start en anmodning med denne person som eneste modtager testimonial_people_ask_again

Den bruger den formular, de sidst brugte, eller startformularen. Intet sendes, før anmodningen sendes. Serveren responderer med 422 og koden no_email, bounced eller unsubscribed, når personen ikke kan spørges, og requests_unavailable, mens anmodninger ikke er tilgængelige.

Tilladelse: 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 Tilføj en person til et sted testimonial_people_create

name er påkrævet (op til 120 tegn). email vises aldrig offentligt: den grupperer senere udtalelser under denne person og lader stedet spørge dem igen, og en adresse, en anden person på stedet allerede har, afvises. avatar_media_id er id'et (med_...) på et billede, der allerede er uploadet til stedet. At tilføje en person tilføjer ingen udtalelse.

Tilladelse: 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 Slet en person for altid med alt, vedkommende har sagt, filerne og historikken over forespørgsler testimonial_people_delete_permanently

Til en anmodning om sletning. Dette kan ikke fortrydes. Det kræver confirm, personens navn eller id, og efterlader én revisionspost, der hverken rummer navnet eller ordene.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 et steds personer, filtreret og sorteret testimonial_people_list

Hver person kommer med sit antal udtalelser, hvor mange der er godkendt, sin gennemsnitlige vurdering og den seneste forespørgsel med dens udfald. E-mailen er null, medmindre den kaldende har content.write, og has_email fortæller stadig, om der er en registreret.

Tilladelse: 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 Flet andre poster for den samme person ind i denne testimonial_people_merge

Personen i stien bliver. Alt, de andre har sagt, og hver forespørgsel sendt til dem flyttes over, og de andre fjernes. Et felt, som denne person har tomt, udfyldes fra de andre, ældst først, og use angiver, hvis værdi der vinder for et felt. Svaret indeholder meta.undo_id, som testimonial_undo_records_undo accepterer i 7 dage.

Tilladelse: 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, vedkommende er blevet bedt om, og de personer, der ligner den samme person testimonial_people_get

Deres udtalelser er testimonials_list med person_id. can_ask og cannot_ask_reason fortæller, om testimonial_people_ask_again ville gå igennem.

Tilladelse: 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. Kun de sendte felter ændres testimonial_people_update

En tom værdi rydder et felt, undtagen navnet. En e-mail, en anden person på stedet allerede har, afvises. Den virksomhedsside, en person er opført på, følger virksomhedens navn og websted.

Tilladelse: 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 '{…}'

Privat feedback

GET /sites/:site_id/testimonials/forms/:form_id/feedback.json List en formulars private feedback, nyeste først testimonial_feedback_list

Privat feedback er et svar med en vurdering på 1 til 3 på en formular med routing af lave vurderinger slået til (Business og op). Det er aldrig en udtalelse, aldrig offentligt og aldrig talt med.

Tilladelse: 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 Markér et privat feedbacksvar som læst, eller som ulæst igen testimonial_feedback_mark_read

Sætter read_at på ét privat feedbacksvar eller rydder det med read false. At markere et svar, der allerede er læst, beholder det tidspunkt, det først blev læst. Intet sendes til den, der skrev det.

Tilladelse: 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 ét privat feedbacksvar testimonial_feedback_get

Returnerer vurderingen, teksten, det navn, personen gav, og hvornår det blev læst. Privat feedback er et svar med en lav vurdering på en formular med routing af lave vurderinger slået til. Det er aldrig en udtalelse og aldrig offentligt.

Tilladelse: analytics.read

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

Regnearksimport af udtalelser

POST /sites/:site_id/testimonials/imports/spreadsheet.json Upload et regneark (eller send CSV-tekst), og læs dets kolonner testimonial_spreadsheet_imports_create

Trin 1 af en regnearksimport. Send file (CSV, TSV eller XLSX, højst 10 MB og 5.000 rækker, overskrifter i første række) eller content (CSV-tekst op til 1 MB). Svaret har kolonnerne, tre eksempelværdier for hver og et første gæt på, hvor hver kolonne hører hjemme. Intet er importeret endnu: fortsæt med testimonial_spreadsheet_imports_update og testimonial_spreadsheet_imports_run. Et regneark tæller aldrig med i de månedlige udtalelser eller de hentede importer.

Tilladelse: 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 Læs den tilknyttede fil ind i gennemgangstrinnet testimonial_spreadsheet_imports_run

Rækker, der kan bruges, venter med et afkrydsningsfelt. Rækker, der ikke kan, listes med deres rækkenummer og årsagen. Behold dem med testimonial_import_sources_keep, med regnearkets id som kilde-id.

Tilladelse: 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, tilknytning, indstillinger og antal testimonial_spreadsheet_imports_get

Returnerer filens kolonner med eksempelværdier, hvilket felt hver kolonne går til, indstillingerne (standardstatus, tags, samling, datoformat, hvad der sker med dubletter) og, når den har kørt, hvor mange rækker der venter i gennemgangstrinnet, og hvor mange der blev beholdt.

Tilladelse: 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 Gem, hvilken kolonne der går hvorhen, og indstillingerne for filen testimonial_spreadsheet_imports_update

Trin 2 og 3 af en regnearksimport. mapping er et objekt fra kolonnenavn til felt, med en tom værdi for en kolonne, der skal udelades, og to kolonner kan ikke gå til ét felt. Indstillingerne er default_status (pending eller approved), tags, collection_id (en manuel samling), default_source_name, date_format (auto, ymd, dmy eller mdy) og duplicates (skip eller queue). Kun det sendte ændres, og intet importeres før testimonial_spreadsheet_imports_run.

Tilladelse: 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 '{…}'

Revisionslog

GET /workspaces/:workspace_id/audit_log.json Vis poster i revisionsloggen (tilføj .csv for at eksportere) audit_logs_get

Returnerer arbejdsområdets revisionslog, en optegnelse over, hvem der har ændret hvad (indstillinger, medlemmer, websteder, mål, tokens og så videre), med nyeste først og sideinddeling. Den kræver rettigheden workspace.manage og et abonnement med revisionshistorik. Free har ingen, og kaldet fejler med en abonnementsgrænsefejl. Pro gemmer 30 dage, Business 365 dage, og Enterprise har ingen grænse. Poster ældre end opbevaringsvinduet returneres aldrig. Filtrér med actor (et medlems e-mail, nøjagtigt match), item_type (posttypen, fx Site, Goal eller Membership), event (create, update eller destroy) samt from og to (YYYY-MM-DD, inklusive, i UTC). Hver post har id, created_at, event, item_type, item_id, target (en læsbar betegnelse som Site: example.com), actor_email (null, når ændringen blev foretaget af systemet eller af en slettet bruger), actor_name, token_name (det brugte API-token, null for en browsersession), changes (et objekt, der knytter hvert ændret felt til et [før, efter]-par, med hemmeligheder fjernet) og ip (den adresse, medlemmet eller API-klienten brugte, null når den er ukendt). En CSV-eksport af den samme log findes kun i appen.

Tilladelse: workspace.manage

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

Roller

POST /workspaces/:workspace_id/roles.json Opret en egen rolle roles_create

Opretter en brugerdefineret rolle, et navngivet sæt rettigheder, du kan give medlemmer via invitations_create eller members_update med role custom og rollens id som custom_role_id. Den kræver Business-abonnementet og members.manage. permissions skal angive mindst ét navn fra de tilladte værdier (analytics.read, analytics.export, content.write, sites.manage, uptime.manage, members.manage, tokens.manage, billing.manage, workspace.manage), og du kan ikke medtage en rettighed, du ikke selv har. Returnerer rollen (se roles_list for felterne).

Tilladelse: members.manage · Kun HTTP (ikke et MCP-værktøj)

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 Slet en egen rolle (må ikke være i brug) roles_delete

Sletter en brugerdefineret rolle. Det kan ikke fortrydes, og det fejler, så længe et medlem eller en afventende invitation stadig bruger rollen, så flyt først de personer til en anden rolle med members_update (find dem med members_list). De indbyggede roller kan ikke slettes. Tag id'et (uuid) fra roles_list. Kræver members.manage. Returnerer den slettede rolle.

Tilladelse: members.manage · Kun HTTP (ikke et MCP-værktøj)

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 Vis egne roller roles_list

Viser et arbejdsområdes brugerdefinerede roller, sorteret efter navn. Brugerdefinerede roller er en funktion i Business-abonnementet, der samler rettigheder under dit eget navn, og de indbyggede roller (owner, admin, editor, analyst, viewer, billing) vises ikke her. Hver rolle har id (uuid, bruges som custom_role_id i invitations_create og members_update), name, permissions (navne som analytics.read, content.write, members.manage), members (antal medlemmer, der har den) og created_at. Kaldere begrænset til nogle websteder ser kun roller inden for deres rækkevidde.

Tilladelse: member

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/roles.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/roles/:id.json Opdatér en egen rolle roles_update

Omdøber en brugerdefineret rolle og/eller erstatter hele dens rettighedsliste. Kun de inputs, du sender, ændres, og permissions erstatter den eksisterende liste i stedet for at tilføje til den. Ændringen gælder med det samme for alle medlemmer og afventende invitationer, der har rollen. Du kan kun redigere en rolle, hvis rettigheder du fuldt ud har, og en kalder begrænset til nogle websteder skal have rækkevidde over alle indehaveres websteder. Kræver members.manage. Tag id'et (uuid) fra roles_list. Returnerer den opdaterede rolle.

Tilladelse: members.manage · Kun HTTP (ikke et MCP-værktøj)

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 Opret en bruger scim_users_create

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/scim/v2/Users.json \
  -H "Content-Type: application/json" -d '{…}'
DELETE /scim/v2/Users/:id.json Fjern en bruger scim_users_delete

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X DELETE https://privatusanalytics.com/scim/v2/Users/:id.json \
  -H "Content-Type: application/json" -d '{…}'
GET /scim/v2/Users.json Vis oprettede brugere scim_users_list

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl https://privatusanalytics.com/scim/v2/Users.json
GET /scim/v2/Users/:id.json Hent en oprettet bruger scim_users_get

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl https://privatusanalytics.com/scim/v2/Users/:id.json
PATCH /scim/v2/Users/:id.json Opdatér en bruger (PATCH active, name) scim_users_update

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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 Aktivér en testet SSO-konfiguration sso_activate

Slår SSO til for arbejdsområdet. Konfigurationen skal allerede have status tested, hvilket sker efter et vellykket prøvelogin (startes fra arbejdsområdets SSO-indstillingsside i appen, det kræver et browserlogin og kan ikke køres herfra), eller allerede være active. Kun Business-abonnement. Efter aktivering kan medlemmer logge ind med SSO, og hvis du sætter enforced via sso_update, kræves SSO derefter ved hvert login. Den fejler, når konfigurationen er utestet, eller abonnementet ikke har SSO. Kræver workspace.manage. Returnerer konfigurationen med status active (se sso_get).

Tilladelse: workspace.manage · Kun HTTP (ikke et MCP-værktøj)

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å SSO fra (tilbage til kladde) sso_deactivate

Slår SSO fra ved at sætte konfigurationen tilbage til draft og rydde enforced, så medlemmer går tilbage til arbejdsområdets andre loginmetoder. Udbyderoplysninger bevares. Genaktivering kræver et nyt prøvelogin og sso_activate. Sørg først for, at medlemmer har en anden måde at logge ind på. Det virker på ethvert abonnement. Kræver workspace.manage. Returnerer konfigurationen med status draft (se sso_get).

Tilladelse: workspace.manage · Kun HTTP (ikke et MCP-værktøj)

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 Generér et nyt SCIM-token (vises kun én gang) sso_scim_token

Tilladelse: workspace.manage · Kun HTTP (ikke et MCP-værktøj)

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-indstillinger sso_get

Returnerer arbejdsområdets konfiguration af single sign-on (SSO) eller et tomt udkast, når der ingen findes. Felterne er protocol (saml eller oidc), status (draft, testing, tested eller active), enforced (medlemmer skal logge ind via SSO), domains (e-maildomæner, der bruger denne SSO), idp_sso_url og idp_entity_id for SAML, oidc_issuer og oidc_client_id for OIDC, default_role og jit_provisioning (opret medlemmer ved første SSO-login) samt scim_enabled. Hemmeligheder returneres aldrig, kun booleans idp_cert_present og oidc_client_secret_present. SSO er en funktion i Business-abonnementet. Kræver workspace.manage.

Tilladelse: workspace.manage

Eksempel
curl https://privatusanalytics.com/workspaces/:workspace_id/sso.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /workspaces/:workspace_id/sso.json Opret eller opdatér SSO-indstillinger sso_update

Opretter eller redigerer arbejdsområdets SSO-indstillinger. Kun Business-abonnement. Kun de inputs, du sender, ændres. 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 kun kan skrives, og en tom værdi beholder den eksisterende hemmelighed. domains viser de e-maildomæner, der bruger denne SSO. default_role er den rolle, medlemmer oprettet ved første login eller via SCIM får (ikke owner eller custom), og du kan kun sætte en rolle, du selv kunne give. Hvis du ændrer en oplysning om identitetsudbyderen, sættes en aktiv eller testet konfiguration tilbage til draft, og enforced slås fra, så den skal testes igen, før sso_activate virker. enforced true accepteres kun, mens status er active. Kræver workspace.manage. Returnerer konfigurationen (se sso_get).

Tilladelse: workspace.manage · Kun HTTP (ikke et MCP-værktøj)

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

Samlinger af udtalelser

POST /sites/:site_id/testimonials/collections/:id/items.json Tilføj udtalelser til en manuel samling testimonial_collections_add_items

Op til 100 ad gangen. De kommer nederst, eller øverst med position top, i den angivne rækkefølge. Svaret har meta.undo_id, som testimonials_bulk_undo accepterer i 7 dage. En smart samling tager intet i hånden.

Tilladelse: 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 Opret en samling, manuel eller smart testimonial_collections_create

kind manual sammensættes i hånden, og testimonial_ids starter den fyldt. kind smart holdes opdateret af betingelser: rækker af felt, operator og værdi forbundet af match. Svaret indeholder antallet og reglerne i almindeligt engelsk, så ét kald gør en sætning til en levende samling. Prøv reglerne først med testimonial_collections_preview. Arten ændres aldrig bagefter.

Tilladelse: 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 Flyt en samling til papirkurven i 30 dage testimonial_collections_destroy

Dens udtalelser berøres ikke. En widget eller væg, den fodrer, viser intet fra den, før den gendannes. Gendan den med testimonial_trash_restore. Over MCP ændrer værktøjet intet og responderer med den side i appen, hvor en person gør det.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 et steds samlinger testimonial_collections_list

Hver samling kommer med, hvor mange udtalelser den rummer lige nu, hvor mange af dem der er godkendt, dens regler i almindeligt engelsk, når den er smart, og de widgets og vægge, den fodrer. Samlinger i papirkurven udelades.

Tilladelse: 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 sæt regler uden at gemme noget testimonial_collections_preview

Responderer med, hvor mange udtalelser der matcher lige nu, reglerne i almindeligt engelsk og fem eksempler. Brug den før testimonial_collections_create eller testimonial_tags_update. En ugyldig række er en 422, der nævner rækken.

Tilladelse: 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 Tag udtalelser ud af en manuel samling testimonial_collections_remove_items

Op til 100 ad gangen. Selve udtalelserne ændres ikke. Svaret har meta.undo_id, og en fortryd sætter hver på plads igen.

Tilladelse: 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 Flyt én udtalelse til et andet sted i en manuel samling testimonial_collections_reorder

Angiv stedet med præcis én af position (talt fra 1), before_id eller after_id. Rækkefølgen er den, der serveres til hver widget og væg, samlingen fodrer.

Tilladelse: 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 dens antal, regler og hvad den fodrer testimonial_collections_get

Dens udtalelser er testimonials_list med collection_id.

Tilladelse: 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 Ændr en samlings navn, beskrivelse, regler eller serverede rækkefølge testimonial_collections_update

Kun det sendte ændres. At sende conditions erstatter hver regel i en smart samling. Arten er fast.

Tilladelse: 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 Gem filtre som et segment segments_create

Gemmer et sæt filtre som et navngivet segment, der kan genbruges på ethvert statistikværktøj via segment_id. Angiv name og filters (alle betingelser skal matche, og en {any: [...]}-gruppe matcher, når en af flere gør, se inputtet filters for dimensionsnavne og operatorer). Filtrene kontrolleres, så en ukendt dimension eller en dårlig værdi returnerer en 422 med en meddelelse pr. række. Brug først segments_preview til at tjekke, hvad et filtersæt matcher. shared er som standard true og gør segmentet synligt for alle med adgang til webstedet, false holder det privat for dig. Returnerer segmentet med id (seg_...), site_id, name, description, filters, summary (en beskrivelse i klart sprog), shared, mine og tidsstempler. Kræver rettigheden content.write.

Tilladelse: 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 Slet et segment segments_delete

Sletter et gemt segment permanent. Dashboards og links, der bruger det, falder tilbage til al trafik. Ingen analysedata berøres, og der er ingen fortryd. Returnerer det slettede segment. Id'er (seg_...) kommer fra segments_list. Kræver rettigheden content.write.

Tilladelse: 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 Vis segmenter, du kan bruge på et websted segments_list

Viser et websteds gemte segmenter, sorteret efter navn: de delte plus dine egne private. Hvert segment har id (seg_...), site_id, name, description, filters, summary, shared, mine og tidsstempler. Send et id som segment_id til et vilkårligt statistikværktøj (stats_aggregate, stats_breakdown, funnels_get og andre) for at anvende segmentets filtre. Med sideinddeling via de almindelige sideparametre. Brug segments_create til at tilføje et.

Tilladelse: 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 i almindeligt sprog, og tæl de besøgende, de matchede inden for de seneste 30 dage segments_preview

Tjekker et sæt filtre uden at gemme noget. Returnerer summary (filtrene i klart sprog), visitors (hvor mange besøgende der matchede inden for de seneste 30 dage, null når filtrene er ugyldige), period (altid 30d) og filters (den rensede, kanoniske form, der ville blive gemt). Filtre bruger samme format som segments_create, inklusive {any: [...]}-grupper og valgfrie udskrevne navne på lande, kanaler og mål, som omsættes til koder og id'er. Ugyldige filtre returnerer en 422, der nævner rækken. Brug den til at prøve filtre før segments_create og stats_aggregate med filters til tal over en anden periode.

Tilladelse: 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 ét gemt segment: id (seg_...), site_id, name, description, filters (de gemte betingelser), summary (en beskrivelse i klart sprog som Besøgende fra USA på mobil), shared (synligt for alle med adgang til webstedet), mine (true, når du oprettede det) og tidsstempler. Du kan læse delte segmenter og dine egne private. Id'er kommer fra segments_list. Brug segments_preview for at tælle, hvor mange besøgende et sæt filtre matcher.

Tilladelse: 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 Omdøb et segment eller ændr dets filtre eller deling segments_update

Omdøber et segment, erstatter dets filtre eller ændrer, hvem der kan se det. Kun de inputs, du sender, ændres. Hvis du sender filters, erstattes alle eksisterende filtre, i samme format og med de samme kontroller som i segments_create. shared false gør det privat for dets opretter. description kan ryddes ved at sende den tom. Alt, der bruger segmentet, som statistikkald med dets segment_id, ændres med det samme. Returnerer segmentet. Id'er kommer fra segments_list. Kræver rettigheden content.write.

Tilladelse: 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 '{…}'

Sponsorrapport

GET /sponsor/:token.json En sponsorrapport via sit links token ad_reports_get

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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

Sponsorrapporter

Sporing

POST /sites/:site_id/tracking/ingest_key.json Opret eller roter nøglen til crawlerlogge (vises kun én gang) tracking_ingest_key_rotate

Opretter en ny hemmelig nøgle til crawlerlogge (den begynder med pik_) for et websted og erstatter enhver eksisterende nøgle. Nøglen godkender upload af serveradgangslogs til rapporten om AI-crawlere (POST /api/logs). Brug den både til at oprette den første nøgle og til at rotere. Den nye nøgle virker med det samme, og den gamle holder op med at virke med det samme, så udrul den nye nøgle straks for at undgå 401-fejl ved logupload. Den fulde nøgle returneres kun i dette svar, i feltet key, så gem den i et hemmelighedslager. Bagefter gemmes og vises kun et kort præfiks (prefix her, ingest_key_prefix på webstedet). Returnerer site_id, key og prefix. Kræver sites.manage. Brug tracking_ingest_key_revoke til at fjerne nøglen uden at erstatte den.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 Tilbagekald nøglen til crawlerlogge tracking_ingest_key_revoke

Fjerner et websteds nøgle til crawlerlogge. Fra da af afvises al logupload, der sendes med den nøgle, med 401, indtil du opretter en ny med tracking_ingest_key_rotate. Browsersporing med det offentlige websteds-id påvirkes ikke. Nøglen kan ikke gendannes. Kræver sites.manage. Returnerer webstedsobjektet (se sites_get), hvor ingest_key_prefix nu er null.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 Kontrollér, at trackeren er installeret på webstedet (script-tag, site id, CSP og henviserpolitik) tracking_verify

Henter webstedets side og tjekker, at Privatus Analytics-sporingsscriptet er installeret korrekt, og markerer webstedet som verificeret, når scriptet med dette websteds id findes. Som standard henter den forsiden (https://domain/), og url kan angive en anden side, men kun på webstedets eget domæne, ekstra domæner eller deres underdomæner. Resultatet (under data) har url, status (HTTP-status), script_found, site_ids (hvert data-site-id, der findes på siden), installed (true, når dette websteds id er blandt dem), csp og csp_ok (om sidens Content-Security-Policy lader trackeren indlæse og sende), referrer_policy og referrer_ok (en no-referrer-politik betyder, at hvert besøg vises som direkte) og checked_at. Den henter over det offentlige internet, læser højst 2 MB og er hastighedsbegrænset pr. arbejdsområde og pr. vært, så den svarer 429, når den kaldes for ofte. Hvis siden ikke kan nås, returnerer den en valideringsfejl. Brug sites_setup_get til at se, om hændelser er kommet. Kræver sites.manage.

Tilladelse: 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 Byg sporingskoden ud fra de valgte indstillinger tracking_snippet

Bygger HTML-scripttagget til at installere sporing på et websted og returnerer det med websteds-id'et som data.site_id og data.snippet. Vælg den frem for sites_setup_get, når du vil tilpasse det, og brug bagefter tracking_verify til at tjekke den live side. Som standard indlæses alle tracker-moduler, og sidevisninger er automatiske. modules indsnævrer til en delmængde af engage (tid og scroll), auto (udgående links, downloads, formularer, 404-sider), vitals (Web Vitals), clicks (klikkort) og ask (undersøgelser på webstedet). manual true slår den automatiske sidevisning fra, så du selv sender dem. spa sætter sporing af navigation i single-page-apps til auto, history, hash eller off. domains begrænser sporing til de værtsnavne, exclude viser stimønstre med wildcards, der skal springes over, query_params viser ekstra forespørgselsparametre, der skal beholdes, og mask viser stimasker på klientsiden skrevet som /u/*->/u/:id. Intet gemmes, snippetet genereres ud fra inputs hver gang. Kræver analytics.read.

Tilladelse: analytics.read

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

Sprog for udtalelser

GET /sites/:site_id/testimonials/settings/languages.json Hent sprogindstillingerne for et steds udtalelser testimonial_languages_get

Standardsproget, de tilbudte sprog, om nyligt godkendte udtalelser oversættes automatisk, om planen inkluderer oversættelse, om oversættelse er sat op, og månedens brugte og resterende tegn.

Tilladelse: 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 Angiv standardsproget, de tilbudte sprog og automatisk oversættelse testimonial_languages_update

Send kun det, der ændres. Standarden er altid blandt de tilbudte sprog, og et sprog, en formular er skrevet på, kan ikke fjernes (in_use). At slå auto_translate til kræver Business eller højere (402 plan_limit andre steder): fra da af sendes ordene i hver nyligt godkendt udtalelse til Google Cloud Translation, og medlemmet får en e-mail om, at en assistent ændrede dette.

Tilladelse: 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 Bekræft et abonnement fra linket i e-mailen public_status_pages_confirm

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl https://privatusanalytics.com/status/:slug/confirm/:token.json
GET /status/:slug.json Offentlig statusside: aktuel status, oppetidsbjælker for 90 dage, hændelser og opslag public_status_pages_get

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl https://privatusanalytics.com/status/:slug.json
POST /status/:slug/subscribers.json Tilmeld en e-mailadresse (dobbelt bekræftelse) public_status_pages_subscribe

Browserklienter sender et Cloudflare Turnstile-token som `cf-turnstile-response`. Forespørgsler med et API-token behøver intet.

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/status/:slug/subscribers.json \
  -H "Content-Type: application/json" -d '{…}'
POST /status/:slug/unsubscribe/:token.json Afmeld med tokenet fra e-mailen public_status_pages_unsubscribe

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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 Send en hændelsesopdatering (sender e-mail til abonnenter) status_page_posts_create

Udgiver en hændelsesopdatering på en statusside og sender som standard e-mail til dens bekræftede abonnenter. Vælg den til at annoncere eller opdatere en hændelse, og brug status_page_posts_update til at føre en eksisterende hændelse videre (fx til resolved) i stedet for at oprette et nyt opslag. Påkrævet er title (maks. 200 tegn). status er en af investigating (standard), identified, monitoring eller resolved. body er ren tekst (maks. 10.000 tegn), posted_at er et ISO 8601-tidspunkt, der som standard er nu, og notify (standard true) styrer e-mailen. E-mails sendes kun for en udgivet side og er hastighedsbegrænsede pr. side, over grænsen udgives opslaget stadig, men ingen får e-mail. status_page_id kommer fra status_pages_list. Kræver rettigheden uptime.manage. Returnerer opslaget med id (spp_...), title, body, status, posted_at og updated_at.

Tilladelse: 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 Slet et opslag på en statusside status_page_posts_delete

Sletter et hændelsesopslag fra en statusside permanent. Det forsvinder med det samme fra den offentlige side, og det kan ikke fortrydes. Der sendes ingen e-mail. Id'et kommer fra status_page_posts_list. Kræver rettigheden uptime.manage. Returnerer det slettede opslag.

Tilladelse: 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 Vis opslag på en statusside status_page_posts_list

Viser en statussides hændelsesopslag, nyeste først efter posted_at. Brug den til at finde et opslags id eller se hændelseshistorikken. Filtrér eventuelt efter status (investigating, identified, monitoring eller resolved). Med sideinddeling via page og per_page (op til 100). Hvert opslag har id (spp_...), title, body (null, når den er tom), status, posted_at og updated_at. status_page_id kommer fra status_pages_list.

Tilladelse: 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 Redigér et opslag på en statusside status_page_posts_update

Redigerer et hændelsesopslag. Kun de inputs, du sender, ændres, så send blot status for at afslutte en hændelse. Abonnenter får kun e-mail, når status faktisk ændres, og notify ikke er false (standard true). Hvis du kun redigerer titlen eller body, sendes ingen e-mail. E-mails går til bekræftede abonnenter af en udgivet side og er hastighedsbegrænsede pr. side. Gyldige status-værdier er investigating, identified, monitoring og resolved. Id'et kommer fra status_page_posts_list. Kræver rettigheden uptime.manage. Returnerer det opdaterede opslag.

Tilladelse: 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-mailabonnent fra en statusside, så vedkommende holder op med at modtage e-mails om hændelser og oppetid. Det kan ikke fortrydes, men personen kan abonnere igen på den offentlige side. Id'et er abonnentens id fra status_page_subscribers_list (et almindeligt UUID, ikke et id med præfiks). Kræver rettigheden uptime.manage. Returnerer den fjernede abonnent.

Tilladelse: 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 Vis abonnenter på en statusside status_page_subscribers_list

Viser en statussides e-mailabonnenter, sorteret efter e-mail. Brug confirmed true for kun at se personer, der har bekræftet deres adresse (kun de modtager e-mails), eller confirmed false for afventende. Med sideinddeling via page og per_page (op til 100). Hvert element har id (et UUID, bruges af status_page_subscribers_delete), email, confirmed_at (null, mens den afventer) og created_at. status_page_id kommer fra status_pages_list. Kræver rettigheden uptime.manage og returnerer personoplysninger (e-mailadresser). Kræver Business- eller Enterprise-abonnementet (ellers 402 plan_limit).

Tilladelse: 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 Opret en statusside status_pages_create

Opretter en offentlig statusside for et arbejdsområde, der viser udvalgte oppetidskontroller, hændelsesopslag og en tilmelding på e-mail. Påkrævet er name (maks. 100 tegn). slug (små bogstaver, cifre og bindestreger, unik på tværs af alle arbejdsområder) udledes som standard af navnet, og siden vises på /status/<slug>. check_ids viser de oppetidskontroller, der skal vises (upc_...-id'er fra uptime_checks_list), og kun kontroller oprettet med public true accepteres. published er som standard true, så siden er synlig for alle med det samme. Valgfri branding er description (maks. 2.000 tegn), logo_url (skal være https), brand_color (hex som #06755b) og custom_domain (et værtsnavn, du peger en CNAME mod appen, unikt). Brug bagefter status_page_posts_create til at udgive hændelser. Kræver rettigheden uptime.manage. Returnerer siden med id (sp_...), slug, check_ids og subscribers (antal bekræftede abonnenter). Abonnementet fastsætter, hvor mange sider et arbejdsområde har: ingen på Free (402 plan_limit), 1 på Pro og 10 på Business. Et custom_domain og e-mailabonnenter kræver Business- eller Enterprise-abonnementet. Sider over abonnementets antal bevares og er offline.

Tilladelse: 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 Slet en statusside status_pages_delete

Sletter en statusside permanent sammen med alle dens hændelsesopslag og abonnenter. Den offentlige side og dens eget domæne holder op med at virke med det samme, og det kan ikke fortrydes. Selve oppetidskontrollerne slettes ikke. Id'et kommer fra status_pages_list. Kræver rettigheden uptime.manage. Returnerer den slettede side.

Tilladelse: 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 Vis statussider status_pages_list

Viser et arbejdsområdes statussider sorteret efter navn. Brug query til at matche en del af et navn eller slug. Når kalderen er begrænset til nogle websteder, returneres kun sider, hvis kontroller alle ligger inden for de websteder. Med sideinddeling via page og per_page (op til 100). Hvert element har de felter, der er beskrevet i status_pages_get. Kræver workspace_id fra workspaces_list.

Tilladelse: 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 dens indstillinger. Felterne er id (sp_...), workspace_id, name, slug, custom_domain (null, når der ingen er), description, logo_url, brand_color, published, check_ids (id'er på de oppetidskontroller, der vises på siden), subscribers (antal bekræftede e-mailabonnenter) og created_at. Brug status_page_posts_list til dens hændelser og status_page_subscribers_list til personerne. Id'et kommer fra status_pages_list.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/status_pages/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /status_pages/:id.json Ændr en statusside status_pages_update

Ændrer en statusside. Kun de inputs, du sender, ændres, så send blot published false for at tage siden offline eller check_ids for at erstatte de viste kontroller (hele listen erstattes, den flettes ikke). Inputs og deres grænser er de samme som i status_pages_create. Send custom_domain som en tom streng for at fjerne det egne domæne. Kun kontroller med public true kan vises, og en kalder begrænset til nogle websteder kan kun sætte kontroller fra de websteder på en side. Id'et kommer fra status_pages_list. Kræver rettigheden uptime.manage. Returnerer den opdaterede side.

Tilladelse: 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øgning

GET /sites/:site_id/search.json Søgerapport: klik, visninger, CTR, position, topsøgninger og topsider, landingssider og muligheder search_report

Søgeresultater fra Google Search Console og Bing Webmaster, koblet til webstedets egne målinger for landingssider. Vælg provider: all (standard) lægger alle forbundne søgemaskiner sammen, med position vægtet efter visninger og med lande og enheder kun fra Google, eller google eller bing alene og den sædvanlige period eller tilpasset from og to. limit (1 til 100, standard 25) begrænser rækkerne i hver tabel. Resultatet har period, provider, connection (property, status, last_synced_at for den valgte søgemaskine, eller null når den ikke er forbundet, eller når provider er all), connections (hver forbundet søgemaskine med provider, property, status og last_synced_at), latest_date (nyeste dag med data), delayed (true, når intervallet rækker ud over latest_date), totals og series (pr. dag) hver med clicks, impressions, ctr (en procent, ikke en brøk, 2 decimaler) og position (gennemsnitlig placering, 1 er bedst, null hvis ukendt), breakdowns for query, page, country og device (rækker af value plus de samme fire målinger), landing_pages (topsider med visits, bounce_rate og conversion_rate som procenter samt conversions) og opportunities (low_ctr_queries med mindst 100 visninger og en CTR under 2 procent samt striking_distance-sider med en gennemsnitlig position på 8 til 20). Landeværdier er, som udbyderen rapporterer dem. Brug stats_breakdown til besøgendedata og dette værktøj til, hvad der sker før klikket. Kræver analytics.read.

Tilladelse: 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 Afbryd Search Console eller Bing og slet dets data search_disconnect

Afbryder en søgeudbyder (google eller bing) fra et websted og sletter permanent dets importerede søgedata for den udbyder. Det kan ikke fortrydes. Google-godkendelsen fjernes også, når intet websted bruger den. Fejler, hvis den udbyder ikke er forbundet. Returnerer den fjernede forbindelse. Kræver sites.manage.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 Importér søgedata nu search_sync

Sætter en øjeblikkelig import af søgedata i kø for en forbundet udbyder (google, som er standard, eller bing) i stedet for at vente på den almindelige tidsplan. Den returnerer med det samme (HTTP 202) med forbindelsen, og importen kører i baggrunden. Hent search_report gentagne gange, og hold øje med connection.last_synced_at. Søgemaskiner rapporterer med et par dages forsinkelse, så de nyeste dage forbliver tomme, selv efter en synkronisering. Fejler, hvis udbyderen ikke er forbundet. Kræver sites.manage.

Tilladelse: 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 '{…}'

Tags til udtalelser

POST /sites/:site_id/testimonials/tags/:id/apply_rules.json Kør et tags regler over de udtalelser, der allerede er gemt testimonial_tags_apply_rules

dry_run true (standard) ændrer intet og responderer med antallene: hvor mange der ville blive tagget, af hvor mange, og hvor mange der allerede har tagget. dry_run false tagger dem som én massehandling og responderer med undo_id, som testimonials_bulk_undo accepterer i 7 dage. Mere end 100 kører i baggrunden, og svaret har state running.

Tilladelse: 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 Opret et tag, med regler for automatisk tagging, hvis du sender dem testimonial_tags_create

En regel er { match, conditions }. En udtalelse, der opfylder en eller anden regel, får tagget i det øjeblik, den ankommer. Regler tilføjer altid kun et tag. For at tagge det, der allerede er gemt, kald testimonial_tags_apply_rules bagefter.

Tilladelse: 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 Flyt et tag til papirkurven i 30 dage testimonial_tags_destroy

Det forlader hver udtalelse, hvert filter og hver vælger. At gendanne det med testimonial_trash_restore sætter det tilbage på hver udtalelse, der havde det. En smart samling, hvis regler nævner det, matcher intet indtil da. Over MCP ændrer værktøjet intet og responderer med den side i appen, hvor en person gør det.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 et steds tags med deres regler testimonial_tags_list

Hvert tag kommer med, hvor mange udtalelser der bærer det, dets regler for automatisk tagging som strukturerede betingelser og i almindeligt engelsk, og hvornår en regel sidst blev anvendt. Tags i papirkurven udelades.

Tilladelse: 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 Flet et tag ind i et andet testimonial_tags_merge

Hver udtalelse, der havde dette tag, får det andet, hver regel flyttes til det andet, hver smart samling, gemt visning, widget og væg, der nævnte dette tag, nævner det andet, og dette tag går i papirkurven, tomt. Responderer med det tag, der beholdes.

Tilladelse: 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 Ændr et tags navn, farve eller regler testimonial_tags_update

Kun det sendte ændres. At sende rules erstatter hver regel i tagget, og en tom liste fjerner dem alle.

Tilladelse: 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 '{…}'

Trafikregler

POST /sites/:site_id/traffic_rules.json Tilføj en trafikregel traffic_rules_create

Tilføjer et mønster til en af webstedets bloker- eller tillad-lister. list er en af hostnames, paths, referrers, countries, ip_ranges, user_agents eller events. pattern bruger * som wildcard, og matchningen skelner ikke mellem store og små bogstaver, fx /admin/*, et værtsnavn, en henviservært som spam.example, en landekode på to bogstaver (gemt med store bogstaver), et browsernavn med hovedversion, da user agent reduceres (fx Chrome 120), eller et brugerdefineret hændelsesnavn. ip_ranges tager en IPv4- eller IPv6-adresse eller CIDR (203.0.113.0/24), som skal være gyldig. Et mønster kan findes én gang pr. liste, og et websted kan have op til 500 regler. Om listen blokerer eller tillader matches afhænger af dens tilstand, som er block som standard og ændres med sites_update. Matchende hits droppes ved indsamlingen og gemmes ikke, og reglen gælder inden for få minutter og kun for nye hits. Kræver sites.manage. Kræver Pro-abonnementet eller derover (ellers 402 plan_limit).

Tilladelse: 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 Slet en trafikregel traffic_rules_delete

Sletter en trafikregel, fundet via dens id fra traffic_rules_list. Hits, den droppede, tælles med igen fra da af, og hits, der allerede er droppet, er væk for altid. Bemærk, at hvis du sletter det sidste mønster i en liste i tillad-tilstand, holder listen op med at filtrere. Returnerer den slettede regel. Kræver sites.manage.

Tilladelse: 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 Vis trafikregler traffic_rules_list

Viser webstedets trafikregler, som er bloker- eller tillad-lister anvendt ved indsamlingen for at afgøre, hvilke hits der tæller. Hver regel har id (et UUID til opdatering og sletning), list (hostnames, paths, referrers, countries, ip_ranges, user_agents eller events), pattern, label (valgfri note), mode (block eller allow, hele listens tilstand) og created_at. I block-tilstand droppes et hit, der matcher et vilkårligt mønster på listen, i allow-tilstand droppes et hit, der ikke matcher nogen, og en tom liste filtrerer intet. Filtrér med list. En listes tilstand sættes ikke her, den sættes med sites_update ved hjælp af traffic_rule_modes. Brug traffic_rules_test til at tjekke et eksempelhit. Kræver analytics.read.

Tilladelse: 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 hit ville blive talt med webstedets nuværende regler traffic_rules_test

Prøvekørsel, der fortæller, om et eksempelhit ville blive talt med under webstedets nuværende trafikregler. Intet gemmes. Send et af følgende: url (en fuld side-URL, dens vært og sti tjekkes), referrer (URL eller værtsnavn), country (kode på to bogstaver), ip (tjekkes mod ip_ranges, gemmes aldrig), user_agent (en fuld User-Agent-streng, reduceret til browser og hovedversion) og event (et brugerdefineret hændelsesnavn). Værdier, du udelader, tjekkes ikke. Resultatet har counted (true, hvis hittet ville blive registreret), blocked_by (den liste, der droppede det, eller null), mode (block eller allow for den liste, eller null) og values (de normaliserede værdier, der blev tjekket). Regler læses live, så en ny regel vises med det samme. Kræver analytics.read. Kræver Pro-abonnementet eller derover (ellers 402 plan_limit).

Tilladelse: 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 Ændr en trafikregel traffic_rules_update

Ændrer mønsteret eller label på en trafikregel, fundet via dens id fra traffic_rules_list. Kun de inputs, du sender, ændres. Listen kan ikke ændres, slet reglen og opret den igen for at flytte den til en anden liste. Mønsteret skal forblive gyldigt for sin liste (en CIDR for ip_ranges) og unikt inden for den. Send en tom label for at rydde den. Gælder kun for nye hits. Kræver sites.manage. Kræver Pro-abonnementet eller derover (ellers 402 plan_limit).

Tilladelse: 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 '{…}'

Tragte

POST /sites/:site_id/funnels.json Opret en tragt funnels_create

Opretter en tragt, en række trin, som besøg bevæger sig igennem, målt pr. besøg. Angiv name og steps, en ordnet liste af {type, value, match, name}. type er page, event eller goal. value er en sti for page-trin (fx /pricing), et brugerdefineret hændelsesnavn for event-trin eller et mål-id (goal_..., fra goals_list) for goal-trin. match gælder kun for page-trin og er exact, prefix, glob (* som wildcard) eller regex, med glob som standard, når værdien har en *, og ellers exact. name er en valgfri etiket. Trin med en tom value droppes. order_mode er strict (hvert trin skal komme efter det forrige, standard) eller any (trin i vilkårlig rækkefølge). window er visit (standard) eller day, og begge måler inden for ét besøg, fordi der ikke gemmes noget besøgende-id. Abonnementsgrænser gælder. Free tillader 3 tragte pr. websted og 5 trin, Pro tillader 10 trin og Business 20, og en tragt skal have mindst 2 trin. Returnerer tragten med id (fun_...). Læs resultaterne med funnels_get. Kræver rettigheden content.write.

Tilladelse: 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 Slet en tragt funnels_delete

Sletter en tragtdefinition permanent. Ingen analysedata berøres, men tragten og dens indstillinger kan ikke gendannes, og der er ingen fortryd. Returnerer den slettede tragt. Id'er (fun_...) kommer fra funnels_list. Brug funnels_update til i stedet at ændre en tragt. Kræver rettigheden content.write.

Tilladelse: 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 Vis tragte med indgange, gennemførelser og rate funnels_list

Viser et websteds tragte med deres hovedresultater for perioden, sorteret efter navn. Hver tragt har id (fun_...), name, steps, order_mode, window og stats {entered, completed, conversion_rate}, hvor entered er besøg, der nåede trin 1, completed er besøg, der nåede det sidste trin, og conversion_rate er en procent (0 til 100). Med sideinddeling via page og per_page (maks. 100, standard 25). Tager de fælles inputs period og filters. Brug funnels_get til detaljer trin for trin og funnels_create til at tilføje en.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/funnels.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
GET /sites/:site_id/funnels/:id.json Tragtrapport: trintællinger, konvertering, frafald, tid mellem trin og hvor besøg i stedet gik hen funnels_get

Konverteringsrapporten for én tragt for en periode. Returnerer period, funnel_id, name, order_mode, window, steps, overall_conversion_rate, breakdown og, med compare, comparison. Hvert trin har index (fra 1), name, type, value, match, count (besøg, der nåede det), step_conversion_rate (procent af det forrige trin), overall_conversion_rate (procent af trin 1), dropoff og dropoff_rate (besøg, der forlod tragten efter dette trin), median_seconds_from_previous (null for trin 1) og next_pages (de 5 øverste sider, som frafaldne besøg besøgte derefter, med (exit) for dem, der forlod webstedet). Rater er procenter fra 0 til 100. Sæt breakdown til channel, device, country, utm_campaign, utm_source, browser eller os for at få den samlede konvertering pr. værdi (de øverste 20). comparison har den anden periodes antal, overall_conversion_rate og change (procent, null når den tidligere rate var 0). Sidefiltre ignoreres her, fordi de ville afkorte besøg, brug i stedet et page-trin. Tager de fælles inputs period, compare, filters og segment. Id'er kommer fra funnels_list.

Tilladelse: 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 Opdatér en tragt funnels_update

Ændrer en tragt. Kun de inputs, du sender, ændres. Hvis du sender steps, erstattes hele listen af trin, så send hvert trin i rækkefølge (format og tringrænser er de samme som i funnels_create, Free tillader 5 trin, Pro 10 og Business 20, og goal-trin skal angive mål fra dette websted). Du kan også ændre name, order_mode (strict eller any) og window (visit eller day). Resultater beregnes ud fra definitionen, når de læses, så en ændring af en tragt gælder for al historik med det samme, og tidligere viste tal vil afvige. Returnerer tragten. Id'er kommer fra funnels_list. Kræver rettigheden content.write.

Tilladelse: 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 '{…}'

Udtalelser

GET /sites/:site_id/testimonials/overview.json Læs et steds tal, hvad der kræver opmærksomhed, og hvad der er sket for nylig testimonials_overview

stats rummer de fem tal på Oversigt-siden: godkendte udtalelser, afventende, nye denne måned, gennemsnitlig vurdering og i brug. attention lister det, der kræver en beslutning, med dets antal. activity er de seneste 10 hændelser og latest_approved de tre senest godkendte udtalelser.

Tilladelse: 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 et steds tjekliste for opsætning testimonials_setup_get

Returnerer punkterne import, testimonials, approve, ask, widget og teammate, hver med done og dismissed. Et punkt er færdigt ud fra det, stedet rummer, aldrig ved et klik. hidden er true, når hvert punkt er færdigt eller afvist, og det er, når indbakken holder op med at vise kortet.

Tilladelse: 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 Afvis ét punkt på opsætningens tjekliste eller hele kortet testimonials_setup_update

dismiss er én punktnøgle (import, testimonials, approve, ask, widget eller teammate) eller all for hele kortet. At afvise skjuler punktet og markerer det aldrig som færdigt, og det kan ikke bringes tilbage gennem API'et.

Tilladelse: 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 Godkend en udtalelse, så den må vises testimonials_approve

En udtalelse, der venter på kvote, kan ikke godkendes: serveren responderer med 422 og koden waiting_for_allowance. Svaret indeholder meta.undo_id.

Tilladelse: 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 Kør én handling over et udvalg af udtalelser eller over alt, hvad et filter matcher testimonials_bulk

Send ids (op til 100, kørt på én gang, alle eller ingen) eller filters med confirm_count (hele resultatet). Mere end 100 kører i baggrunden, 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 responderer med et undo-id, som testimonials_bulk_undo accepterer i 7 dage. delete_permanently er den ene handling, der ikke kan fortrydes: den kræver sites.manage, og dens svar siger undoable false. Over MCP køres de to handlinger, der sletter, trash og delete_permanently, ikke: værktøjet responderer med human_only og den side i appen, hvor en person gør det, og alle andre handlinger kører. Over API'et ændrer handlingen export (med ids eller filters og et valgfrit format af csv, json, ndjson eller xlsx) intet: den kræver analytics.export og responderer med 202 og den eksport, der skal hentes.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Fortryd en massehandling inden for 7 dage testimonials_bulk_undo

Sætter den tidligere værdi tilbage på hver udtalelse, kørslen ændrede. En, der er ændret igen siden, lades være og tælles i left. Over MCP køres en fortryd, der ville slette eller flytte til papirkurven, ikke (fortrydelse af en gendannelse, af en oversættelseskørsel og af en billedkørsel): værktøjet responderer med human_only og den side i appen, hvor en person gør det.

Tilladelse: 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 Tilføj en udtalelse manuelt eller via API'et testimonials_create

Gemmes gennem den ene indgang, alle ruter bruger. Den tæller med i planens månedlige kvote af nye udtalelser, og ved kvoten responderer serveren med 422 og koden allowance_reached (kun en kundes formularindsendelse holdes i stedet som ventende). Den samme person, der siger de samme ord igen, afvises med koden duplicate, medmindre allow_duplicate er true. Det samme external_id igen returnerer den, der allerede er gemt.

Tilladelse: 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 Slet en udtalelse permanent med dens historik, samtykkepost og filer testimonials_delete

Dette kan ikke fortrydes. Det virker på en udtalelse i papirkurven eller uden for den, kræver confirm og tilladelsen sites.manage. Over MCP sletter værktøjet intet og responderer med den side, hvor en person gør det.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 Flyt en udtalelse til papirkurven i 30 dage testimonials_trash

Udtalelsen beholder sin tilstand, tags, samlinger og filer, vises ingen steder og slettes permanent efter 30 dage. testimonials_restore sætter den tilbage præcis som den var. Svaret indeholder meta.undo_id. At lægge en i papirkurven, der allerede er der, ændrer intet. Over MCP ændrer værktøjet intet og responderer med den side i appen, hvor en person gør det.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Tæl udtalelserne bag hver filterværdi for de samme inputs som listen testimonials_facets

Bibliotekets form uden at læse nogen udtalelse. Hver facet tæller sine værdier med sit eget valg udeladt og hvert andet filter anvendt. meta indeholder totalen og filteret i ord.

Tilladelse: 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 Markér den bedste sætning i en udtalelse, eller ryd den testimonials_highlight

highlight skal være en nøjagtig del af udtalelsens ord, ellers responderer serveren med 422. En tom highlight rydder den. Hver ændring er en version i historikken.

Tilladelse: 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 hver version af en udtalelses ord, titel, vurdering og fremhævelse testimonials_history

Nyeste først. Version 1 er udtalelsen, som den blev modtaget, og har ingen forfatter. Hver senere version har det medlem, der lavede den, hvornår, den note, de efterlod, og for en gendannelse den version, den satte tilbage. Pagineret med page og per_page.

Tilladelse: 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 steds udtalelser, filtreret og sorteret testimonials_list

Tre måder at sige hvilke, og de lægges sammen: facet-inputtene (status, tag_id, has_video og resten), q (søgefeltet med dets operatorer, for eksempel rating:5 has:video tag:onboarding "saved us") og conditions med match (strukturerede rækker). Send facets som true for det levende antal bag hver facetværdi i meta.facets. Intet i papirkurven listes, medmindre trashed er true, som kun lister papirkurven.

Tilladelse: 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 Sæt en udtalelse tilbage til afventende testimonials_pend

Sætter en godkendt eller afvist udtalelse tilbage til afventende, så den ikke vises nogen steder, før der træffes en ny beslutning. Svaret indeholder meta.undo_id. En udtalelse i papirkurven afvises med koden in_trash.

Tilladelse: 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 Fastgør en udtalelse, så den vises først, eller fjern fastgørelsen testimonials_pin

En fastgjort udtalelse vises først, uanset hvor den vises. Send pinned false for at fjerne fastgørelsen. Svaret indeholder meta.undo_id, når noget er ændret.

Tilladelse: 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 Afvis en udtalelse. Den beholdes og vises ingen steder testimonials_reject

Udtalelsen beholder alt, hvad den har, og vises ingen steder. At afvise en, der allerede er afvist, ændrer intet. Svaret indeholder meta.undo_id, som testimonials_bulk_undo accepterer i 7 dage. En udtalelse i papirkurven afvises med koden in_trash.

Tilladelse: 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 Gendan en udtalelse fra papirkurven, præcis som den var testimonials_restore

Returnerer en udtalelse fra papirkurven til sin tilstand, sine tags, samlinger og de steder, der viste den. Den tæller aldrig som en ny udtalelse. En, der ikke er i papirkurven, afvises med koden not_in_trash.

Tilladelse: 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 Sæt ordene, titlen, vurderingen og fremhævelsen fra en tidligere version tilbage testimonials_restore_version

Intet fjernes fra historikken. Gendannelsen er en ny version, der siger, hvilken den kom fra. version 1 returnerer udtalelsen til ordene som modtaget. Et ukendt versionsnummer er en 422.

Tilladelse: 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 udtalelse med dens person, filer, samtykkepost, tags og hvor den bruges testimonials_get

Returnerer én af stedets udtalelser ud fra dens id (tm_...), i papirkurven eller ej. person.email er null, medmindre den kaldende har content.write, og has_email fortæller, om der er en registreret. media lister filerne med deres behandlingstilstand. used_in lister hver widget, væg og billede, der viser den.

Tilladelse: 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 de udtalelser, offentligheden må se, som offentligheden må se dem testimonials_showable

De nyeste godkendte udtalelser på et sted, der må vises offentligt, til en visning af din egen uden for widgets og vægge. Hver indeholder kun det, dens samtykkepost tillader: en person, hvis navn ikke må vises, hedder A customer, og et foto eller en optagelse udelades, medmindre det var tilladt. En afventende, afvist eller slettet udtalelse eller en, der venter på kvoten, listes aldrig. Der er ingen e-mail i svaret.

Tilladelse: 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 den næste udtalelse i en sorteringskø testimonials_triage

Uden filter er køen Afventende, ikke ventende på kvote, ældst modtaget først. Med indbakkens filtre er det det resultat i dets sortering. Send after med id'et på den netop behandlede for at få den næste. data er null, når køen er færdig. meta indeholder remaining og total.

Tilladelse: 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 udtalelse. Ændringer af ordene, titlen, vurderingen og fremhævelsen gemmes i dens historik testimonials_update

Kun de sendte inputs ændres. En ændring af body, title, rating eller highlight tilføjer en version til historikken med edit_note og ændrer aldrig det verificerede mærke. rating null rydder den. highlight skal være en nøjagtig del af ordene, og en tom rydder den. properties ændrer kun de sendte nøgler. add_tags og remove_tags tager navne eller id'er. Tilstand, fastgørelse og papirkurv har deres egne værktøjer. En udtalelse i papirkurven kan ikke redigeres.

Tilladelse: 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 '{…}'

Udtalelsesmedier

POST /sites/:site_id/testimonials/media/uploads.json Start en upload, eller tilføj en fil fra en webadresse testimonial_media_uploads_create

To måder. For at uploade send filename, content_type og byte_size: svaret indeholder upload med den url, filen skal PUT'es til, de headere, der skal sendes med, og for en stor fil dele, der kan sendes én ad gangen. Kald derefter testimonial_media_uploads_finish. Eller send source_url, så downloades og behandles filen for dig: poll testimonial_media_get, indtil dens tilstand er ready. Grænser: video og lyd op til 500 MB og så lang, som planen tillader (2 minutter på Pro, 10 minutter på Business, ingen på Free, hvor serveren responderer med 402 plan_limit), billeder op til 10 MB, et logo op til 2 MB.

Tilladelse: 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 Slet en fil, som ingen udtalelse beholder testimonial_media_delete

En fil, der tilhører en udtalelse, slettes med udtalelsen via papirkurven. De gemte filer slettes, og deres adresser ryddes fra cachen.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Sig, at en upload er færdig, så filen kontrolleres og behandles testimonial_media_uploads_finish

Kald den, når filen er sendt. Filen skal være i uploadlageret og have præcis den størrelse, der blev lovet. Det er sikkert at kalde den to gange.

Tilladelse: 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 igen testimonial_media_retry

Behandler filen igen fra den upload, der blev gemt. Uploaden gemmes i 24 timer efter en fejl. Derefter responderer serveren med not_retryable, og filen skal uploades igen.

Tilladelse: 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 dens tilstand og hvor den skal indlæses fra testimonial_media_get

url er den varige adresse på den færdige fil på medie-værten, og den er null, indtil tilstanden er ready. Adressen er den samme for alle og er ikke signeret, så giv kun adressen videre på en fil, hvis felt shareable er true.

Tilladelse: analytics.read

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

Undersøgelser

POST /sites/:site_id/surveys.json Opret en undersøgelse surveys_create

Opretter en cookiefri undersøgelse på webstedet. Den indsamler intet, før dens status er active, så opret den først som draft eller angiv status active for at starte med det samme. Påkrævet er name (internt, besøgende ser det aldrig, maks. 120 tegn) og questions (1 til 5 rækker i rækkefølge). Hvert spørgsmål er et objekt med key (valgfri, et stabilt id af små bogstaver, cifre og understregninger, genereres, hvis det udelades), kind (text, choice, multi, rating, nps eller yes_no), prompt (påkrævet, maks. 200 tegn), required (boolean), choices (en liste af op til 10 muligheder, kun for choice og multi) og scale (3, 5, 7 eller 10, kun for rating, standard 5). NPS bruger altid 0 til 10. Målretning er trigger_kind (immediate, delay, scroll, exit eller manual) med delay_seconds (0 til 600, standard 10, kun for delay) og scroll_percent (1 til 100, standard 50, kun for scroll), paths (rækker af match_type exact, prefix eller glob og pattern, tom betyder alle sider), devices (desktop, mobile, tablet, tom betyder alle), position (bottom_right, bottom_left eller center), sample_rate (1 til 100 procent af besøgende), thank_you (maks. 200 tegn), starts_on og ends_on (YYYY-MM-DD). Undersøgelser kan ikke bede om en e-mailadresse, og skrevne svar renses for personoplysninger. Free tillader 1 undersøgelse pr. arbejdsområde og et begrænset antal besvarelser om måneden, betalte abonnementer er ubegrænsede. Kræver rettigheden content.write. Returnerer undersøgelsen med id (svy_...). Læs svar med surveys_get.

Tilladelse: 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 Slet en undersøgelse med dens svar surveys_delete

Sletter en undersøgelse permanent sammen med alle dens besvarelser og svar. Det kan ikke fortrydes, og resultaterne går tabt. Brug i stedet surveys_pause, hvis du blot vil stoppe indsamlingen. Id'et kommer fra surveys_list, og site_id er påkrævet. Kræver rettigheden content.write. Returnerer den slettede undersøgelse.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Vis et steds undersøgelser med antal svar surveys_list

Viser et websteds undersøgelser, nyeste først, med deres indstillinger og antal besvarelser. Filtrér med status (draft, active, paused eller all, standard all). Med sideinddeling via page og per_page (standard 25, op til 100). Hver undersøgelse har id (svy_...), name, status, questions, målretningsindstillinger, starts_on, ends_on, created_at, updated_at og stats (antal responses, completed og this_month). Brug surveys_get til svarene og resultaterne for én undersøgelse.

Tilladelse: 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 Stop indsamling af svar og behold dem, der allerede er givet surveys_pause

Sætter en undersøgelse på pause, så den med det samme holder op med at blive tilbudt besøgende. Besvarelser, der allerede er indsamlet, bevares og vises i surveys_get, og surveys_start genoptager den. Brug den i stedet for surveys_delete, når du blot vil stoppe indsamlingen. Id'et kommer fra surveys_list, og site_id er påkrævet. Kræver rettigheden content.write. Returnerer undersøgelsen med status paused.

Tilladelse: 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øgelsesresultater for en periode, fordelt pr. spørgsmål surveys_get

Returnerer resultatrapporten for én undersøgelse over en periode, ikke kun dens indstillinger (brug surveys_list til indstillinger og antal). Vælg forudindstillingen period (standard 30d) eller period custom med from og to. Svaret har survey (dens indstillinger), period (from og to som ISO 8601-tidspunkter), responses (personer, der besvarede mindst ét spørgsmål), completed (personer, der besvarede det sidste spørgsmål), questions (én post pr. spørgsmål med key, kind, prompt og antal svar samt detaljer efter kind) og pages, devices og countries (op til 10 rækker hver med value og count). Detaljer efter kind er texts (op til 100 nyeste skrevne svar med text og at) for text, choices (value, count, share som procent med én decimal, offered) for choice, multi og yes_no, average (null uden svar), scale og distribution for rating samt score (NPS fra -100 til 100, null uden svar), promoters (9 og 10), passives (7 og 8), detractors (0 til 6) og distribution for nps. Brug surveys_themes til at opsummere skrevne svar.

Tilladelse: 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 Begynd at indsamle svar surveys_start

Sætter en undersøgelse til active, så den kan tilbydes besøgende. Den vises kun, når dags dato ligger inden for starts_on og ends_on (når de er sat), siden matcher dens paths og devices, og abonnementets månedlige kvote for besvarelser ikke er brugt op. Brug den til en draft eller en undersøgelse på pause. Id'et kommer fra surveys_list, og site_id er påkrævet. Kræver rettigheden content.write. Returnerer undersøgelsen med status active. Stop den igen med surveys_pause.

Tilladelse: 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 Gruppér de frie tekstsvar til ét spørgsmål i temaer (Business-planen) surveys_themes

Bruger AI til at gruppere de skrevne svar på ét fritekstspørgsmål i temaer. Kun Business-abonnement. Vælg den, efter surveys_get viser et tekstspørgsmål med nok svar, og angiv question_key (nøglen til et spørgsmål af kind text fra surveys_get). Den kræver mindst 5 skrevne svar og bruger de 300 seneste. Resultatet viser op til 12 temaer, hver med label, count, sentiment (positive, neutral eller negative) og example (et repræsentativt svar, kan være null), plus answers (hvor mange svar der blev opsummeret) og generated_at. Hver ny generering bruger ét spørgsmål af arbejdsområdets månedlige AI-kvote, som gives tilbage, hvis den fejler. Resultatet caches mod svarene, så et nyt kald uden nye svar ikke koster noget. Den fejler med en valideringsfejl, når abonnementet ikke inkluderer det, kvoten er brugt op, AI'en ikke er konfigureret, eller der er for få svar.

Tilladelse: 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 Opdater en undersøgelse surveys_update

Ændrer en undersøgelse. Kun de inputs, du sender, ændres. Inputs og grænser er de samme som i surveys_create, med status draft, active eller paused. Når du sender questions, erstattes hele listen, så medtag hvert spørgsmål, du vil beholde, og behold hver eksisterende key for at beholde de indsamlede svar (hvis du omformulerer en prompt med samme key, splittes resultaterne ikke). Spørgsmål, du udelader, holder op med at vises i resultater. Ændringer i målretningen træder i kraft for besøgende med det samme. Id'et kommer fra surveys_list, og site_id er påkrævet. Kræver rettigheden content.write. Returnerer den opdaterede undersøgelse.

Tilladelse: 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 '{…}'

Virksomheder bag udtalelser

GET /sites/:site_id/testimonials/companies.json List et steds virksomheder med deres personer, udtalelser og gennemsnitlige vurdering testimonial_companies_list

Én række pr. virksomhed, grupperet efter virksomhedsnavn og websted for stedets personer. En person uden virksomhed er i ingen. query matcher en del af et virksomhedsnavn eller af dets websteds vært. sort er name (standard), people_desc, testimonials_desc eller received_desc.

Tilladelse: 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 Flet en virksomhed ind i en anden, for to stavemåder af én virksomhed testimonial_companies_merge

Hver person i virksomheden i stien får navnet og URL'en på den virksomhed, der er angivet med into.

Tilladelse: 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 én virksomhed med dens personer testimonial_companies_get

Id'et er virksomhedens nøgle, en webstedsvært eller et normaliseret navn, som testimonial_companies_list returnerer den. Dens udtalelser er testimonials_list med company.

Tilladelse: 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 Ret en virksomheds navn og URL for alle dens personer på én gang testimonial_companies_update

En virksomheds id kommer fra dens URL eller navn, så svaret kan indeholde et nyt id.

Tilladelse: 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 '{…}'

Webhooks

GET /workspaces/:workspace_id/webhooks/:webhook_id/deliveries.json Vis leveringer for en webhook webhook_deliveries_list

Viser de leveringer, der er sendt til én webhook (stien tager webhook_id), nyeste først og med sideinddeling. Hver har id (whd_...), event, status (pending, succeeded for ethvert 2xx-svar, eller failed), status_code (null, når der ikke kom noget svar), error (en kort årsag som en timeout, ellers null), attempt (hvor mange forsøg indtil nu), duration_ms, payload (de JSON-data, der blev sendt), response_body (de første 2000 tegn af svaret) samt delivered_at og created_at. Filtrér med status succeeded eller failed. Brug den til at fejlsøge et endpoint og webhook_deliveries_redeliver til at sende en igen.

Tilladelse: 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 igen webhook_deliveries_redeliver

Sender en tidligere leverings payload igen som en ny levering til samme endpoint (id whd_..., fra webhook_deliveries_list). Det foretager en HTTP-forespørgsel til kundens URL, så modtageren kan behandle den samme hændelse to gange. Den er hastighedsbegrænset pr. arbejdsområde (delt med webhooks_test). Den sættes i kø, så svaret er en ny levering med status pending, læs webhook_deliveries_list for at se resultatet.

Tilladelse: 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 Tilføj et webhook-endpoint webhooks_create

Tilføjer et endpoint, der modtager POST'et JSON for arbejdsområdets hændelser (stien tager workspace_id). url skal være en offentlig https-adresse, private og interne adresser afvises. events er en påkrævet liste valgt blandt 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 signeringshemmelighed (whsec_...) genereres og returneres i svaret, og hver levering bærer en Privatus-Signature-header med et tidsstempel og en HMAC-SHA256 af body lavet med den. Fejlede leveringer prøves igen med backoff, og endpointet deaktiveres efter 20 fejl i træk. Brug webhooks_test til at sende et eksempel.

Tilladelse: 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 Slet en webhook webhooks_delete

Sletter et webhook-endpoint og hele dets leveringslog. Det kan ikke fortrydes, og afventende genforsøg stopper. Hvis du i stedet vil sætte det på pause, brug webhooks_update med enabled false. Id'et (wh_...) kommer fra webhooks_list. Returnerer den slettede webhook.

Tilladelse: 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 Vis webhooks webhooks_list

Viser et arbejdsområdes udgående webhook-endpoints (stien tager workspace_id), ældste først. Hvert har id (wh_...), url, events (de hændelsesnavne, det modtager), enabled, status (active, failing efter nylige fejl, eller disabled), secret (signeringshemmeligheden, behandl den som følsom), consecutive_failures, last_success_at, last_failure_at og created_at. Kræver rettigheden workspace.manage. Den er til at sende rå hændelser til din egen server. Brug notification_channels_list til at give besked til personer. Brug webhook_deliveries_list til, hvad der blev sendt.

Tilladelse: 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 ét webhook-endpoint via id (wh_..., fra webhooks_list), inklusive dets signeringshemmelighed (whsec_...), som bruges til at verificere headeren Privatus-Signature på hver levering. Felterne er url, events, enabled, status (active, failing eller disabled), secret, consecutive_failures, last_success_at, last_failure_at og created_at. Kræver rettigheden workspace.manage.

Tilladelse: 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

Sætter en webhook.test-levering med en eksempelbesked i kø til ét endpoint, selv når det er deaktiveret, hvilket foretager en HTTP-forespørgsel til kundens URL. Den er hastighedsbegrænset pr. arbejdsområde (delt med webhook_deliveries_redeliver), og en test prøves ikke igen. Leveringen sendes i baggrunden, så svaret returnerer den ventende levering med status pending. Læs webhook_deliveries_list et øjeblik senere for at se status_code, error, duration_ms og response_body.

Tilladelse: 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 Opdatér en webhook (hændelser, URL, aktiveret, roter hemmelighed) webhooks_update

Ændrer en webhook (id fra webhooks_list). Kun de inputs, du sender, ændres. Hvis du sender events, erstattes hele listen. Hvis du sætter enabled true på et deaktiveret endpoint, nulstilles dets fejltæller, og det er sådan, du slår et endpoint, der blev deaktiveret efter gentagne fejl, til igen. Sæt rotate_secret true for at generere en ny signeringshemmelighed, vist i svaret, og den gamle holder op med at virke med det samme, så modtageren skal opdateres. Reglerne for url er de samme som i webhooks_create. Returnerer webhooken.

Tilladelse: 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 '{…}'

Websted

GET /blog.json List blogindlæg blog_list

Lister indlæggene på Privatus Analytics-bloggen, nyeste først, med slug, title, kicker, rubric (resuméet i én sætning), description, path og datoer, og uden brødtekst. Brug blog_get med dens slug for at læse ét. Pagineret med page og per_page (maksimum 100). Offentlig, ingen godkendelse nødvendig.

Tilladelse: public

Eksempel
curl https://privatusanalytics.com/blog.json
GET /blog/:slug.json Læs et blogindlæg (Markdown og HTML) blog_get

Returnerer ét blogindlæg ud fra dets slug (fra blog_list, den sidste del af /blog/<slug>) med dets overskrifter, dets Markdown-brødtekst og den gengivne HTML. Indlæg er skrevet på engelsk. Offentlig, ingen godkendelse nødvendig.

Tilladelse: public

Eksempel
curl https://privatusanalytics.com/blog/:slug.json
GET /changelog.json Vis poster i ændringsloggen changelog_list

Udgivne produktopdateringer, nyeste først. Også tilgængelig som RSS på /changelog.rss.

Tilladelse: public

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

Browserklienter sender et Cloudflare Turnstile-token som `cf-turnstile-response`. Forespørgsler med et API-token behøver intet.

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/contact.json \
  -H "Content-Type: application/json" -d '{…}'
POST /newsletter/confirm.json Bekræft et nyhedsbrevsabonnement (signeret token) newsletter_confirm

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/newsletter/confirm.json \
  -H "Content-Type: application/json" -d '{…}'
POST /newsletter.json Tilmeld en e-mailadresse til nyhedsbrevet newsletter_subscribe

Browserklienter sender et Cloudflare Turnstile-token som `cf-turnstile-response`. Forespørgsler med et API-token behøver intet.

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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

Samme data som prissiden: hændelsestrappen, alle abonnementsgrænser og hvad der tæller som en hændelse. Angiv events for at få det matchende niveau.

Tilladelse: public

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

Tilstand for database, Redis og baggrundsjob, kontrolleret højst hvert 15. sekund.

Tilladelse: public

Eksempel
curl https://privatusanalytics.com/status.json
GET /tools/header-checker.json Kontrollér en sides Referrer-Policy og CSP for analyse tools_header_check

Henter én offentlig side og tjekker de svarheadere, der påvirker analyser. Brug den, når sporingsdata mangler, eller henvisere ser forkerte ud. Den ser på Referrer-Policy, direktiverne script-src og connect-src i Content-Security-Policy (om Privatus Analytics må indlæse og sende data), Permissions-Policy og antallet af Set-Cookie-headere. Returnerer url (den endelige URL efter op til 3 omdirigeringer), status (HTTP-status) og findings, hver med check, value (kan være null), level (ok, warn eller info) og en note i klart sprog. URL'en skal være http eller https og offentlig, private og interne adresser afvises, kun de første 1 MB læses, og hentningen får timeout efter 5 sekunder. Hastighedsbegrænset til 10 kald i minuttet pr. klient. Offentligt, ingen godkendelse nødvendig.

Tilladelse: public

Eksempel
curl https://privatusanalytics.com/tools/header-checker.json
GET /tools/privacy-policy-generator.json Skriv et udkast til et afsnit i privatlivspolitikken for Privatus Analytics tools_privacy_policy

Udarbejder et udkast til et afsnit i en privatlivspolitik, der beskriver, hvordan Privatus Analytics indsamler data på kundens websted (cookiefrit, ingen personoplysninger gemt, kun land som lokation). Det er et udgangspunkt, ikke juridisk rådgivning. Inputs er site_name (op til 120 tegn), contact_email (valgfri, tilføjer en kontaktsætning) og honors_gpc (standard true, tilføjer en sætning om, at Do Not Track og Global Privacy Control respekteres). Returnerer site_name, paragraphs (array af strenge), text (afsnittene sat sammen med tomme linjer, med adressen på Privatus Analytics i parentes efter navnet) og html (afsnittene som <p>-elementer, med navnet som et almindeligt link). Teksten skrives på forespørgslens sprog, som standard engelsk. Den foretager ingen ændringer på nogen konto. Offentligt, ingen godkendelse nødvendig.

Tilladelse: public

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

Genererer en QR-kode som et SVG-billede til tryk eller plakater. Kombinér den med et link med UTM-parametre fra tools_utm_builder. Inputs er text (URL'en eller teksten, op til 1.000 tegn) og level (fejlkorrektion l, m, q eller h, standard m, højere tåler mere skade, men kræver en tættere kode). Returnerer text, level, size (moduler pr. side) og svg (et selvstændigt SVG-dokument, sort på hvid). Tekst, der er for lang til det valgte niveau, afvises. Til QR-koder for sporede korte links, brug i stedet links_qr. Offentligt, ingen godkendelse nødvendig.

Tilladelse: public

Eksempel
curl https://privatusanalytics.com/tools/qr-code.json
GET /tools/tracker-scanner.json Vis cookies og kendte trackere på en side tools_tracker_scan

Henter én offentlig side og viser de cookies, den sætter, og de kendte tredjepartstrackere, den refererer til. Brug den til et hurtigt tjek af, hvad en side indlæser, før du vælger en samtykketilgang. Det er en statisk scanning af kun HTML og svarheadere, den kører ikke JavaScript, så cookies sat af scripts og tags, der indlæses senere af en tag manager, overses. Returnerer url (endelig URL efter op til 3 omdirigeringer), status, truncated (true, når kun de første 1 MB blev læst), cookies (name, domain, path, expires, secure, http_only og same_site, værdier returneres aldrig), trackers (name, category, match og evidence, hvor category er advertising, analytics, session_recording, tag_manager, marketing eller privacy_analytics) og third_party_hosts (sorterede værtsnavne på andre websteder). URL'en skal være offentlig http eller https, med 5 sekunders timeout for hentning, og kald er begrænset til 10 i minuttet pr. klient. Offentligt, ingen godkendelse nødvendig.

Tilladelse: public

Eksempel
curl https://privatusanalytics.com/tools/tracker-scanner.json
GET /tools/utm-builder.json Byg en kampagne-URL med UTM-parametre tools_utm_builder

Bygger en kampagne-URL med UTM-parametre og markerer almindelige fejl. Inputs er url (skal være http eller https), source, medium og campaign (alle påkrævede) samt valgfri term og content. Eksisterende utm_-parametre på URL'en erstattes, og andre forespørgselsparametre bevares. Returnerer url (det færdige link), params (de utm_-værdier, der blev tilføjet, tomme udeladt) og warnings (strenge for værdier med store bogstaver, mellemrum eller tekst, der ligner en e-mailadresse eller et langt tal, hvilket aldrig bør stå i en URL). Brug værdier med små bogstaver og uden mellemrum, så den samme kampagne ikke splittes op i flere rækker i rapporter. Den gemmer intet. Offentligt, ingen godkendelse nødvendig.

Tilladelse: public

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

Browserklienter sender et Cloudflare Turnstile-token som `cf-turnstile-response`. Forespørgsler med et API-token behøver intet.

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

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

Websteder

POST /sites/:site_id/data_reset.json Slet alle hændelser og besøg i et datointerval (kører i baggrunden, kan ikke fortrydes) sites_reset_data

Sletter uigenkaldeligt et websteds sidevisninger, brugerdefinerede hændelser og besøg for et datointerval og kan ikke fortrydes. Brug den til at rydde testtrafik eller fjerne en dårlig periode. Den sletter ikke webstedet, dets mål eller indstillinger (brug sites_delete til webstedet). from og to er YYYY-MM-DD-datoer, begge inklusive og læst i webstedets tidszone, og to må ikke ligge før from. confirm skal være webstedets domæne præcis som vist af sites_get (store og små bogstaver er ligegyldige). Forespørgslen accepteres og returnerer med det samme med status queued, site_id, from og to. Sletningen kører i baggrunden i bidder, så tallene i statistikværktøjerne kan have brug for lidt tid til at falde til ro, og der er intet statusendpoint at hente, tjek statistikværktøjerne, indtil intervallet er tomt. Handlingen noteres i revisionsloggen. Kræver rettigheden sites.manage.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 Filtreret trafikoversigt: bots, trafikregler eller PII-redigeringer efter årsag og land (kun tællinger) sites_filter_stats

Antal hits, der blev droppet eller renset før lagring, over de seneste dage. Brug den til at se, hvor meget bottrafik, regelblokeret trafik eller redigering et websted har. Vælg kind med bot (hits droppet som bots), rule (hits droppet af trafikregler) eller redaction (værdier redigeret af scrubberen for personoplysninger). Returnerer kind, days, total, by_reason, by_country og by_day. by_reason og by_country er lister af {value, count} (op til 50, største først, value null når ukendt), og by_day er en liste af {date, count}. days begrænses til mellem 1 og 395 og er som standard 30. Det er kun samlede tal. Der gemmes ingen IP-adresser, user agents eller redigerede værdier, så intet kan spores til en person. Disse hits tælles ikke som hændelser i faktureringen. Brug traffic_rules_list til at se eller ændre reglerne.

Tilladelse: analytics.read

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

Viser, hvilke arbejdsområdemedlemmer der kan se ét websted. Alle arbejdsområdets medlemmer vises i den rækkefølge, de kom med, uden sideinddeling. Felterne er membership_id (det uuid, sites_access_update bruger), email, name, role, access (true, når medlemmet kan se dette websted) og locked (true for ejere og administratorer, som altid har adgang og ikke kan ændres). Andre medlemmer har adgang, når de har alle websteder eller en eksplicit tilladelse til dette websted. Brug members_list til at se et medlems fulde webstedsliste. Kræver members.manage.

Tilladelse: members.manage

Eksempel
curl https://privatusanalytics.com/sites/:site_id/access.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:site_id/access.json Giv eller fjern ét medlems adgang til dette websted sites_access_update

Giver eller fjerner ét medlems adgang til ét websted. membership_id kommer fra sites_access_list (eller members_list), og access er true for at give eller false for at fjerne. Ejere og administratorer har altid adgang og kan ikke ændres. Hvis du fjerner adgang fra et medlem, der havde alle websteder, skiftes medlemmet til en eksplicit liste over alle andre websteder i arbejdsområdet, og medlemmets include_future_sites slås fra, så de ikke får websteder, der oprettes senere. Hvis du giver adgang til en, der allerede har alle websteder, ændres intet. Du kan ikke ændre et medlem, der har rettigheder, du mangler, eller websteder ud over dine. Kræver members.manage. Returnerer det medlems række i samme form som sites_access_list.

Tilladelse: members.manage · Kun HTTP (ikke et MCP-værktøj)

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 Markér et websted med stjerne (fastgjort øverst under Alle websteder) sites_favorite

Markerer et websted med stjerne for den kaldende bruger, så det vises først i sites_list og på siden Alle websteder. Det påvirker kun kalderen, aldrig andre medlemmer, og hvis du markerer et allerede markeret websted, ændres intet. Kaldet kræver ikke andet input end websteds-id'et. Brug sites_unfavorite til at fjerne stjernen. Kræver analytics.read. Returnerer webstedet (se sites_get), med favorite true.

Tilladelse: 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 websted sites_unfavorite

Fjerner den kaldende brugers stjerne fra et websted, så det ikke længere er fastgjort først i sites_list. Det påvirker kun kalderen og gør ingenting, hvis webstedet ikke var markeret. Brug sites_favorite til at markere det igen. Kræver analytics.read. Returnerer webstedet (se sites_get), med favorite false.

Tilladelse: 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 Installationsstatus og kodestump for et websted sites_setup_get

Returnerer, hvad der skal til for at installere sporing på et websted, og om der er kommet data. Felterne er site_id, snippet (det færdige HTML-scripttag til at indsætte med alle tracker-moduler aktiveret), receiving_data (true, når den første hændelse er modtaget) og first_event_at (ISO 8601, null indtil da). Hent den gentagne gange efter installationen for at se, om hændelser kommer ind. Brug i stedet tracking_snippet, når du vil have et tilpasset snippet (valgte moduler, manuelle sidevisninger, SPA-tilstand, masker), og tracking_verify til at hente den live side og tjekke, at scriptet er til stede. Kræver analytics.read.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:site_id/setup.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
POST /transfers/:token/accept.json Acceptér en overdragelse af et websted til et af dine arbejdsområder site_transfers_accept

Accepterer en invitation til overførsel af et websted og flytter webstedet ind i et af kalderens arbejdsområder. Stiparameteren token er fra invitationslinket, og workspace_id er målarbejdsområdet (ws_...), hvor kalderen har sites.manage. Kalderens egen e-mail skal matche den adresse, invitationen blev sendt til, og målet kan ikke være det arbejdsområde, webstedet kom fra. Webstedet beholder sit id, sine indstillinger, mål og data, men tilladelser pr. medlem ryddes, og dets delte links flyttes til det nye arbejdsområde. Den fejler, når invitationen ikke længere afventer eller er udløbet, når målet har nået sit abonnements webstedsgrænse, eller når det allerede har et aktivt websted med samme domæne. Flytningen kan ikke fortrydes, undtagen ved at overføre tilbage. Et token, der kalder dette, skal tilhøre målarbejdsområdet og have sites.manage. Returnerer overførslen med status accepted.

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/transfers/:token/accept.json \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/transfer.json Start overdragelse af et websted til et andet arbejdsområde (sender en e-mail til modtageren) sites_transfer_start

Starter flytningen af et websted til et andet arbejdsområde ved at sende modtageren en invitationslink på e-mail, som er gyldigt i 7 dage. Intet flyttes, før modtageren logger ind med den e-mail og accepterer (site_transfers_accept), så webstedet bliver her indtil da. Hvis du starter en ny overførsel, annulleres enhver tidligere afventende for samme websted. email skal være en gyldig adresse, og modtageren vælger målarbejdsområdet. Overførselsmails er hastighedsbegrænsede. Brug sites_transfer_cancel til at trække den tilbage. Kræver sites.manage. Returnerer overførslen med site_id, site_domain, from_workspace, to_email, status pending og expires_at.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 Annullér en afventende overdragelse af et websted sites_transfer_cancel

Annullerer webstedets afventende overførselsinvitation, så dens link holder op med at virke. Den fejler med en valideringsfejl, når ingen overførsel afventer. En overførsel, der allerede er accepteret, kan ikke annulleres. Kræver sites.manage. Returnerer overførslen med status canceled.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 afventende overdragelse ud fra dens token fra e-mailen site_transfers_get

Viser en invitation til overførsel af et websted ud fra tokenet i dens link (stiparameteren token, fra invitationsmailen sendt af sites_transfer_start). Kalderen skal være logget ind eller bruge et API-token. Returnerer site_id, site_domain, from_workspace (det afsendende arbejdsområdes navn), to_workspace_id (null, indtil den er accepteret), to_email (den inviterede adresse), status (pending, accepted eller canceled) og expires_at. Invitationer udløber 7 dage efter, de er sendt. Brug site_transfers_accept til at acceptere den.

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl https://privatusanalytics.com/transfers/:token.json
POST /workspaces/:workspace_id/sites.json Tilføj et websted sites_create

Tilføjer et websted til et arbejdsområde og returnerer det, inklusive sporingskoden, der skal installeres. Arbejdsområdets abonnement begrænser antallet af websteder (Free tillader 3), og kaldet fejler med en fejl om abonnementsgrænsen, når den er nået. domain er påkrævet og normaliseres (for eksempel reduceres en fuld URL eller et www-præfiks til værtsnavnet). name er som standard domænet, timezone er som standard arbejdsområdets tidszone (et IANA-navn som Europe/Berlin) og currency arbejdsområdets valuta (en ISO 4217-kode på 3 bogstaver som USD). Bivirkninger er en site.created-notifikation til arbejdsområdets notifikationskanaler, at en første SEO-sideaudit og en tjek af domænevurdering sættes i kø, og en e-mail med sporingskoden til det medlem, der oprettede det (med påmindelser, mens der ikke kommer data). Medlemmer begrænset til udvalgte websteder, som har tilmeldt sig fremtidige websteder, får adgang til det. Kræver sites.manage. Følg op med tracking_snippet eller sites_setup_get for at installere og tracking_verify for at kontrollere.

Tilladelse: 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 Slet et websted (ryddes efter 7 dage) sites_delete

Sletter et websted. Det er en blød sletning, webstedet holder op med at indsamle og forsvinder fra lister med det samme, og dets data slettes permanent efter 7 dage, så betragt det som uigenkaldeligt og kontakt supporten hurtigt, hvis det var en fejl. confirm skal være webstedets domæne (store og små bogstaver er ligegyldige). Afventende overførsler for webstedet annulleres, og en site.deleted-notifikation sendes til arbejdsområdets notifikationskanaler. Brug sites_reset_data, hvis du kun vil rydde noget af trafikken og beholde webstedet. Kræver sites.manage. Returnerer webstedet.

Tilladelse: sites.manage · Kun HTTP (ikke et MCP-værktøj)

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 Vis websteder i et arbejdsområde sites_list

Viser de websteder i et arbejdsområde, kalderen kan tilgå, med sideinddeling og med kalderens stjernemarkerede websteder først. Brug query til at søge i domæne eller navn (delvist, uden forskel på store og små bogstaver), label til kun at beholde websteder med én label og sort som position (den gemte rækkefølge, standard), name eller visitors (besøgende inden for de seneste 30 dage, flest først). Svarets meta har sideinddeling pr. side plus stats, et objekt med websteds-id som nøgle med visitors (seneste unikke besøgende), change (procentvis ændring i forhold til den foregående periode), sparkline (en liste af daglige værdier) og live (aktuelle besøgende), og totals for siden. Hvert element har de samme felter som sites_get. Det er udgangspunktet for at finde de websteds-id'er (pa_...), som alle andre webstedsværktøjer bruger. Kræver analytics.read.

Tilladelse: analytics.read

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

Returnerer ét websteds indstillinger og status via dets offentlige id (pa_..., fra sites_list). Nøglefelter er id, workspace_id (ws_...), domain, name, extra_domains og multi_domain_mode (combined eller separate), timezone (IANA-navn), currency (ISO 4217), labels, privatlivsindstillinger (honor_dnt, honor_gpc, pii_scrubber, redaction_rules, allowed_params, path_masks), retention_months (null betyder behold alle data), bot_filtering, traffic_rule_modes (et objekt, der knytter en regelliste til block eller allow), vitals_sample_rate (en procent), conversion_denominator (visits eller visitors), public_dashboard og public_indexable, ingest_key_prefix (null, når webstedet ikke har nogen nøgle til crawlerlogge), verified_at, first_event_at og last_event_at (null, indtil der kommer data), domain_rating (kan være null), snippet (HTML-sporingstagget), favorite (om kalderen har markeret det med stjerne) og created_at. Kræver analytics.read.

Tilladelse: analytics.read

Eksempel
curl https://privatusanalytics.com/sites/:id.json \
  -H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH /sites/:id.json Opdatér webstedsindstillinger sites_update

Opdaterer et websteds indstillinger og ændrer kun de felter, du sender. Navne- og identitetsfelter er name, domain (en ændring tjekker domain rating igen), extra_domains (en liste af værtsnavne) og multi_domain_mode (combined tæller én besøgende på tværs af domæner, separate holder dem adskilt). timezone er et IANA-navn og currency en ISO 4217-kode på 3 bogstaver. Privatlivsfelter er honor_dnt, honor_gpc, pii_scrubber, redaction_rules (en liste af objekter med name og pattern, hvor pattern er et regulært udtryk), allowed_params (forespørgselsparametre, der skal beholdes), path_masks (en liste af objekter med pattern og replacement) og bot_filtering. Lister erstatter hele den eksisterende liste. retention_months må ikke overstige abonnementets opbevaring (Free 6 måneder). traffic_rule_modes knytter en regelliste (hostnames, paths, referrers, countries, ip_ranges, user_agents eller events) til block eller allow. vitals_sample_rate er en procent, og abonnementet sætter loftet (10 på Free, 100 på betalte abonnementer). conversion_denominator er visits eller visitors. public_dashboard gør statistikker synlige for alle med linket, og public_indexable lader søgemaskiner indeksere den side. Ændringer træder i kraft for nye hændelser inden for få øjeblikke. Kræver sites.manage. Returnerer det opdaterede websted.

Tilladelse: sites.manage

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

Webstedsaudit

GET /sites/:site_id/audit/issues.json Vis problemerne i en webstedsaudit, én række pr. kontrol site_audit_issues_list

Viser problemerne i én audit, én række pr. kontrol, der markerede noget, værst først (fejl, derefter advarsler, derefter noter, hver efter berørte URL'er). Hver række har check_key (brug den med site_audit_issues_get og værktøjerne til at dæmpe), title, category, severity (error, warning eller notice), affected (markerede URL'er, dæmpede er udeladt), added og fixed (ændringer siden den foregående audit) og pageviews (besøg på berørte sider i de 30 dage før auditten). Som standard den seneste færdige audit, eller angiv audit_id. Filtrér med severity, category og new_only (kun kontroller med URL'er, der er nye siden den foregående audit). Med sideinddeling via page og per_page (maks. 100, standard 50). Brug site_audit_issues_get for at se, hvilke URL'er en kontrol markerede. Kræver analytics.read.

Tilladelse: 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 kontrol i webstedsauditten: hvorfor den er vigtig, hvordan den rettes og de berørte URL'er site_audit_issues_get

Detaljer om én kontrol i en audit, via check_key fra site_audit_issues_list (fx title_missing). Returnerer audit_id, issue (den samme række som i listen), why (hvad problemet betyder), fix (hvordan det rettes), muted (true, hvis hele kontrollen er dæmpet for webstedet) og urls, de markerede URL'er med page_id (brug det med site_audit_pages_get), url, pageviews, detail (ekstra fakta om fundet, kan være tom), is_new og muted. sort er pageviews (standard, travleste først) eller url. Med sideinddeling via page og per_page (maks. 100, standard 25). Som standard den seneste færdige audit, eller angiv audit_id. Dæmpede URL'er sorteres sidst. Kræver analytics.read.

Tilladelse: 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 Gør en webstedsauditkontrol tavs på flere URL'er, eller flere hele kontroller, i ét kald site_audit_mutes_bulk

Dæmper mange fund i én forespørgsel, alt eller intet. Brug en af to former. Send enten check_key plus urls (op til 100 URL'er) for at dæmpe én kontrol på flere sider, eller send check_keys (op til 100) for at dæmpe hele kontroller for webstedet. Bland ikke urls med check_keys. En ukendt kontrol eller en ugyldig URL får hele forespørgslen til at fejle og dæmper intet. Poster, der allerede er dæmpet, returneres, som de er. Den seneste audits antal og score opdateres én gang til sidst. Returnerer listen af dæmpninger. Fortryd hver med site_audit_mutes_delete. Kræver content.write.

Tilladelse: 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 Gør en kontrol i webstedsauditten tavs, for hele webstedet eller én URL site_audit_mutes_create

Dæmper én kontrol for webstedet eller kun for én URL. check_key kommer fra site_audit_issues_list. Udelad url for at dæmpe kontrollen overalt, eller angiv en fuld URL (som https://example.com/old) for kun at dæmpe den på den side, hvor URL'en normaliseres, som crawleren gør. Den seneste audits antal og score opdateres med det samme. Hvis du dæmper det samme to gange, returneres den eksisterende dæmpning i stedet for en fejl. Brug site_audit_mutes_bulk til at dæmpe mange på én gang og site_audit_mutes_delete til at fortryde. Kræver content.write.

Tilladelse: 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 Ophæv tavsheden for en kontrol i webstedsauditten site_audit_mutes_delete

Fjerner en dæmpning, fundet via dens id fra site_audit_mutes_list, så kontrollen eller URL'en tæller med i auditscoren igen. Den seneste audit tælles om med det samme. Det fjerner kun dæmpningen og sletter ikke auditdata. Returnerer den fjernede dæmpning. Kræver content.write.

Tilladelse: 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 Vis de kontroller, et websted har gjort tavse site_audit_mutes_list

Viser de kontroller, der er dæmpet for webstedet, nyeste først. En dæmpning skjuler en kontrol enten for hele webstedet (url er null) eller for én URL, så de fund holdes ude af antal og score, selv om audits stadig registrerer dem. Hver række har id (et dæmpnings-id, brug det med site_audit_mutes_delete), site_id, check_key, title, url (null for en dæmpning for hele webstedet), muted_by (medlemmets navn, null hvis ukendt) og created_at. Filtrér med check_key. Med sideinddeling via page og per_page (maks. 100). Kræver analytics.read.

Tilladelse: 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å din auditopsummering på e-mail for et websted til eller fra site_audit_notifications_update

Slår den ugentlige audit-oversigtsmail til eller fra for det kaldende medlem på ét websted. Det er en personlig præference og påvirker ikke andre medlemmer. enabled true sender medlemmet oversigten efter audits af dette websted, false stopper det. Returnerer site_id, enabled og all_sites_enabled (false, når medlemmet har slået audit-mails fra for alle websteder i sine kontoindstillinger, hvilket tilsidesætter denne). Ethvert medlem med analytics.read kan ændre sin egen indstilling.

Tilladelse: 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 Vis og filtrer siderne i en webstedsaudit site_audit_pages_list

Sideudforskeren, der viser URL'erne i én audit (som standard den seneste færdige, eller audit_id). kind er page (standard, HTML-dokumenter), resource (billeder, scripts, typografiark) eller external (links til andre websteder). Filtrér efter state (queued, fetched, skipped, blocked, failed), status_class (2xx, 3xx, 4xx eller 5xx), indexable, in_sitemap, has_issues (tæller kun ikke-dæmpede problemer), depth (klik fra startsiden) og query (tekst i URL'en eller titlen). sort er pageviews (standard), inlinks, depth, response_ms (langsomste først) eller word_count (færrest først). Hver række har id (et UUID til 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 (antal). Med sideinddeling via page og per_page (maks. 100). Kræver analytics.read.

Tilladelse: 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 auditeret side: dens metadata, problemer, indgående og udgående links site_audit_pages_get

Alt, hvad auditten har gemt om én URL, via id (et 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, sociale tags, images_count, images_missing_alt, linkantal, link_score, in_sitemap, has_tracker, pageviews og search_clicks, fetched_at og mere), redirect_target_id (den side, den omdirigerer til inden for auditten, eller null), issues (check_key, title, category, severity, detail, is_new, muted) samt inlinks og outlinks (op til 100 hver med page_id, url, status, kind, anchor, nofollow, count). Kræver analytics.read.

Tilladelse: 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 et steds auditindstillinger site_audit_settings_get

Returnerer webstedets auditindstillinger. Felterne er site_id, enabled (planlagte audits til eller fra, til som standard), include_subdomains, check_external_links, exclude_paths, ignored_params, extra_start_urls, next_run_at (hvornår den næste planlagte audit forfalder, null hvis ingen), page_limit (sider pr. audit i det nuværende abonnement, null når ubegrænset) og interval_days (dage mellem planlagte audits i abonnementet). Et websted, der aldrig har ændret sine indstillinger, returnerer standardværdierne. Ændr dem med site_audit_settings_update. Kræver sites.manage.

Tilladelse: 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 Ændr et steds auditindstillinger site_audit_settings_update

Ændrer, hvordan webstedet auditeres. Kun de inputs, du sender, ændres. enabled slår planlagte og manuelle audits til eller fra (hvis du slår den til, planlægges den næste audit ét abonnementsinterval ude). include_subdomains og check_external_links er booleans. De tre lister erstatter den gemte liste, de flettes ikke, så send den fulde liste. exclude_paths er stipræfikser, som crawleren springer over, og hver skal begynde med en skråstreg (op til 50). ignored_params er navne på forespørgselsparametre, der aldrig udgør en anden side, som utm_source eller sessionid (op til 50, bogstaver, cifre, punktum, bindestreg, understregning). extra_start_urls er fulde http- eller https-URL'er, der skal crawles ud over forsiden (op til 20). En liste kan også sendes som tekst med én post pr. linje. Returnerer de opdaterede indstillinger. Kræver sites.manage.

Tilladelse: 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 Afmeld e-mails med webstedsauditopsummeringer med tokenet fra en e-mail site_audit_unsubscribes_create

Tilladelse: public · Kun HTTP (ikke et MCP-værktøj)

Eksempel
curl -X POST https://privatusanalytics.com/audit/unsubscribe/:token.json \
  -H "Content-Type: application/json" -d '{…}'
POST /sites/:site_id/audit/cancel.json Annuller den webstedsaudit, der kører site_audit_cancel

Stopper den audit, der kører eller er i kø for webstedet. Auditten markeres som canceled, og intet fra den ufærdige crawl rapporteres. En annulleret audit bruger ikke Free-abonnementets månedlige kvote. Fejler med en valideringsfejl, hvis ingen audit er live. Returnerer den annullerede audit. Kræver content.write.

Tilladelse: 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 webstedsaudits: tilføjede og rettede URL'er pr. kontrol site_audit_compare

Sammenligner to audits af webstedet, kontrol for kontrol. audit_id er den nyere audit og base_id den ældre. Begge har fornuftige standardværdier (den seneste færdige audit mod den færdige audit før den), og værktøjet bytter dem om, hvis du angiver dem i den forkerte rækkefølge. Returnerer audit og base (hver en oversigt over en audit, base er null, hvis der ikke er noget tidligere) og checks, ét objekt pr. kontrol, hvis URL'er har ændret sig, med check_key, title, category, severity, base_affected, affected, added og fixed (antal URL'er), sorteret med fejl først. Kontroller uden ændring udelades. For to på hinanden følgende audits er added og fixed nøjagtige, for audits længere fra hinanden er de nettoændringen. Kræver analytics.read.

Tilladelse: 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 webstedsaudit nu site_audit_run

Starter en ny crawl og SEO-audit af webstedet nu. Den crawler webstedets offentlige sider i baggrunden, så den returnerer med det samme med den nye audit i status queued. Hent site_audit_get (feltet live) eller site_audit_history gentagne gange, indtil status er complete. Afvises med en valideringsfejl, når auditten er slået fra i site_audit_settings_update, når en anden audit allerede er i kø eller kører, når en manuel audit blev startet inden for de seneste 24 timer, og på Free, når en audit er kørt inden for de seneste 30 dage (fejlede og annullerede tæller ikke). Ubekræftede websteder uden hændelser er desuden begrænset til én audit om dagen pr. domæne. Antallet af crawlede sider begrænses af abonnementet (Free 100, Pro 1.000, Business 10.000). Tjek først can_run i site_audit_get. Kræver content.write.

Tilladelse: 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 Vis et steds audits, nyeste først site_audit_history

Viser webstedets audits, 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, indtil den er færdig), score_band, page_limit, pages_crawled, urls_discovered, errors, warnings, notices, new_issues, fixed_issues, failure (årsag, når den fejlede, ellers null) og tidsstemplerne. Filtrér med status. Med sideinddeling via page og per_page (maks. 100). Brug id'erne med site_audit_get, site_audit_compare og værktøjerne til problemer og sider. Brug site_audit_get til den aktuelle tilstand for én audit. Kræver analytics.read.

Tilladelse: 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 overblikket over webstedsauditten: score, antal, vigtigste problemer efter trafik og den audit, der kører nu site_audit_get

Oversigten over SEO-auditten af webstedet, det bedste første kald til spørgsmål om audits. Som standard beskriver den den seneste færdige audit, eller angiv audit_id (aud_..., fra site_audit_history) for en ældre. Resultatet har audit (den færdige audit med score 0 til 100, score_band, score_delta, antal fejl, advarsler og noter, pages_crawled, page_limit, capped, summary og robots-detaljer, eller null, hvis ingen er færdig), live (den audit, der kører nu, eller null), enabled og next_run_at (tidsplanen), can_run med run_blocked (live, disabled eller too_soon) og run_allowed_at (hvornår site_audit_run er tilladt igen), changes (antal tilføjede og rettede URL'er pr. alvorlighed), trend (op til 30 seneste scorer som id, finished_at, score), top_issues (op til 10 kontroller rangeret efter alvorlighed og derefter sidevisninger på de berørte sider) og email_enabled (din egen præference for oversigtsmailen). Følg op med site_audit_issues_list for alle problemer og site_audit_pages_list for URL'er. Kræver analytics.read.

Tilladelse: analytics.read

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

Widgets

POST /sites/:site_id/testimonials/widgets/:id/copied.json Notér, at en widgets indsatte HTML-indlejring blev kopieret testimonial_widgets_mark_copied

Den indsatte HTML opdateres ikke af sig selv. Efter dette kald rapporterer testimonial_widgets_embed, hvor mange gange widgetten er ændret siden.

Tilladelse: 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 Opret en widget testimonial_widgets_create

Ét kald bærer hele widgetten: layoutet og dets valg, hvad der fodrer den, hvad hvert kort viser, og hvordan den ser ud. Alt, der udelades, starter fra en standard, og en tom stilindstilling arver brandkittet. Følg op med testimonial_widgets_embed for at få koden til at indsætte.

Tilladelse: 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 Flyt en widget til papirkurven testimonial_widgets_trash

Dens indlejringer gengiver intet og fylder intet, indtil den gendannes. Den slettes for altid efter 30 dage. Over MCP ændrer værktøjet intet og responderer med den side i appen, hvor en person gør det.

Tilladelse: content.write · Kun HTTP (ikke et MCP-værktøj)

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 Kopiér en widget med hver indstilling testimonial_widgets_duplicate

Laver en kopi med et nyt id og navnet sluttende på "copy". Kopien har sin egen indlejringskode og er ikke set live nogen steder. Originalen ændres ikke.

Tilladelse: 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 en widgets indlejringskode og hvad den vejer testimonial_widgets_embed

Returnerer script-koden (anbefalet), den indsatte HTML, frame-koden og adressen på de offentlige data med den målte størrelse af indlæsningsscriptet og af denne widget. Den indsatte HTML og framen er null for hjørnepopup'en.

Tilladelse: 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 et steds widgets testimonial_widgets_list

Widgets i papirkurven listes ikke. Hver widget bærer sine indstillinger, hvor mange udtalelser den viser nu, sine visninger og klik de seneste 30 dage og den første side, den blev set live på.

Tilladelse: 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 de sider, en widget blev set live på testimonial_widgets_installs

Op til 50 sider, de nyeste først. Kun scriptet og framen kan registreres.

Tilladelse: 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 Gendan en widget fra papirkurven testimonial_widgets_restore

Den kommer tilbage, hvor den end blev indsat.

Tilladelse: 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 hver indstilling, hvad den viser, og hvor den er live testimonial_widgets_get

Alt, hvad byggeren gemmer: layoutet og dets valg, hvad der fodrer widgetten (en samling, en gemt visning, tags eller en håndplukket liste), hvad hvert kort viser, stilen, sproget og anmeldelsesmarkeringen, med hvor den blev set live, og hvor mange udtalelser den viser nu. En widget i papirkurven responderer med 404.

Tilladelse: 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 Ændr en widget testimonial_widgets_update

Kun de sendte inputs ændres. En gemt ændring når hvert sted, widgetten er på, uden at røre deres kode, fordi dens cachede kopier ryddes.

Tilladelse: 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 '{…}'

Ydeevne

GET /sites/:site_id/performance.json Web Vitals: p75-resultatkort, daglig udvikling og opdelinger efter side, enhed, browser og land performance_report

Web Vitals-rapport fra rigtige besøgende. Returnerer period, metric, sample_rate, scorecard, trend og breakdowns. scorecard har én række for hver af LCP, INP, CLS, FCP og TTFB med p75 (75. percentil, i millisekunder undtagen CLS, som er en enhedsløs score), samples, rating (good, needs_improvement eller poor, null uden data), good, needs_improvement og poor (procent af prøverne), previous_p75, change (procent i forhold til den tidligere periode, null når ukendt) og thresholds [grænse for good, grænse for poor]. trend er den daglige p75 for den valgte måling som {date, p75, samples}. breakdowns har page, device, browser og country, hver med op til limit rækker (standard 10, maks. 100) for den valgte måling som {value, p75, samples, rating, slow_share, poor}, de dårligste og travleste først. Vælg metric med præcis én af LCP, INP, CLS, FCP eller TTFB med store bogstaver (standard LCP). sample_rate er andelen af besøg, der rapporterer vitals, så antal er prøver og ikke alle besøg. Tager de fælles inputs period, compare, filters og segment. Brug pages_detail til én sides vitals.

Tilladelse: analytics.read

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