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.
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.
curl https://privatusanalytics.com/sites/pa_7Q2K9XH3AB/stats/aggregate.json?period=7d \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
{
"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
Kaikki toiminnot
Lähetä Authorization: Bearer pat_…. Luo tunnisteet kohdassa Työtilan asetukset, API-tunnisteet. Todennusopas.
Lisää .json mihin tahansa polkuun. Vastaukset ovat muotoa { "data": … } ja virheet muotoa { "error": { "code", "message" } }. Virheet.
Lähetä JSON-RPC POST-pyyntönä osoitteeseen https://privatusanalytics.com/mcp samalla tunnisteella. Jokainen alla oleva toiminto on työkalu. MCP-opas.
Lataa openapi.json · 527 toimintoa
API-tunnisteet
POST
/workspaces/:workspace_id/api_tokens.json
Luo API-tunniste (tunniste palautetaan vain kerran)
api_tokens_create
Luo API-tunnisteen kutsuvalle jäsenelle työtilassa ja palauttaa salaisuuden täsmälleen kerran token-kentässä. Kopioi se heti, sitä ei voi lukea uudelleen, ja kadonnut tunniste on peruutettava ja luotava uudelleen. Tunniste voi vain kaventaa sitä, mitä sen jäsen saa tehdä. permissions on oletuksena kaikki jäsenen omat oikeudet, kun se jätetään pois (nimenomaisesti annettu tyhjä lista hylätään, ja sellaisen oikeuden pyytäminen, jota sinulla ei ole, on virhe). site_ids ottaa vastaan sivustojen julkiset tunnukset (pa_...) ja rajaa tunnisteen näihin sivustoihin. Kun lista on tyhjä, tunniste toimii kaikilla sivustoilla, joihin sen jäsenellä on pääsy (tai säilyttää tämän kutsun tehneen tunnisteen sivustolistan). expires_at on valinnainen ISO 8601 -aika, jonka on oltava tulevaisuudessa ja enintään 3 vuoden päässä. Jätä se pois, jos tunniste ei vanhene koskaan. allowed_ips rajaa tunnisteen näihin IP-osoitteisiin tai CIDR-alueisiin. Tämän kutsun tekevän tunnisteen on sisällettävä tokens.manage. Työtila, joka vaatii kaksivaiheisen tunnistautumisen, hylkää tunnisteet jäseniltä, joilla ei ole omaa toista tunnistautumistekijää. Palauttaa samat kentät kuin api_tokens_list sekä token.
Oikeus: member
· Vain HTTP (ei MCP-työkalu)
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
Peruuta API-tunniste
api_tokens_delete
Peruuttaa API-tunnisteen heti ja pysyvästi. Sitä käyttävät pyynnöt epäonnistuvat tästä lähtien, eikä peruutettua tunnistetta voi palauttaa, vaan luo uusi. Tunnisteen tietue pysyy listassa tilalla revoked (näet sen käyttämällä api_tokens_list-kutsua parametrilla include_revoked), ja jo peruutetun tunnisteen peruuttaminen ei muuta mitään. Ota id (uuid) api_tokens_list-kutsusta. Voit peruuttaa omat tunnisteesi, toisen tunnisteen peruuttaminen vaatii tokens.manage-oikeuden ja pääsyn kaikille sivustoille, jotka tunniste kattaa. Tämän kutsun tekevän tunnisteen on sisällettävä tokens.manage. Palauttaa peruutetun tunnisteen ilman sen salaisuutta.
Oikeus: member
· Vain HTTP (ei MCP-työkalu)
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
Listaa API-tunnisteet
api_tokens_list
Listaa työtilan API-tunnisteet uusin ensin ja sivutettuna. Ilman tokens.manage-oikeutta näet vain omat tunnisteesi, sen kanssa näet kaikkien jäsenten tunnisteet. Peruutetut ja vanhentuneet tunnisteet piilotetaan, ellei include_revoked ole true. Jokaisella kohteella on id (uuid, jota api_tokens_delete käyttää), name, token_prefix (ensimmäiset merkit tunnisteen tunnistamiseksi), owner (jäsenen sähköposti), permissions (nimet kuten analytics.read), site_ids (sivustojen julkiset tunnukset pa_..., tyhjä taulukko tarkoittaa kaikkia sivustoja, joihin omistajalla on pääsy), allowed_ips, oauth_client (yhdistetyn sovelluksen nimi, kun tunniste on myönnetty OAuthin kautta, muuten null), status (active, expired tai revoked), expires_at, last_used_at, revoked_at ja created_at. Salaisuutta ei koskaan palauteta tässä, token on listassa aina null. Se näytetään vain kerran api_tokens_create-kutsun yhteydessä.
Oikeus: member
curl https://privatusanalytics.com/workspaces/:workspace_id/api_tokens.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Analytiikka
GET
/sites/:site_id/clicks.json
Klikkauskartta: sivuston eniten klikatut elementit tai yhden sivun elementit sekä osuus käynneistä, jotka klikkasivat kutakin
clicks_list
Klikkaukset elementeittäin clicks-seurantamoduulista. Elementti on lyhyt CSS-valitsin (tagi, id ja enintään kaksi luokkaa, enintään neljä tasoa) tai [data-privatus-click="name"], jos sivusto antoi sille nimen. Anna path (kauttaviivalla alkava, tallennetussa muodossa) yhtä sivua varten: silloin elementit ovat {selector, clicks, visits, visit_share} ja page_visits on sivun nähneiden käyntien määrä. visit_share on niiden käyntien osuus prosentteina (0-100), jotka klikkasivat elementtiä. Ilman path-arvoa elementit ovat {path, selector, clicks, visits} koko sivustolta. visits laskee käynnit, jotka klikkasivat vähintään kerran. Palauttaa period, path, page_visits ja elements, eniten klikattu ensin. Elementin tekstiä, koordinaatteja tai hiiren liikkeitä ei koskaan kerätä. Käytä pages_detail-kutsua sivun muihin tietoihin.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/clicks.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/overview.json
Sivuston yleiskatsaus: mittarit, kaaviosarjat, kärkipaneelit, live-kävijät ja muistiinpanot
stats_overview
Yksi kutsu, joka palauttaa kaiken, mitä sivuston yleisnäkymä näyttää. Käytä sitä vastataksesi laajaan kysymykseen, kuten miten sivusto pärjää, usean työkalukutsun sijaan. Palauttaa period, metrics (visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration, revenue), interval, series (yksi kohde aikajaksoa kohti), panels, notes ja live_visitors. Kun compare on mukana, se lisää comparison_period, comparison, change ja comparison_series, kuten stats_aggregate- ja stats_timeseries-kutsuissa. Yksiköt vastaavat näitä työkaluja: bounce_rate on prosentti väliltä 0 - 100, visit_duration on aktiivisen ajan mediaani millisekunteina, revenue on kokonaisluku pienimmissä yksiköissä (sentteinä). panels on dimension nimellä avainnettu objekti, joka sisältää kunkin 10 suosituinta riviä osuuksineen samassa rivimuodossa kuin stats_breakdown kyseiselle dimensiolle. Oletuksena se palauttaa channel, referrer, page, entry_page, country, device, browser, os, utm_campaign, event ja goal. Lähetä panels valitaksesi muita dimensioita (mikä tahansa dimension nimi paitsi prop-avaimet). notes listaa jakson huomautukset muodossa {id, date, end_date, title, url, color}. live_visitors laskee kävijät viimeisen 5 minuutin ajalta. Jos haluat yli 10 riviä dimensiosta, käytä stats_breakdown-kutsua, ja yhteen lukuun stats_aggregate-kutsua. Ottaa yhteiset period-, compare-, filters- ja segment-syötteet.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/overview.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/experiments/external.json
Kokeiluraportti: konversioaste variantteittain, nousu kontrolliin verrattuna ja merkitsevyys (kahden osuuden z-testi)
experiments_report
Raportoi A/B-testin tapahtumatietojen perusteella. Käynnit osoitetaan variantille, joka löytyy tapahtuman ominaisuudesta (käynnin ensimmäinen nähty arvo, esimerkiksi ominaisuus variant arvoilla control ja b), ja konversio on käynti, joka suoritti tavoitteen. Pakolliset syötteet ovat property (pienaakkosinen avain, enintään 64 merkkiä) ja goal_id (aktiivinen tavoite, goals_list-kutsusta). Palauttaa period, property, goal {id, name}, control, confidence (0.95) ja variants. Jokaisella variantilla on visits, conversions, conversion_rate (prosentti, 0 - 100), control (true perusversiolle), uplift (konversioasteen prosentuaalinen muutos verrattuna kontrolliin, null kontrollille tai kun kontrollin aste on 0), z, p_value ja significant (true, kun p_value on alle 0.05, kahden suhteen z-testillä). Kontrolli on control-parametrissa antamasi variantti, muuten variantti nimeltä control, muuten variantti, jolla on eniten käyntejä. Enintään 20 varianttia, vilkkain ensin. Varmista ensin, että sivusto lähettää variantin tapahtuman ominaisuutena. Ottaa yhteiset period- ja filters-syötteet. Tavallista tavoitteen konversioastetta varten käytä goals_get-kutsua. Vaatii Business- tai Enterprise-paketin (muuten 402 plan_limit).
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/experiments/external.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/insights.json
Huomionarvoiset muutokset edelliseen jaksoon verrattuna selkokielellä (suurimmat muutokset, tavoitekonversioiden muutokset)
insights_get
Selkokieliset huomionarvoiset muutokset sivustolle verrattuna edelliseen samanpituiseen jaksoon. Palauttaa period, comparison_period ja insights. Jakso kattaa kokonaisia päiviä eiliseen asti, ja se valitaan period-arvolla (7d, 14d, 28d tai 30d, oletus 7d). Jokaisella oivalluksella on dimension (total, channel, page, country tai goal), metric, value, previous, current, change ja sentence. change on prosentti lukumäärille ja prosenttiyksikköä tavoitteen konversioasteelle, ja sentence on valmis luettava englanninkielinen rivi. Mukana ovat kävijöiden ja sivunäyttöjen kokonaismäärät, kaksi suurinta muutosta dimensiota kohti (vähintään 20 prosentin muutokset, joissa on vähintään 10 käyntiä tai näyttöä) ja tavoitteet, joiden konversioaste muuttui puolella prosenttiyksiköllä tai enemmän. Tärkein ensin, rajattuna limit-arvolla (oletus 8, enintään 20). Tulokset säilytetään päivän ajan. Tarkkoja lukuja varten käytä stats_aggregate- ja stats_breakdown-kutsuja, ja tätä kutsua löytääksesi, mikä muuttui.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/insights.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/journeys.json
Polut: yleisimmät 3-vaiheiset polut sivun (tai minkä tahansa sisääntulon) jälkeen tai ennen sivua tai tavoitetta
journeys_explore
Tutkii yleisimpiä kolmen sivun polkuja käyntien sisällä. Eteenpäin-tilassa (oletus) se näyttää polut aloitussivun jälkeen, joka annetaan parametrissa path, tai minkä tahansa sisääntulon jälkeen, kun path on tyhjä. Käänteisessä tilassa se näyttää polut, jotka johtavat päätesivulle (path) tai tavoitteeseen (goal_id, joka vaihtaa käänteiseen tilaan automaattisesti). reverse vaatii path- tai goal_id-arvon. path-arvon on alettava vinoviivalla. Palauttaa period, mode, path, goal, sampled, sample_rate (prosentti), total_visits ja polkukaavion solmuineen ja linkkeineen vaiheittain, rajattuna limit-arvoon sivua vaihetta kohti (2 - 12, oletus 6). Yli 100 000 käynnin kohdalla data otostetaan. Sivusuodattimia ei huomioida, koska ne katkaisisivat polut. Polut rakennetaan käyntikohtaisesti, koska kävijätunnusta ei tallenneta. Ottaa yhteiset period-, filters- ja segment-syötteet. Yhden sivun naapureille käytä pages_detail-kutsua ja vaiheiden konversioon funnels_get-kutsua.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/journeys.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/pages/detail.json
Sivun tiedot: mittarit, edelliset ja seuraavat sivut, lähteet, Web Vitals, tapahtumat ja klikkauskartta yhdelle polulle
pages_detail
Yksi sivu syvällisesti. Anna path (sen on alettava vinoviivalla, esimerkiksi /pricing) täsmälleen tallennetussa muodossa (ilman kyselymerkkijonoa ja isäntää). Palauttaa period, path, url, metrics, previous_pages, next_pages, sources, vitals, events, clicks, goals ja notes. metrics sisältää visitors, visits, pageviews, entrances, exits, entry_rate, exit_rate ja bounce_rate (prosentteja, 0 - 100), time_on_page (mediaani millisekunteina) ja scroll_depth (mediaani prosentteina), joista kaksi viimeistä ovat null, kun sitoutumisdataa ei ole. previous_pages ja next_pages ovat samassa käynnissä ennen ja jälkeen nähdyt sivut muodossa {value, count, share}, ja erityisarvoina ovat (entrance) ja (exit). sources sisältää sivulle saapuneiden käyntien suosituimmat kanavat ja viittaajat. vitals sisältää p75-arvot Web Vitals -mittareittain arvioineen. events ovat sivulla laukaistut omat tapahtumat, clicks ovat eniten klikatut elementtivalitsimet, goals ovat sillä suoritetut tavoitteet ja notes ovat sen mainitsevat huomautukset. Käytä stats_breakdown-kutsua dimensiolla page sivujen järjestämiseen ja referrers_detail-kutsua viittaavaan sivustoon.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/pages/detail.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/referrers.json
Viittaajat: sivustot, jotka linkittävät tähän sivustoon, kävijöineen, sitoutumisineen, liikennetyyppeineen ja linkittävien sivujen määrineen
referrers_list
Järjestää kävijöitä lähettäneet ulkoiset sivustot sen mukaan, mitä kukin lähetti. Suorat käynnit (ei viittaajaa) jätetään pois. Palauttaa period, summary, channels, page, limit, has_more ja rows. summary sisältää visitors, visits, pageviews, bounce_rate (prosentti), visit_duration (aktiivisen ajan mediaani millisekunteina), revenue (pienimmissä yksiköissä, sentteinä), sites (viittaavien sivustojen määrä) ja share (prosentti kaikista käynneistä, jotka tulivat viittaajilta). channels näyttää liikennetyypit muodossa {value, visitors, visits}. Jokaisella rivillä on value (viittaajan isäntä), visitors, visits, pageviews, bounce_rate, visit_duration, revenue, channel (sen tavallinen kanava), linking_pages (kuinka monta eri sivua kyseiseltä sivustolta linkittää tänne) ja share (prosentti viitatuista kävijöistä). Lajittele sort-arvolla (visitors, visits, pageviews tai revenue, oletus visitors), rajaa search-arvolla (isännässä oleva teksti) ja selaa page- ja limit-arvoilla (enintään 100), kun has_more on true. Käytä referrers_detail-kutsua yhteen sivustoon. Ottaa yhteiset period-, compare-, filters- ja segment-syötteet.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/referrers.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/referrers/detail.json
Viittaajan tiedot: yhden viittaavan sivuston mittarit ja kehitys, sen linkittävät sivut, laskeutumissivut, maat, laitteet, kampanjat ja konversiot
referrers_detail
Yksi viittaava sivusto syvällisesti. Anna referrer isäntänä ilman www-etuliitettä ja ilman polkua (esimerkiksi news.ycombinator.com), samana arvona kuin referrers_list-kutsussa. Palauttaa period, referrer, url, channel (sen yleisin kanava), metrics, share (prosentti kaikista käynneistä), interval, series (liikenne ajan yli), linking_pages, landing_pages, channels, countries, devices, campaigns, goals ja compare-parametrin kanssa comparison, change ja comparison_series. metrics ja series käyttävät samoja kenttiä ja yksiköitä kuin stats_aggregate ja stats_timeseries. linking_pages ovat viittaajan sivut, jotka lähettivät kävijöitä, riveinä kentillä path, url, visitors ja share (kyselymerkkijonoja ei koskaan tallenneta). landing_pages ovat sivut, joille nämä kävijät saapuivat. channels, countries, devices ja campaigns ovat suosituimpia arvoja mittareineen, ja goals listaa niiden suorittamat tavoitteet kentillä conversions ja conversion_rate. Käytä referrers_list-kutsua viittaavien sivustojen järjestämiseen ja stats_breakdown-kutsua dimensiolla referrer yksinkertaiseen listaan.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/referrers/detail.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/stats/aggregate.json
Jakson pääasialliset mittarit (vertailun kanssa)
stats_aggregate
Pääluvut yhdelle jaksolle yhtenä objektina. Palauttaa period {from, to} ja metrics {visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration, revenue}. Compare-parametrin kanssa se palauttaa myös comparison_period, comparison (samat mittarit toiselle ajanjaksolle) ja change (prosenttimuutos mittaria kohti, null, kun aiempi arvo oli 0). Yksiköt: bounce_rate on prosentti väliltä 0 - 100 (10.9 tarkoittaa 10,9 %). visit_duration on käynnin aktiivisen ajan mediaani millisekunteina. revenue on kokonaisluku sivuston valuutan pienimmissä yksiköissä (sentteinä). views_per_visit on desimaaliluku. Kävijät lasketaan päivittäin, koska pysyvää kävijätunnusta ei tallenneta, joten toisena päivänä palaava henkilö lasketaan uudelleen. Käytä tätä kokonaismääriin ja jaksojen väliseen muutokseen. Käytä stats_timeseries-kutsua aikakaavioon, stats_breakdown-kutsua dimension suosituimpiin arvoihin ja stats_overview-kutsua kaikkeen yhdellä kutsulla. Rajaa mitä tahansa niistä filters-arvolla (dimensioiden nimet ja operaattorit löytyvät filters-kuvauksesta).
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/stats/aggregate.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/breakdown/:dimension.json
Dimension yleisimmät arvot (sivut, lähteet, maat…)
stats_breakdown
Yhden dimension suosituimmat arvot mittareineen, tärkein ensin, sivutettuna. Dimensio on polun viimeinen osa, ja sen on oltava täsmällinen nimi sen kuvauksesta (esimerkiksi country, page, channel, utm_campaign, prop:plan). Palauttaa period, dimension, label, page, limit, has_more ja rows. Pyydä seuraava sivu, kun has_more on true. Jokaisella rivillä on value ja share (prosentti jakson kokonaismäärästä). Rivin muut kentät riippuvat dimensiosta. Käyntidimensiot (channel, referrer, referrer_url, utm_*, ref, hostname, country, language, device, browser, browser_version, os, os_version, screen, entry_page, exit_page, interaction) antavat visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration ja revenue. page antaa pageviews, visits, time_on_page (millisekunteina) ja scroll_depth (prosentteina), ilman visitors-kenttää. event ja prop:<key> antavat completions, visits, revenue ja conversion_rate. goal antaa goal_id, completions, conversions, conversion_rate ja revenue. Yksiköt: bounce_rate ja conversion_rate ovat prosentteja (0 - 100), kestot ovat millisekunteja, revenue on pienimmissä yksiköissä (sentteinä). Väärä dimensio palauttaa 422-virheen, joka listaa kelvolliset nimet. Käytä search-arvoa hakeaksesi arvoa kaikilta riveiltä ja filters-arvoa rajataksesi dataa ensin (esimerkiksi yhden maan käymät sivut). Yhteen sivuun tai viittaajaan syvällisesti käytä pages_detail- tai referrers_detail-kutsua. Dimensiot interaction ja bot_score vaativat Business- tai Enterprise-paketin: erittelynä ne vastaavat 402 plan_limit muilla paketeilla, ja niiden suodatin jätetään pois.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/breakdown/:dimension.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/stats/timeseries.json
Mittarit aikavälin mukaan kaavioita varten
stats_timeseries
Mittarit aikajaksoa kohti, kaavioihin ja trendeihin. Palauttaa period, interval (todella käytetty jakso) ja series, listan muodossa {date, visitors, visits, pageviews, views_per_visit, bounce_rate, visit_duration, revenue}, yksi kohde jaksoa kohti ja date jakson alkuna ISO 8601 -muodossa. Compare-parametrin kanssa se palauttaa myös comparison_series toiselle ajanjaksolle jakso jaksolta. Yksiköt ovat samat kuin stats_aggregate-kutsussa: bounce_rate on prosentti (0 - 100), visit_duration on aktiivisen ajan mediaani millisekunteina, revenue on pienimmissä yksiköissä (sentteinä). interval on oletuksena auto, joka valitsee minuutin, tunnin, päivän, viikon tai kuukauden sopivaksi ajanjaksolle. Aseta se pakottaaksesi jakson koon. Käytä stats_aggregate-kutsua yhteen kokonaislukuun ja stats_breakdown-kutsua jakamaan dimension, kuten country tai page, mukaan.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/stats/timeseries.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Avustaja
POST
/sites/:site_id/ask.json
Esitä kysymys uudessa keskustelussa (lasketaan kuukauden tekoälykysymysten rajaan)
assistant_ask
Aloittaa uuden Kysy-keskustelun yhdellä sivustolla ja vastaa sen ensimmäiseen kysymykseen käyttäen sivuston analytiikkaa. Käytä sitä selkokieliseen kysymykseen sivustosta. Käytä assistant_ask_followup-kutsua jatkaaksesi olemassa olevaa keskustelua ja tilastotyökaluja, kun tiedät jo täsmällisen kyselyn. Vastauksen tuottaa tekoälymalli, joka suorittaa itse vain luku -analytiikkakyselyjä, joten kutsu voi kestää useita sekunteja. Se lasketaan yhdeksi tekoälykysymykseksi työtilan kuukausikiintiöstä (5 Free-paketissa, 20 Pro-paketissa, 100 Business-paketissa) ja epäonnistuu rajavirheeseen, kun kiintiö on käytetty. Kysymys voi olla enintään 2 000 merkkiä. Keskustelut ovat yksityisiä niiden aloittaneelle jäsenelle ja poistetaan 30 päivää viimeisen viestin jälkeen. Palauttaa keskustelun (id, site_id, kysymyksestä otettu title, created_at, updated_at, expires_at) ja messages-taulukon. Jokaisella viestillä on role (user tai assistant), content (vastausteksti), queries (täsmälliset analytiikkakyselyt, jotka avustaja suoritti), chart (kaaviomääritys, voi olla null), goal_draft (ehdotettu tavoite, voi olla null), tokenien määrät ja created_at. Jos vastaus epäonnistuu, keskustelu poistetaan eikä kysymystä lasketa. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
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
Poista Kysy-keskustelu ja sen viestit
assistant_conversations_delete
Poistaa yhden Kysy-keskustelun ja kaikki sen viestit heti ja pysyvästi. Tätä ei voi perua. Hae keskustelun id assistant_conversations_list-kutsusta. Vain keskustelun aloittanut jäsen voi nähdä ja poistaa sen. Vaatii analytics.read-oikeuden ja site_id-arvon. Palauttaa poistetun keskustelun yhteenvedon (id, site_id, title, aikaleimat). Se ei palauta kuukaudelta jo laskettuja tekoälykysymyksiä.
Oikeus: analytics.read
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
Listaa Kysy-keskustelusi sivustolle
assistant_conversations_list
Listaa kirjautuneen jäsenen Kysy-keskustelut yhdellä sivustolla, viimeksi päivitetty ensin. Muiden jäsenten keskusteluja ei koskaan näytetä. Käytä sitä löytääksesi keskustelun id:n kutsuille assistant_conversations_get, assistant_ask_followup tai assistant_conversations_delete. Jokaisella kohteella on id, site_id, title (ensimmäinen kysymys lyhennettynä 80 merkkiin), created_at, updated_at ja expires_at mutta ei viestejä. Sivutettu page- ja per_page-arvoilla (enintään 100). Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/ask.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/ask/:id.json
Kysy-keskustelu: kysymykset, vastaukset, niiden taustalla olevat kyselyt ja kaaviot
assistant_conversations_get
Palauttaa yhden Kysy-keskustelun koko viestihistorian kanssa. Hae keskustelun id assistant_conversations_list-kutsusta tai assistant_ask-kutsun tuloksesta. Kentät ovat id, site_id, title, created_at, updated_at, expires_at (30 päivää viimeisen viestin jälkeen, minkä jälkeen keskustelu poistetaan) ja messages. Jokaisella viestillä on role (user tai assistant), content, queries (avustajan suorittamat analytiikkakyselyt), chart (voi olla null), goal_draft (voi olla null) sekä input_tokens ja output_tokens (kokonaislukuja, voivat olla null). Vain keskustelun aloittanut jäsen voi lukea sen. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
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
Esitä jatkokysymys keskustelussa (lasketaan kuukauden tekoälykysymysten rajaan). Palauttaa vastauksen.
assistant_ask_followup
Esittää jatkokysymyksen olemassa olevassa Kysy-keskustelussa, jolloin avustaja säilyttää aiemmat kysymykset ja vastaukset kontekstina. Käytä assistant_ask-kutsua aloittaaksesi sen sijaan uuden keskustelun. Hae conversation_id assistant_conversations_list-kutsusta. Kutsu voi kestää useita sekunteja, koska avustaja suorittaa vain luku -analytiikkakyselyjä. Jokainen kysymys lasketaan työtilan kuukausittaisesta tekoälykysymyskiintiöstä (5 Free-paketissa, 20 Pro-paketissa, 100 Business-paketissa) ja epäonnistuu rajavirheeseen, kun kiintiö on käytetty. Kysymys voi olla enintään 2 000 merkkiä. Palauttaa vain uuden avustajan viestin (ei koko keskustelua) kentillä id, role, content (vastaus), queries (täsmälliset suoritetut kyselyt), chart (voi olla null), goal_draft (voi olla null), input_tokens, output_tokens ja created_at. Vaatii analytics.read-oikeuden ja toimii vain omissa keskusteluissasi.
Oikeus: analytics.read
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 '{…}'
Bottien tunnistus
GET
/sites/:site_id/bot-detection.json
Edistyneen bottien tunnistuksen raportti: osumat sivuston hunajapurkkisivuille sivun ja botin paljastaneen syyn mukaan
bot_detection_report
Raportoi osumat sivuston hunajapurkkisivuille. Hunajapurkkisivu on sivu, jolle päästään vain piilotetun linkin kautta ja joka on määritetty sovelluksen Edistynyt bottien tunnistus -sivulla näytetyllä tavalla. Nämä osumat ovat botteja, joten ne eivät koskaan ole sivunäyttöjä tai käyntejä eivätkä näy stats_overview- tai stats_breakdown-kutsuissa. Valitse aikaväli period-arvolla (7d, 30d (oletus), 90d tai 12mo). Osumat säilytetään 12 kuukautta. Tuloksessa on period, from (aikavälin alku), has_data (false kunnes ensimmäinen osuma tulee), totals (hits, eri sivut, automated (osumat, joissa seurantakoodi näki automatisoidun selaimen) ja no_interaction (osumat ilman osoitin-, näppäin- tai kosketussyötettä)), pages (enintään 50 riviä kentillä path, hits ja last_hit_at), reasons (osumat tavallisen bottisuodattimen tuloksen mukaan: known_bot, automation, datacenter, empty_user_agent, referrer_spam tai undetected osumalle, jonka suodatin olisi laskenut ihmiseksi) ja recent (viimeisimmät 50 osumaa kentillä occurred_at, path, country, browser, device, bot_reason, automation ja interacted). Osuman mukana ei säilytetä IP-osoitetta eikä User-Agentia, vain niiden avaimellisia tiivisteitä, jotka eivät voi tunnistaa ketään, eikä niitä koskaan palauteta. Vaatii analytics.read-oikeuden sekä Business- tai Enterprise-paketin (muuten 402 plan_limit).
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/bot-detection.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Dokumentaatio
GET
/docs/api.json
Listaa kaikki API-toiminnot ja MCP-työkalut
docs_api
Palauttaa koko katalogin kaikista API-operaatioista, jotka ovat myös kaikki MCP-työkalut. Käytä sitä selvittääksesi, mitä työkaluja tai päätepisteitä on ja mitä ne täsmälleen ottavat vastaan. Jokaisella kohteella on tool_name, summary, description (voi olla null), group, verb (HTTP-metodi), path (malli paikkamerkeillä), permission (oikeus, jonka jäsen tai tunniste tarvitsee, null julkisille työkaluille), input_schema (syötteiden JSON Schema) ja response_schema (vastauksen JSON Schema). Vastaus on suuri. Yhteen jo tuntemaasi työkaluun käytä mieluummin dokumentaatiosivuja (docs_search). docs_openapi palauttaa saman tiedon OpenAPI-dokumenttina. Julkinen, ei vaadi tunnistautumista.
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/docs/api.json
GET
/docs.json
Listaa dokumentaatiosivut
docs_list
Listaa kaikki dokumentaatiosivut kentillä title, description, path (kuten /docs/api/authentication), section ja ilman sisältöä. Käytä sitä selataksesi, mitä on olemassa. Jos haluat löytää sivun aiheen mukaan, käytä docs_search-kutsua, ja lukeaksesi sivun docs_get-kutsua sen section- ja page-arvoilla. Sivutettu page- ja per_page-arvoilla (enintään 100). Julkinen, ei vaadi tunnistautumista.
Oikeus: public
curl https://privatusanalytics.com/docs.json
GET
/openapi.json
OpenAPI 3.1 -dokumentti koko API:lle
docs_openapi
Palauttaa koko julkista API:a kuvaavan OpenAPI 3 -dokumentin raakana JSON:na (ei data-kentän sisällä). Käytä sitä, kun tarvitset koneluettavan määrittelyn koodin generointiin. Selattavaan listaan operaatioista syöte- ja vastausskeemoineen docs_api on helpompi lukea. Se kuvaa samat operaatiot, jotka on tarjolla MCP-työkaluina. Julkinen, ei vaadi tunnistautumista.
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/openapi.json
GET
/docs/search.json
Hae dokumentaatiosta
docs_search
Hakee dokumentaatiosta palvelimella ja palauttaa järjestetyt sivut. Käytä sitä selvittääksesi, miten ominaisuus toimii, ennen kuin arvaat. q jaetaan enintään 10 hakutermiin, jokaisen termin on esiinnyttävä sivulla, ja otsikko- ja väliotsikko-osumat sijoittuvat korkeimmalle. Tyhjä q palauttaa kaikki sivut katalogin järjestyksessä. limit on oletuksena 20, kun q on annettu, ja enintään 100. Jokaisella tuloksella on title, path (käytä section- ja page-osia docs_get-kutsun kanssa), section, headings (lista id- ja text-arvoista, hyödyllinen otsikkoankkurina), excerpt ja score (null, kun q on tyhjä). Hakee pyynnön kielellä, oletuksena englanniksi. Julkinen, ei vaadi tunnistautumista.
Oikeus: public
curl https://privatusanalytics.com/docs/search.json
GET
/docs/:section/:page.json
Lue dokumentaatiosivu (Markdown ja HTML)
docs_get
section ja page tulevat sivun polusta /docs/<section>/<page>. Käytä sivuna "index" osion yleiskatsaukselle.
Oikeus: public
curl https://privatusanalytics.com/docs/:section/:page.json
Domain Rating
GET
/sites/:site_id/domain-rating.json
Domain Rating -raportti: viimeisin arvosana, saapuvat ja lähtevät linkit, muutos edelliseen julkaisuun verrattuna ja historia kuukausittain
domain_rating_report
Palauttaa sivuston Domain Ratingin, 0 - 100 -arvion siitä, kuinka vahvoja verkkotunnukseen osoittavat linkit ovat, sekä saapuvien ja lähtevien linkkien määrät ja niiden historian. Tämä on Privatus Analyticsin oma pistemäärä, ei Googlen mittari. Arvosanat päivitetään kerran kuukaudessa julkaisua kohti, joten muutokset näkyvät kuukausittain. months (1 - 120, oletus 12) määrää, kuinka monta kuukausittaista historiapistettä sisällytetään. Tuloksessa on domain, checked_at (milloin sivusto tarkistettiin viimeksi, null jos ei koskaan), release (uusimman datan kuukausi muodossa YYYY-MM), rating, inbound_links, outbound_links (kukin null, jos ei vielä tiedossa), changes (samat kolme mittaria erotuksena edelliseen julkaisuun, null kun jompikumpi on tuntematon) ja history (yksi rivi kuukaudessa kentillä month, rating, inbound_links, outbound_links, vanhin ensin). Uusi sivusto voi olla arvioimatta muutaman minuutin. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/domain-rating.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Haku
GET
/sites/:site_id/search.json
Hakuraportti: klikkaukset, näyttökerrat, CTR, sijainti, kärkikyselyt ja -sivut, laskeutumissivut ja mahdollisuudet
search_report
Hakuteho Google Search Consolesta ja Bing Webmasterista, yhdistettynä sivuston omiin laskeutumissivujen mittareihin. Valitse provider: all (oletus) laskee kaikki yhdistetyt hakukoneet yhteen, sijainti painotettuna näyttökerroilla sekä maat ja laitteet vain Googlesta, tai pelkkä google tai bing, ja tavallinen period tai mukautetut from ja to. limit (1 - 100, oletus 25) rajaa rivit kussakin taulukossa. Tuloksessa on period, provider, connection (valitun hakukoneen property, status ja last_synced_at, tai null kun sitä ei ole yhdistetty tai provider on all), connections (kukin yhdistetty hakukone kentillä provider, property, status ja last_synced_at), latest_date (uusin päivä, jolta on dataa), delayed (true, kun alue ulottuu latest_date-päivän yli), totals ja series (päivittäin), kussakin clicks, impressions, ctr (prosentti, ei murtoluku, 2 desimaalia) ja position (keskimääräinen sijoitus, 1 on paras, null jos tuntematon), breakdowns kyselyille, sivuille, maille ja laitteille (rivit value sekä samat neljä mittaria), landing_pages (suosituimmat sivut kentillä visits, bounce_rate ja conversion_rate prosentteina sekä conversions) ja opportunities (low_ctr_queries vähintään 100 näyttökerralla ja alle 2 prosentin CTR:llä sekä striking_distance-sivut, joiden keskimääräinen sijoitus on 8 - 20). Maa-arvot ovat sellaisia kuin palveluntarjoaja ne raportoi. Käytä stats_breakdown-kutsua kävijädataan ja tätä työkalua siihen, mitä tapahtuu ennen klikkausta. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/search.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
DELETE
/sites/:site_id/search/connections/:provider.json
Katkaise Search Console- tai Bing-yhteys ja poista sen tiedot
search_disconnect
Katkaisee hakupalveluntarjoajan (google tai bing) yhteyden sivustoon ja poistaa kyseisen palveluntarjoajan tuodun hakudatan pysyvästi. Tätä ei voi perua. Google-valtuutus poistetaan myös, kun mikään sivusto ei enää käytä sitä. Epäonnistuu, jos kyseistä palveluntarjoajaa ei ole yhdistetty. Palauttaa poistetun yhteyden. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Tuo hakutiedot nyt
search_sync
Jonottaa välittömän hakudatan tuonnin yhdistetylle palveluntarjoajalle (google, oletus, tai bing) säännöllistä aikataulua odottamatta. Palaa heti (HTTP 202) yhteyden kanssa ja tuonti suoritetaan taustalla. Kysele search_report-kutsua ja seuraa connection.last_synced_at-kenttää. Hakukoneet raportoivat parin päivän viiveellä, joten uusimmat päivät pysyvät tyhjinä synkronoinninkin jälkeen. Epäonnistuu, jos palveluntarjoajaa ei ole yhdistetty. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
curl -X POST https://privatusanalytics.com/sites/:site_id/search/sync.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Hälytykset
POST
/alerts/:id/acknowledge.json
Kuittaa viimeisin häiriö
alerts_acknowledge
Merkitsee hälytyksen uusimman kuittaamattoman häiriön kutsuvan käyttäjän nähdyksi. Se ei ratkaise häiriötä eikä mykistä hälytystä, hälytys ratkeaa itsestään, kun ehto poistuu. Jos hälytyksellä ei ole kuittaamatonta häiriötä, kutsu epäonnistuu validointivirheeseen. Palauttaa hälytyksen. Käytä alerts_history-kutsua nähdäksesi häiriöt kenttineen acknowledged_at ja acknowledged_by. Vaatii vain analytiikan lukuoikeuden, joten katselijat voivat kuitata.
Oikeus: analytics.read
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
Luo hälytys
alerts_create
Luo hälytyssäännön, joka tarkkailee sivustoa (tai koko työtilaa, kun kind on usage) ja ilmoittaa valituille kanaville, kun se laukeaa. Polku ottaa workspace_id-arvon. name ja kind ovat pakollisia. kind ratkaisee, mitä muuta tarvitaan. threshold vaatii site_id, metric (visitors, visits, pageviews, bounce_rate tai conversion), operator (gt, gte, lt tai lte) ja threshold, ja conversion vaatii lisäksi goal_id. anomaly vaatii site_id ja metric (visitors, visits tai pageviews), vertaa viimeistä ikkunaa samaan ikkunaan kunkin edellisen 4 viikon aikana ja käyttää sensitivity-arvoa (low, medium tai high). operator lt hälyttää vain laskuista, gt vain piikeistä ja tyhjä kummastakin. goal vaatii site_id, goal_id ja threshold (suoritukset ikkunassa). no_data vaatii site_id ja threshold-arvon tunteina ilman tapahtumia (oletus 24). usage ei tarvitse sivustoa ja threshold on prosentti kuukauden tapahtumakiintiöstä (oletus 80). uptime vaatii site_id ja valinnaisesti uptime_check_id (oletus sivuston kaikki tarkistukset). ssl vaatii site_id ja threshold-arvon päivinä ennen varmenteen tai verkkotunnuksen vanhenemista (oletus 14). vitals vaatii site_id, metric (lcp, inp, cls, fcp tai ttfb) ja threshold-arvon millisekunteina (cls-mittarilla pistemäärä). subscriptions vaatii site_id, metric (mrr_drop: MRR laski yli threshold-prosenttia viimeisten 30 päivän aikana, churn_rate tai mrr_churn_rate: poistuma viimeisten 30 päivän aikana on yli threshold-prosentin) ja threshold-arvon (oletus 10), ja ohitetaan, kun sivustolla ei ole maksupalveluntarjoajaa yhdistettynä tai mitattavaa ei ole. window_minutes (oletus 60, 5 - 10080) kertoo, kuinka kauas taakse kukin arviointi katsoo. channel_ids tulevat notification_channels_list-kutsusta ja sensitivity on oletuksena medium. Hälytykset arvioidaan automaattisesti 5 minuutin välein. bounce_rate- ja conversion-kynnykset ovat prosentteja väliltä 0 - 100. testimonials vaatii site_id ja metric, joka kertoo, mitä se tarkkailee: new (uusi suositus saapuu), low_rating (arvosana 3 tai alle saapuu), approved (suositus hyväksytään), allowance (kuukauden uusien suositusten kiintiöstä on käytetty 80 %, se on käytetty loppuun tai suositus pidetään odottavana), sync_found (synkronointi löytää uusia arvosteluja), import_failed (tuonti epäonnistuu tai lähde epäonnistuu kolme synkronointia peräkkäin), removal_requested (joku pyytää suosituksensa poistamista) tai request_bounced (pyyntösähköposti palaa takaisin). Suositushälytystä ei arvioida 5 minuutin välein: se laukeaa heti joka kerta, kun asia tapahtuu, kirjaa jo ratkaistun tapauksen ja sen tila pysyy ok. Metricillä allowance se tarkkailee koko työtilaa eikä pidä sivustoa. Palauttaa luodun hälytyksen tilassa ok.
Oikeus: content.write
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
Poista hälytys
alerts_delete
Poistaa hälytyssäännön ja sen koko häiriöhistorian pysyvästi. Tätä ei voi perua, ja ilmoitukset lakkaavat heti. Jos haluat keskeyttää hälytyksen menettämättä historiaa, käytä alerts_update-kutsua arvolla enabled false tai alerts_mute-kutsua. id (alr_...) tulee alerts_list-kutsusta. Palauttaa poistetun hälytyksen sellaisena kuin se oli. Vaatii sisällön kirjoitusoikeuden.
Oikeus: content.write
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älytyksen häiriöhistoria
alerts_history
Listaa yhden hälytyksen häiriöt uusin ensin ja sivutettuna. Jokaisella häiriöllä on triggered_at, resolved_at (null, kun häiriö on yhä auki), value (mitattu luku laukeamishetkellä, samassa yksikössä kuin hälytyksen kynnys), message (luettava kuvaus), acknowledged_at ja acknowledged_by (jäsenen näyttönimi tai null). Aseta open arvoon true nähdäksesi vain ratkaisemattomat häiriöt. Käytä alerts_acknowledge-kutsua merkitäksesi uusimman nähdyksi ja alerts_get-kutsua säännön nykytilaan.
Oikeus: analytics.read
curl https://privatusanalytics.com/alerts/:id/history.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/workspaces/:workspace_id/alerts.json
Listaa hälytykset
alerts_list
Listaa työtilan hälytyssäännöt (polku ottaa workspace_id-arvon) nimen mukaan lajiteltuina ja sivutettuina. Palauttaa data-taulukon hälytyksistä sekä meta-sivutuksen. Jokaisella hälytyksellä on id (alr_...), site_id (pa_..., null usage-hälytyksillä, jotka tarkkailevat koko työtilaa), name, kind, metric, operator, threshold, window_minutes, sensitivity, goal_id, channel_ids (nch_...-tunnukset), state (ok tai triggered), enabled, muted_until, last_triggered_at, last_evaluated_at ja created_at. Rajaa listaa parametreilla site_id, state (ok tai triggered) tai kind. Käytä site_alerts_list-kutsua yhden sivuston hälytysten listaamiseen sivustopolusta, alerts_get-kutsua yksittäiseen hälytykseen ja alerts_history-kutsua sen häiriöihin. Vain joihinkin sivustoihin rajattu kutsuja ei koskaan näe usage-hälytyksiä.
Oikeus: analytics.read
curl https://privatusanalytics.com/workspaces/:workspace_id/alerts.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/alerts/:id/mute.json
Mykistä hälytyksen ilmoitukset (tai poista mykistys)
alerts_mute
Hiljentää yhden hälytyksen ilmoitukset tietyksi ajaksi minuutteina, vaikka se jatkaa arviointia ja häiriöiden kirjaamista historiaansa. minutes on oletuksena 60, enimmäisarvo on 43200 (30 päivää) ja 0 poistaa mykistyksen heti. Vastauksena on hälytys, jonka muted_until on asetettu mykistyksen loppuun (null, kun mykistys on poistettu). Käytä alerts_update-kutsua arvolla enabled false lopettaaksesi arvioinnin kokonaan ja alerts_acknowledge-kutsua merkitäksesi häiriön nähdyksi mykistämättä.
Oikeus: content.write
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
Hae hälytys
alerts_get
Palauttaa yhden hälytyssäännön id:n perusteella (alr_..., alerts_list- tai site_alerts_list-kutsusta). Vastaus on hälytysobjekti, jossa on id, site_id (null usage-hälytyksillä), name, kind, metric, operator, threshold, window_minutes, sensitivity, goal_id, channel_ids, state (ok tai triggered), enabled, muted_until, last_triggered_at, last_evaluated_at ja created_at. Se ei sisällä häiriöitä, niihin käytä alerts_history-kutsua. threshold on luku, jonka yksikkö riippuu kind-arvosta (katso alerts_create). Vaatii analytiikan lukuoikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/alerts/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/alerts/:id.json
Päivitä hälytys
alerts_update
Muuttaa olemassa olevaa hälytyssääntöä (id alerts_list-kutsusta). Vain lähettämäsi syötteet muuttuvat, kaikki muu säilyttää arvonsa. Samat kind-kohtaiset säännöt kuin alerts_create-kutsussa koskevat lopputulosta, joten kind- tai metric-arvon muuttaminen voi vaatia vastaavan site_id-, goal_id-, operator- tai threshold-arvon. Lähetä channel_ids korvataksesi koko ilmoituskanavien listan ja enabled false lopettaaksesi arvioinnin poistamatta. Jos haluat hiljentää ilmoitukset hetkeksi mutta jatkaa häiriöiden kirjaamista, käytä sen sijaan alerts_mute-kutsua. Palauttaa päivitetyn hälytyksen.
Oikeus: content.write
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
Listaa sivuston hälytykset
site_alerts_list
Listaa yhden sivuston hälytyssäännöt (polku ottaa site_id-arvon) nimen mukaan lajiteltuina ja sivutettuina. Palauttaa samat hälytysobjektit ja hyväksyy samat state- ja kind-suodattimet kuin alerts_list, mutta vain tälle sivustolle, joten usage-hälytykset (joilla ei ole sivustoa) eivät sisälly. Valitse tämä, kun sinulla on jo sivuston tunnus, ja alerts_list, kun haluat kaikki työtilan hälytykset. Jokaisella hälytyksellä on id (alr_...), site_id, name, kind, metric, operator, threshold, window_minutes, sensitivity, goal_id, channel_ids, state (ok tai triggered), enabled, muted_until, last_triggered_at, last_evaluated_at ja created_at.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/alerts.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Ilmoituskanavat
DELETE
/channels/:id.json
Poista ilmoituskanava
notification_channels_delete
Poistaa ilmoituskanavan ja poistaa sen jokaisesta hälytyksestä, joka sitä käytti, jolloin kyseiset hälytykset lakkaavat ilmoittamasta siellä. Tätä ei voi perua, ja itse hälytykset säilyvät. id (nch_...) tulee notification_channels_list-kutsusta. Palauttaa poistetun kanavan.
Oikeus: content.write
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
Listaa ilmoituskanavat
notification_channels_list
Listaa työtilan ilmoituskanavat (polku ottaa workspace_id-arvon) nimen mukaan lajiteltuina ja sivutettuina. Kanava on paikka, jonne hälytykset toimitetaan. Jokaisella on id (nch_...), kind (email, slack, teams, discord, webhook, pagerduty, opsgenie tai push), name, target (maskattu yhteenveto, kuten sähköpostiosoitteet tai webhook-URL-osoitteen loppu, salaisuuksia ei koskaan palauteta), last_used_at ja created_at. Suodata kind-arvolla. Käytä tunnuksia channel_ids-arvoina kutsuissa alerts_create ja alerts_update. Vain joihinkin sivustoihin rajatut kutsujat näkevät vain kanavat, joita heidän sivustojensa hälytykset käyttävät.
Oikeus: analytics.read
curl https://privatusanalytics.com/workspaces/:workspace_id/channels.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/channels/:id/send_test.json
Lähetä testiviesti kanavan kautta
notification_channels_send_test
Lähettää oikean testiviestin kanavan kautta (sähköposti, chat-viesti, webhook-kutsu ja niin edelleen), joten käytä sitä vain, kun käyttäjä haluaa sen. Kutsu epäonnistuu syyn nimeävään virheeseen, jos toimitus ei toimi, muuten se palauttaa kanavan. Testilähetykset on nopeusrajoitettu työtilaa kohti, ja sähköpostikanavat myös ulkopuolista osoitetta kohti. Käytä sitä notification_channels_create- tai notification_channels_update-kutsun jälkeen vahvistaaksesi, että URL tai avain on oikea.
Oikeus: content.write
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
Hae ilmoituskanava
notification_channels_get
Palauttaa yhden ilmoituskanavan id:n perusteella (nch_..., notification_channels_list-kutsusta). Vastauksessa on kind, name, target (maskattu yhteenveto, salaisuuksia kuten webhook-URL-osoitteita ja avaimia ei koskaan palauteta), last_used_at ja created_at. Käytä notification_channels_send_test-kutsua tarkistaaksesi, että se toimittaa viestit.
Oikeus: analytics.read
curl https://privatusanalytics.com/channels/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/notifications/unsubscribe/:token.json
Peru osoitteen tilaus yhdeltä hälytyskanavalta tai käytettävyystarkistukselta sähköpostin tunnisteella
notification_unsubscribes_create
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/notifications/unsubscribe/:token.json \
-H "Content-Type: application/json" -d '{…}'
POST
/push_subscription.json
Rekisteröi selain push-ilmoituksille
push_subscriptions_create
Rekisteröi nykyisen selaimen web push -hälytyksiin käyttäen selaimen PushSubscription-olion kolmea arvoa (endpoint, p256dh ja auth). Tilaus vastaanottaa hälytykset jokaisesta työtilasta, johon jäsen kuuluu, jokaiselle sivustolle, minkä vuoksi API-tunniste saa käyttää tätä vain, kun se voi lukea koko työtilansa ja jäsenellä ei ole muuta työtilaa. Sen kutsuminen uudelleen samalla endpoint-arvolla päivittää avaimet ja siirtää tilauksen kutsujalle. endpoint-arvon on oltava julkinen https-push-palvelun URL. Tämä vain rekisteröi selaimen, joten hälytykset tarvitsevat silti kanavan lajia push (notification_channels_create). Palauttaa endpoint_host (push-palvelun isäntänimi, ei koko endpoint) ja created_at. Työtilan identiteetintarjoajan kautta avatut istunnot eivät voi käyttää sitä.
Oikeus: member
curl -X POST https://privatusanalytics.com/push_subscription.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
DELETE
/push_subscription.json
Poista selaimen push-rekisteröinti
push_subscriptions_delete
Poistaa yhden kirjautuneen jäsenen selaimen push-rekisteröinnin, jolloin kyseinen selain lakkaa vastaanottamasta hälytysilmoituksia. Anna sama endpoint, jota käytettiin push_subscriptions_create-kutsussa. Epäonnistuu not found -virheeseen, kun jäsenellä ei ole sellaista tilausta. Palauttaa poistetun tilauksen kentillä endpoint_host ja created_at. Se ei poista mitään ilmoituskanavaa. Samat tunnisterajoitukset kuin push_subscriptions_create-kutsussa pätevät.
Oikeus: member
curl -X DELETE https://privatusanalytics.com/push_subscription.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Indeksoijat
DELETE
/sites/:site_id/crawlers/connection.json
Katkaise Cloudflare-yhteys ja poista sen tuomat indeksoijien osumat
crawlers_cloudflare_disconnect
Katkaisee sivuston yhteyden Cloudflareen. Tämä poistaa tallennetun API-tunnisteen ja kaikki Cloudflaresta tuodut indeksoijaosumat, eikä sitä voi perua. Lähetetyistä palvelinlokeista tulleet osumat säilyvät. Tunniste on yhä olemassa Cloudflare-tililläsi, kunnes poistat sen sieltä. Epäonnistuu, jos sivustolla ei ole yhteyttä. Palauttaa poistetun yhteyden. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Tuo indeksoijien osumat Cloudflaresta nyt
crawlers_cloudflare_sync
Jonottaa välittömän Cloudflare-tuonnin sivustolle, joka on jo yhdistetty, säännöllistä aikataulua odottamatta. Palaa heti (HTTP 202) yhteyden kanssa, ja tuonti suoritetaan taustalla. Kysele crawlers_report-kutsua ja seuraa cloudflare.last_synced_at-kenttää nähdäksesi, milloin se valmistui. Epäonnistuu, jos sivustolla ei ole Cloudflare-yhteyttä. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
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
Tekoälyindeksoijien raportti: kutsut indeksoijittain ajan mukaan, kärkipolut indeksoijaa kohden, luokittain
crawlers_report
Raportoi, mitkä tekoäly-, haku- ja SEO-indeksoijat hakevat sivustoa, kuinka usein ja mitä polkuja, lähetetyistä palvelinlokeista ja Cloudflare-tuonnista. Tämä on indeksoijaliikennettä, ei kävijäliikennettä, joten se ei näy stats_breakdown-kutsussa. category on ai (oletus), search, seo, other tai all, ja crawler rajaa yhteen nimettyyn bottiin, kuten GPTBot tai ClaudeBot. Valitse aikaväli period-arvolla (oletus 30d) tai mukautetuilla from ja to. Tuloksessa on period (from ja to päivämäärinä), category, crawler, totals (osumat, eri polut, eri indeksoijat), categories (osumat kategoriaa kohti, category-suodatinta huomioimatta), crawlers (enintään 50 riviä kentillä crawler, category, hits, paths), series (päiväkohtaiset otsikot ja päivittäiset osumat 8 suosituimmalle indeksoijalle), top_paths (10 eniten haettua polkua kullekin 8 suosituimmalle indeksoijalle), has_data (false kunnes osumia on) ja cloudflare (yhteys kentillä zone, status ja last_synced_at, tai null). Tulokset välimuistitetaan enintään 30 minuutiksi paitsi heti Cloudflare-muutoksen jälkeen. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/crawlers.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Jakaminen
GET
/badge/:site_id.json
Kävijälaskurin merkki (SVG) julkiselle sivustolle
badges_get
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/badge/:site_id.json
Jäsenet
POST
/workspaces/:workspace_id/invitations.json
Kutsu henkilöitä sähköpostilla
invitations_create
Kutsuu yhden tai useamman henkilön työtilaan sähköpostilla ja lähettää kullekin kutsusähköpostin, jonka linkki on voimassa 14 päivää. emails on lista enintään 50 osoitteesta (pilkulla, välilyönnillä tai puolipisteellä erotettu merkkijono toimii myös sovelluksen lomakkeessa), ja osoitteet, jotka ovat jo jäseniä, ohitetaan, mutta on virhe, jos ne kaikki ovat jäseniä. Osoitteen kutsuminen, jolla on jo odottava kutsu, korvaa kyseisen kutsun ja lähettää uuden sähköpostin. role on yksi members_list-kutsun rooleista (oletus viewer, owner-roolia ei voi kutsua). Käytä roolia custom yhdessä custom_role_id-arvon kanssa (id roles_list-kutsusta, Business-paketti). Oletuksena pääsy kattaa kaikki sivustot tulevat mukaan lukien. Rajataksesi pääsyä aseta all_sites arvoon false ja listaa site_ids sivustojen julkisina tunnuksina (pa_...). Odottavat kutsut lasketaan paketin jäsenrajaan (Free sallii 3 jäsentä), ja kutsu epäonnistuu, jos raja ylittyisi. Kutsusähköpostit on nopeusrajoitettu. Et voi myöntää roolia, jolla on enemmän oikeuksia tai sivustoja kuin sinulla itselläsi. Vaatii members.manage-oikeuden. Palauttaa luodut kutsut (kentät ovat invitations_list-kutsussa).
Oikeus: members.manage
· Vain HTTP (ei MCP-työkalu)
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
Peruuta odottava kutsu
invitations_delete
Peruuttaa odottavan kutsun, jolloin sen linkki lakkaa toimimasta, ja vapauttaa sen varaaman paikan. Poistoa ei voi perua, kutsu henkilö uudelleen invitations_create-kutsulla. Ota id (uuid) invitations_list-kutsusta. Vain joihinkin sivustoihin rajattu kutsuja voi peruuttaa vain kutsuja, jotka eivät myönnä enempää sivustoja kuin hänen omansa. Vaatii members.manage-oikeuden. Palauttaa peruutetun kutsun.
Oikeus: members.manage
· Vain HTTP (ei MCP-työkalu)
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
Listaa odottavat kutsut
invitations_list
Listaa työtilan odottavat tiimikutsut uusin ensin ja sivutettuna. Hyväksyttyjä ja peruutettuja kutsuja ei listata (käytä members_list-kutsua liittyneille henkilöille), ja vanhentuneet säilyvät, kunnes ne korvataan tai peruutetaan. Vaatii members.manage-oikeuden. Vain joihinkin sivustoihin rajattu kutsuja näkee vain ulottuvillaan olevat kutsut. Jokaisella kohteella on id (uuid, jota invitations_delete käyttää), email, role, custom_role (mukautetun roolin nimi, kun role on custom, muuten null), all_sites, site_ids (sivustojen julkiset tunnukset pa_..., tyhjä kun all_sites on true), invited_by (kutsujan sähköposti), expires_at ja created_at.
Oikeus: members.manage
curl https://privatusanalytics.com/workspaces/:workspace_id/invitations.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
DELETE
/workspaces/:workspace_id/members/:id.json
Poista jäsen (tai poistu työtilasta)
members_delete
Poistaa jäsenen työtilasta tai antaa kutsujan poistua siitä, kun id on hänen oma jäsenyytensä. Tämä tapahtuu heti eikä sitä voi perua, henkilö menettää pääsynsä, hänen API-tunnisteensa tälle työtilalle peruutetaan ja mahdollinen SCIM-linkki poistetaan. Hänen muistiinpanonsa ja aiemmat tarkastusmerkintänsä säilyvät. Omistajaa ei voi poistaa eikä hän voi poistua, siirrä ensin omistajuus ownership_transfers_create-kutsulla. Toisen poistaminen vaatii members.manage-oikeuden, etkä voi poistaa henkilöä, jolla on enemmän oikeuksia tai sivustoja kuin sinulla. Poistuminen ei vaadi oikeutta, mutta oikeuksiltaan tai sivustoiltaan rajattua tunnistetta ei voi käyttää poistumiseen. Henkilön voi kutsua uudelleen myöhemmin invitations_create-kutsulla. Ota id (jäsenyyden uuid) members_list-kutsusta. Palauttaa poistetun jäsenen.
Oikeus: member
· Vain HTTP (ei MCP-työkalu)
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
Listaa työtilan jäsenet
members_list
Listaa työtilan jäsenet liittymisjärjestyksessä sivutettuna. Käytä query-arvoa haku nimellä tai sähköpostilla (osittainen, kirjainkoosta riippumaton) ja role-arvoa suodattaaksesi roolin mukaan. Odottavia kutsuja ei sisällytetä (käytä invitations_list-kutsua). Jokaisella jäsenellä on id (jäsenyyden uuid, jota käyttävät members_update, members_delete ja ownership_transfers_create), email, name (voi olla null), role, custom_role (nimi, null ellei role ole custom), custom_role_id, all_sites, include_future_sites, site_ids (sivustojen julkiset tunnukset pa_..., tyhjä kun all_sites on true), two_factor (onko jäsenellä autentikointisovellus tai pääsyavain), last_active_at (voi olla null) ja created_at. Vain joihinkin sivustoihin rajatut kutsujat näkevät vain ulottuvillaan olevat jäsenet.
Oikeus: member
curl https://privatusanalytics.com/workspaces/:workspace_id/members.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/workspaces/:workspace_id/members/:id.json
Muuta jäsenen roolia tai sivustojen käyttöoikeutta
members_update
Muuttaa jäsenen roolia ja/tai sivustopääsyä työtilassa. Vain lähettämäsi syötteet muuttuvat. Roolin muuttamiseksi lähetä role (admin, editor, analyst, viewer tai billing, ja custom arvon custom_role_id kanssa roles_list-kutsusta Business-paketissa). Omistajan roolia ei voi muuttaa täällä, käytä sen sijaan ownership_transfers_create-kutsua, etkä voi muokata omaa jäsenyyttäsi tai itseäsi ylempänä olevaa. Rajataksesi sivustoja lähetä all_sites false yhdessä site_ids-arvon kanssa (sivustojen julkiset tunnukset pa_...) ja lisää include_future_sites true myöntääksesi myös myöhemmin luodut sivustot. Lähetä all_sites true antaaksesi pääsyn jokaiselle sivustolle. Ilman all_sites false lähetetty site_ids-lista on virhe jäsenelle, jolla on tällä hetkellä kaikki sivustot. Et voi myöntää enempää oikeuksia tai sivustoja kuin sinulla on. Vaatii members.manage-oikeuden. Ota id members_list-kutsusta. Palauttaa päivitetyn jäsenen.
Oikeus: members.manage
· Vain HTTP (ei MCP-työkalu)
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
Siirrä työtilan omistajuus toiselle jäsenelle (vain omistaja, sinusta tulee ylläpitäjä)
ownership_transfers_create
Siirtää työtilan omistajuuden toiselle jäsenelle ja alentaa kutsujan admin-rooliin, mitä on vaikea perua, koska vain uusi omistaja voi siirtää sen takaisin. Vain nykyinen omistaja voi kutsua sitä, eikä tunnistetta saa olla rajattu tiettyihin sivustoihin tai oikeuksiin. membership_id on uuden omistajan jäsenyyden uuid members_list-kutsusta (ei käyttäjän id tai sähköposti), ja henkilön on jo oltava jäsen, kutsu hänet ensin, jos hän ei ole. Uusi omistaja saa roolin owner ja pääsyn kaikille sivustoille, eikä owner-roolia voi antaa members_update-kutsulla. Free-työtilaa ei voi antaa henkilölle, joka omistaa jo toisen Free-työtilan. Laskutus pysyy työtilan mukana. Tämän kutsun tekevän tunnisteen on sisällettävä members.manage. Palauttaa uuden omistajan jäsentietueen.
Oikeus: member
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/workspaces/:workspace_id/ownership_transfer.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Kampanjat
POST
/sites/:site_id/campaigns/costs.json
Aseta kampanjan kulut kuukaudelle
campaign_costs_create
Tallentaa yhden kampanjan mainoskulut yhdeltä kuukaudelta, jotta campaigns_list voi näyttää hankintakustannuksen ja mainoskulujen tuoton. Jos saman kampanjan ja kuukauden merkintä on jo olemassa, se korvataan eikä monistu, joten kutsun voi turvallisesti tehdä kahdesti. campaign on utm_campaign-arvo sellaisena kuin se esiintyy seuratuissa linkeissäsi, month on YYYY-MM (täysi päivämäärä, kuten 2026-09-15, hyväksytään ja pyöristetään kuun ensimmäiseen) ja amount on päävaluutan yksikössä lukuna (1250.50, ei pienimpinä yksikköinä). currency on valinnainen 3-kirjaiminen ISO-koodi, ja oletuksena on sivuston valuutta. Vastaus palauttaa tallennetun merkinnän, jossa amount_minor on pienimmissä yksiköissä. Useita rivejä kerralla varten käytä campaign_costs_import-kutsua. Vaatii content.write-oikeuden. Vaatii Business- tai Enterprise-paketin (muuten 402 plan_limit).
Oikeus: content.write
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
Poista kampanjan kulumerkintä
campaign_costs_delete
Poistaa yhden kulumerkinnän pysyvästi, löydettynä id:llä campaign_costs_list-kutsusta. Tätä ei voi perua, ja kyseisen kampanjan ja kuukauden CPA ja ROAS lakkaavat heti sisältämästä kulua. Muita kuukausia ja kampanjoita ei kosketa. Palauttaa poistetun merkinnän. Vaatii content.write-oikeuden. Vaatii Business- tai Enterprise-paketin (muuten 402 plan_limit).
Oikeus: content.write
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
Tuo kampanjakulut CSV:stä (campaign,month,amount[,currency])
campaign_costs_import
Tuo mainoskulut joukkona CSV:stä, nopea tapa ladata monta kampanjaa ja kuukautta. Lähetä CSV-teksti kentässä csv (paras työkaluille ja API-kutsuille) tai lataa tiedosto kentässä file (vain multipart). Ensimmäisen rivin on oltava otsikko, joka sisältää campaign, month ja amount, sekä valinnaisen currency-sarakkeen, esimerkiksi campaign,month,amount,currency ja sitten spring_sale,2026-09,1250.50,USD. Month on YYYY-MM, amount on päävaluutan yksikössä ja currency on oletuksena sivuston valuutta. Rivit päivitetään tai lisätään kampanjan ja kuukauden mukaan, joten saman tiedoston tuominen uudelleen ei monista. Rajat ovat 1 Mt ja 5 000 riviä. Virheellinen rivi ei pysäytä tuontia. Vastauksessa on imported (tallennettujen määrä), failed (hylättyjen määrä) ja errors (50 ensimmäistä viestiä, joissa kussakin mainitaan rivi, ja rivi 2 on ensimmäinen datarivi). Puuttuva otsikkosarake, liian suuri tiedosto tai virheellinen CSV epäonnistuttaa koko pyynnön. Vaatii content.write-oikeuden. Vaatii Business- tai Enterprise-paketin (muuten 402 plan_limit).
Oikeus: content.write
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
Listaa kampanjakulumerkinnät
campaign_costs_list
Listaa sivustolle kirjatut mainoskulumerkinnät, uusin kuukausi ensin ja sitten kampanjan nimen mukaan. Jokainen rivi on yksi kampanja yhdeltä kuukaudelta kentillä amount_minor (kokonaisluku valuutan pienimmissä yksiköissä, joten 125050 tarkoittaa 1 250,50), currency (ISO 4217, isoilla kirjaimilla), month muodossa YYYY-MM ja merkinnän id (UUID, käytä sitä kutsuissa campaign_costs_update ja campaign_costs_delete). Anna campaign nähdäksesi vain yhden kampanjan (kirjainkoosta riippumaton vastaavuus utm_campaign-arvoon). Sivutettu page- ja per_page-arvoilla (enintään 100). Kulut syöttävät CPA- ja ROAS-lukuja campaigns_list-kutsussa, joten täältä tarkistat, mitä kuluja kampanjalla on. Vaatii analytics.read-oikeuden. Vaatii Business- tai Enterprise-paketin (muuten 402 plan_limit).
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/campaigns/costs.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/campaigns/costs/:id.json
Muuta kampanjan kulumerkintää
campaign_costs_update
Muuttaa olemassa olevaa kulumerkintää, löydettynä id:llä campaign_costs_list-kutsusta. Vain lähettämäsi syötteet muuttuvat, joten lähetä pelkkä amount korjataksesi luvun. amount on päävaluutan yksikössä (1250.50) ja tallennetaan pienimpinä yksikköinä, month on YYYY-MM ja currency on 3-kirjaiminen ISO-koodi. Kampanjan tai kuukauden muuttaminen yhdistelmäksi, joka on jo toisella merkinnällä, epäonnistuu validointivirheeseen yhdistämisen sijaan. Jos haluat korjata kampanjan ja kuukauden kulun tietämättä id:tä, kutsu campaign_costs_create, joka korvaa olemassa olevan merkinnän. Vaatii content.write-oikeuden. Vaatii Business- tai Enterprise-paketin (muuten 402 plan_limit).
Oikeus: content.write
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
Rakenna ja tarkista UTM-tunnisteilla varustettu URL
campaigns_builder
Rakentaa UTM-merkityn URL-osoitteen laskeutumissivulle ja tarkistaa arvot. Mitään ei tallenneta eikä dataa lueta, joten sen voi kutsua turvallisesti toistuvasti. Anna destination (täysi https://-URL) sekä tarpeen mukaan utm_source, utm_medium, utm_campaign, utm_content ja utm_term, tai valitse esiasetus (newsletter, social, paid_search ja niin edelleen), joka täyttää utm_source- ja utm_medium-arvot, kun jätät ne tyhjiksi. Palauttaa url (null virheen sattuessa), valid, destination, preset, puhdistetut utm_*-arvot, issues (lista muodossa {field, level, message}, jossa level error estää URL-osoitteen ja warning vain ehdottaa korjausta, kuten pieniin kirjaimiin muuttamista) ja presets (käytettävissä olevat esiasetusarvot). Arvot puhdistetaan pieniksi kirjaimiksi ilman välilyöntejä. Käytä campaigns_hygiene-kutsua löytääksesi liikenteestäsi jo olemassa olevat sotkuiset UTM-arvot ja campaigns_list-kutsua raportoidaksesi toteutuneista kampanjoista. Jos haluat säilyttää merkityn linkin lyhyellä URL-osoitteella ja klikkausmäärillä, käytä sen sijaan links_create-kutsua.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/campaigns/builder.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/campaigns/hygiene.json
UTM-hygienia: lähes päällekkäiset arvot, tyylivirheet ja tuntemattomat lähteet
campaigns_hygiene
Löytää sotkuiset UTM-arvot jakson liikenteestä, jotta voit korjata merkinnät. Palauttaa period, duplicates, style_issues ja unknown_sources. duplicates ryhmittelee utm_source-, utm_medium- tai utm_campaign-arvot, jotka eroavat vain kirjainkoon, välilyöntien tai välimerkkien osalta (Facebook, facebook ja face-book), kukin muodossa {field, suggestion, variants: [{value, visits}]}, ja ehdotuksena on eniten käyty kirjoitusasu. style_issues listaa arvot, jotka rikkovat pienet kirjaimet ja ei välilyöntejä -käytäntöä, muodossa {field, value, visits, suggestion} (enintään 50). unknown_sources listaa utm_source-arvot, jotka eivät ole tunnistettu kanava, muodossa {value, visits} (enintään 50). Vain 500 suosituinta arvoa kenttää kohti tarkistetaan. Luvut ovat käyntejä. Ehdotukset ovat vain neuvoja, eikä mitään muuteta. Jos haluat yhdistää variantit yhdeksi kanavaksi, käytä channel_rules_create-kutsua. Ottaa yhteiset period- ja filters-syötteet. Käytä campaigns_list-kutsua suorituskykyyn ja campaigns_builder-kutsua puhtaiden merkittyjen URL-osoitteiden luomiseen.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/campaigns/hygiene.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/campaigns.json
Kampanjayhteenveto konversioineen, tuloineen, kuluineen, CPA:ineen ja ROAS:ineen
campaigns_list
Kampanjoiden suorituskykyraportti, joka perustuu utm_campaign-arvoon, kuluineen ja mainoskulujen tuottoineen. Palauttaa period, currency (sivuston valuutta), goal_id ja goal_name (tavoite, jonka konversiot lasketaan), campaigns, totals ja unconverted_costs. Jokaisella kampanjalla on visitors, visits, conversions, conversion_rate (prosentti väliltä 0 - 100, konversiot jaettuna käynneillä), revenue ja sources (rivit lähdettä ja välinettä kohti samoilla mittareilla). Kun kuluja on (campaign_costs_list-kutsusta), kampanjalla on myös cost, cpa (kustannus konversiota kohti, null kun konversioita ei ole) ja roas (tuotto jaettuna kululla, suhdeluku kuten 2.5, null kun kulua ei ole). Raha (revenue, cost, cpa) on kokonaisluku sivuston valuutan pienimmissä yksiköissä (sentteinä). Kulut yhdistetään kampanjoiden nimiin kirjainkoosta riippumatta ja jaksotetaan jakson sisällä olevien kuukausien päivien mukaan. Kampanja, jolla on kuluja mutta ei liikennettä, listataan silti. Enintään 100 kampanjaa, vilkkain ensin. Mukaan otetaan vain käynnit, joilla on utm_campaign. goal_id on oletuksena ensimmäinen aktiivinen tavoite, joten anna se nimenomaisesti mitataksesi tiettyä tavoitetta (tunnukset tulevat goals_list-kutsusta). Käytä campaigns_hygiene-kutsua nimien siivoamiseen ja stats_breakdown-kutsua dimensiolla utm_campaign pelkkään liikenteen jakoon.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/campaigns.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/campaigns/links.json
Tallenna UTM-tunnisteilla varustettu linkki kirjastoon
links_create
Tallentaa UTM-merkityn linkin sivuston linkkikirjastoon (polku ottaa site_id-arvon). name (enintään 120 merkkiä) ja destination (http- tai https-URL, enintään 2048 merkkiä) ovat pakollisia. utm-arvot puhdistetaan automaattisesti, muutetaan pieniksi kirjaimiksi, trimmataan ja välilyönnit muutetaan alaviivoiksi, ja henkilötietoa muistuttava arvo (esimerkiksi sähköpostiosoite) hylätään. Enintään 20 tunnistetta säilytetään, pilkulla erotetut merkinnät jaetaan ja tunnisteet muutetaan pieniksi kirjaimiksi ja katkaistaan 40 merkkiin. Se vain tallentaa linkin, eikä seuraa mitään itsestään. Palautettu url on kohde, johon on lisätty UTM-parametrit, ja kohteessa jo oleva UTM-parametri korvataan. Käytä links_qr-kutsua QR-koodiin.
Oikeus: content.write
curl -X POST https://privatusanalytics.com/sites/:site_id/campaigns/links.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
DELETE
/sites/:site_id/campaigns/links/:id.json
Poista tallennettu linkki
links_delete
Poistaa tallennetun linkin kirjastosta. Tämä poistaa vain tallennetun merkinnän, jo jakamasi URL-osoitteet toimivat edelleen ja niiden käynnit lasketaan yhä kampanjoittain. Sitä ei voi perua. id (lnk_...) tulee links_list-kutsusta. Palauttaa poistetun linkin.
Oikeus: content.write
curl -X DELETE https://privatusanalytics.com/sites/:site_id/campaigns/links/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
GET
/sites/:site_id/campaigns/links.json
Listaa tallennetut kampanjalinkit
links_list
Listaa yhden sivuston tallennetut kampanjalinkit (UTM-merkityt URL-osoitteet, polku ottaa site_id-arvon) uusin ensin ja sivutettuna. Jokaisella linkillä on id (lnk_...), name, destination, utm_source, utm_medium, utm_campaign, utm_content, utm_term, url (kohde UTM-parametreineen, valmis jaettavaksi), tags, notes, created_at ja updated_at. query hakee kentistä name, destination ja utm_campaign, ja tag säilyttää vain linkit, joilla on kyseinen tunniste. Tämä on tallennettu kirjasto. Jos haluat nähdä kampanjoiden tulokset, käytä campaigns_list-kutsua tai stats_breakdown-kutsua dimensiolla utm_campaign.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/campaigns/links.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/campaigns/links/:id/qr.json
Tallennetun linkin QR-koodi (SVG)
links_qr
Palauttaa QR-koodin tallennetun linkin täydelle merkitylle URL-osoitteelle painettavaksi. Vastauksessa on link_id, url (koodiin koodattu merkitty URL) ja svg (täydellinen itsenäinen SVG-dokumentti merkkijonona, musta valkoisella). size on moduulin koko pikseleinä, 2 - 20 (oletus 6), mikä skaalaa kuvaa. id (lnk_...) tulee links_list-kutsusta. Käytä links_get-kutsua, kun tarvitset vain URL-osoitteen.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/campaigns/links/:id/qr.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/campaigns/links/:id.json
Hae tallennettu kampanjalinkki
links_get
Palauttaa yhden tallennetun kampanjalinkin id:n perusteella (lnk_..., links_list-kutsusta). Vastauksessa on name, destination, utm_source, utm_medium, utm_campaign, utm_content, utm_term (kukin null, kun ei ole asetettu), url (täysi merkitty URL), tags, notes, created_at ja updated_at. Käytä links_qr-kutsua painovalmiiseen QR-koodiin samasta URL-osoitteesta.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/campaigns/links/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/campaigns/links/:id.json
Muuta tallennettua linkkiä
links_update
Muuttaa tallennettua kampanjalinkkiä (id links_list-kutsusta). Vain lähettämäsi syötteet muuttuvat. Samat puhdistus- ja henkilötietotarkistukset kuin links_create-kutsussa koskevat myös tätä. Tunnisteiden lähettäminen korvaa koko tunnistelistan. Lähetä tyhjä merkkijono utm-kentälle tyhjentääksesi sen. Palauttaa päivitetyn linkin uudelleen lasketulla url-arvolla.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/campaigns/links/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Kanavasäännöt
POST
/sites/:site_id/channel_rules.json
Lisää kanavasääntö
channel_rules_create
Lisää mukautetun kanavasäännön listan loppuun, joten se suoritetaan kaikkien olemassa olevien sääntöjen jälkeen ja sisäänrakennettua luokittelua käytetään vain, kun mikään sääntö ei täsmää. channel on annettava nimi (enintään 32 merkkiä, esim. Partners). conditions on ei-tyhjä lista objekteja, joissa on field (referrer_host, utm_source, utm_medium, utm_campaign, ref tai path), operator (is, contains, starts_with tai regex) ja value. Kaikkien ehtojen on täsmättävä, jotta sääntö pätee, ja vertailu ei erottele kirjainkokoa. Ehto, jolla on tyhjä value, pudotetaan, ja sääntö, jolle ei jää ehtoja, hylätään. Säännöllinen lauseke, joka ei käänny, hylätään. Sääntö koskee uusia käyntejä muutaman minuutin sisällä eikä muuta historiaa. Käytä channel_rules_move-kutsua järjestyksen muuttamiseen ja channel_rules_preview-kutsua sen testaamiseen. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
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
Poista kanavasääntö
channel_rules_delete
Poistaa mukautetun kanavasäännön, löydettynä id:llä channel_rules_list-kutsusta. Sen jo luokittelemat käynnit säilyttävät kanavansa, ja uudet käynnit putoavat seuraavalle täsmäävälle säännölle tai sisäänrakennettuun luokitteluun. Jäljellä olevat säännöt säilyttävät järjestyksensä. Palauttaa poistetun säännön. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
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
Listaa kanavasäännöt järjestyksessä
channel_rules_list
Listaa sivuston mukautetut kanavasäännöt arviointijärjestyksessä (position 1 ensin). Säännöt suoritetaan ylhäältä alas jokaista uutta käyntiä vasten, ja ensimmäinen sääntö, jonka kaikki ehdot täsmäävät, ratkaisee kanavan. Käynti, joka ei täsmää mihinkään sääntöön, saa sisäänrakennetun kanavan (direct, organic_search, paid_search, email ja niin edelleen). Jokaisella säännöllä on id (UUID), channel (sen antama nimi), position (alkaa 1:stä), conditions (lista field-, operator- ja value-objekteja, joiden kaikkien on täsmättävä) ja created_at. Säännöt vaikuttavat vain säännön luomisen jälkeen tallennettuihin käynteihin eivätkä koskaan kirjoita vanhaa dataa uudelleen. Käytä channel_rules_preview-kutsua esimerkkikäynnin testaamiseen. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/channel_rules.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/channel_rules/:id/move.json
Siirrä kanavasääntöä ylös tai alas
channel_rules_move
Siirtää kanavasäännön arviointijärjestyksessä, koska ensimmäinen täsmäävä sääntö voittaa ja järjestys ratkaisee, minkä kanavan käynti saa. direction on up tai down (yksi paikka) tai top tai bottom (päihin). Jo reunalla oleva sääntö pysyy paikallaan ilman virhettä. Sijainnit numeroidaan uudelleen 1:stä n:ään ja päivitetty sääntö palautetaan uudella sijainnillaan. Käytä ensin channel_rules_list-kutsua nähdäksesi nykyisen järjestyksen. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
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
Esikatsele esimerkkiviittaajan ja UTM-tunnisteiden kanava
channel_rules_preview
Kuivaharjoitus, joka kertoo, minkä kanavan esimerkkikäynti saisi sivuston nykyisillä säännöillä. Mitään ei tallenneta. Lähetä mitä tahansa seuraavista: referrer (URL tai paljas isäntänimi, www- ja m-etuliitteet ohitetaan), utm_source, utm_medium, utm_campaign, ref, path (laskeutumispolku, kuten /pricing) ja paid_click (true, jos URL sisälsi klikkitunnisteen, kuten gclid). Tuloksessa on channel (voittavan kanavan nimi), custom_rule (true, kun mukautettu sääntö ratkaisi, false, kun sisäänrakennettu luokittelu ratkaisi) ja referrer_host (puhdistettu isäntänimi, jota käytettiin vertailuun). Sivuston omien verkkotunnusten viittaaja lasketaan sisäiseksi. Käytä tätä channel_rules_create- tai channel_rules_move-kutsun jälkeen vahvistaaksesi vaikutuksen. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
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
Muuta kanavasääntöä
channel_rules_update
Muuttaa mukautettua kanavasääntöä, löydettynä id:llä channel_rules_list-kutsusta. Lähetä channel nimetäksesi uudelleen kanavan, jonka se antaa, ja conditions korvataksesi koko ehtolistan (lista korvataan eikä yhdistetä, joten lähetä jokainen ehto, jonka haluat säilyttää). Pois jätetyt syötteet jätetään ennalleen. Ehtokentät, operaattorit ja säännöllisen lausekkeen kelvollisuus tarkistetaan samoin kuin channel_rules_create-kutsussa. Muutos koskee vain uusia käyntejä. Järjestyksen muuttamiseen käytä channel_rules_move-kutsua. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
curl -X PATCH https://privatusanalytics.com/sites/:site_id/channel_rules/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Keräys
POST
/embed/ads/e.json
Kirjaa, että mainos näytettiin, nähtiin tai klikattiin, mainoslataajan kutsuma
ad_serving_event
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/embed/ads/e.json \
-H "Content-Type: application/json" -d '{…}'
GET
/embed/ads/:site.json
Sivuston mainospaikat ja kunkin näyttämät mainokset, mainoslataajan kutsuma
ad_serving_slots
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/embed/ads/:site.json
POST
/api/overlay.json
Yhden sivun klikkaukset klikkauskerrosta varten, pa.overlay.js kutsuu tätä omalla avaimellaan
click_overlays_read
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/api/overlay.json \
-H "Content-Type: application/json" -d '{…}'
POST
/api/logs.json
Lähetä palvelimen käyttölokit tekoälyindeksoijien raportointia varten (JSON {lines: [...]} tai yhdistetty lokiteksti, sivuston indeksoijalokien avain Bearer-tunnisteena)
crawler_logs_create
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/api/logs.json \
-H "Content-Type: application/json" -d '{…}'
POST
/api/event.json
Kerää selainkutsu (käyttää /js/pa.js)
ingest_event
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/api/event.json \
-H "Content-Type: application/json" -d '{…}'
GET
/api/experiment.json
Ohjaako kokeilu tämän kävijän varianttisivulle, kokeilujen head-skriptin kutsuma
ingest_experiment
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/api/experiment.json
GET
/js/exp/:site.json
Skripti, jonka valinnainen kokeilujen head-tagi lataa sivustolle
ingest_experiment_script
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/js/exp/:site.json
POST
/api/survey.json
Kirjaa, että kyselykortti näytettiin, suljettiin tai vastattiin
ingest_survey
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/api/survey.json \
-H "Content-Type: application/json" -d '{…}'
GET
/api/surveys.json
Mikä kysely sivulla näytetään, seurantakoodin ask-moduulin kutsuma
ingest_surveys
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/api/surveys.json
Kokeilut
POST
/sites/:site_id/experiments.json
Luo kokeilu luonnoksena
experiments_create
Luo A/B- tai jaetun URL:n testin sivustolle. Se tallennetaan luonnoksena eikä ohjaa yhtään kävijää minnekään, ennen kuin ihminen käynnistää sen sovelluksessa. Pakollisia ovat name, path (alkuperäinen sivu, kuten /pricing), goal_id (goals_list-kutsusta) ja variants: lista muodossa { name, path, weight }, jossa ensimmäinen rivi on alkuperäinen sivu (sen path ohitetaan) ja jokainen muu rivi on saman sivuston sivu. Jätä kaikki weight-arvot pois tasaiselle jaolle tai lähetä painot, joiden summa on 100. Free-paketti sallii yhden kokeilun kerrallaan alkuperäisellä ja yhdellä variantilla. Pro ja ylöspäin lisäävät enemmän variantteja, automaattisen jaon, kohdennuksen, *-merkin polussa, toissijaiset tavoitteet, ajastetun aloituksen ja yksinoikeusryhmät. Vaatii content.write-oikeuden. Palauttaa kokeilun.
Oikeus: content.write
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
Poista kokeilu tuloksineen
experiments_delete
Poistaa kokeilun variantteineen ja tuloksineen pysyvästi. Tätä ei voi perua. Käytä experiments_pause-kutsua pysäyttääksesi sen ja säilyttääksesi tulokset. MCP-työkalu ei suorita sitä vaan vastaa arvolla human_only ja sivulla, jolla ihminen poistaa sen. Vaatii content.write-oikeuden.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Kopioi kokeilu uudeksi luonnokseksi
experiments_duplicate
Luo luonnoksen, jolla on samat sivut, osuudet, tavoite ja säännöt kuin olemassa olevalla kokeilulla mutta ei yhtään sen tulosta. Käytä sitä jo alkaneen testin muuttamiseen. Kuluttaa paketin rajaa kuten uusi kokeilu. Vaatii content.write-oikeuden. Palauttaa uuden kokeilun.
Oikeus: content.write
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
Lopeta kokeilu lopullisesti
experiments_end
Lopettaa käynnissä olevan tai keskeytetyn kokeilun. Sitä ei voi käynnistää uudelleen, sen tulokset säilyvät eikä se enää kuluta paketin rajaa. MCP-työkalu ei suorita sitä vaan vastaa arvolla human_only ja sivulla, jolla ihminen lopettaa sen. API suorittaa sen. Vaatii content.write-oikeuden.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Listaa sivuston kokeilut
experiments_list
Listaa sivuston A/B- ja jaetun URL:n testit uusin ensin. Suodata status-arvolla (draft, scheduled, running, paused, ended tai all, oletus all). Sivutettu page- ja per_page-arvoilla (oletus 25, enintään 100). Jokaisella kokeilulla on id (exp_...), name, status, path (alkuperäinen sivu), goal_id, variants (id, name, path, weight, control), lopetussäännöt ja locked (true, kun paketti ei enää kata sitä). Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/experiments.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/experiments/:id/pause.json
Keskeytä kokeilu ja säilytä sen tulokset
experiments_pause
Keskeyttää käynnissä olevan tai ajastetun kokeilun. Jokainen kävijä saa heti taas alkuperäisen sivun, ja tähänastiset tulokset säilyvät. experiments_start jatkaa sitä. Vaatii content.write-oikeuden. Palauttaa kokeilun.
Oikeus: content.write
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
Hae yksi kokeilu tuloksineen
experiments_get
Palauttaa yhden kokeilun id:n perusteella (exp_..., experiments_list-kutsusta) tuloksineen: variantteittain käynnit, konversiot ja konversioaste tavoitteella sekä alkuperäiseen verrattuna nousu, eron todennäköinen vaihteluväli, p-arvo, onko tulos merkitsevä valitulla luottamustasolla ja todennäköisyys, että variantti voittaa alkuperäisen. results.progress kertoo, kuinka kaukana voittajan julistaminen on, ja results.mismatch.found arvolla true tarkoittaa, että käynnit eivät jakaudu painojen mukaan, joten tulokseen ei pidä luottaa. split erittelee tulokset laitteen, kanavan tai maan mukaan (Pro ja ylöspäin) ja humans_only pitää mukana käynnit, joita bottipisteytys pitää todennäköisesti ihmisinä (Business). Käynti lasketaan variantille, kun se näki kyseisen variantin, ja konversio lasketaan vasta sen jälkeen. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/experiments/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/experiments/:id/start.json
Käynnistä kokeilu
experiments_start
Käynnistää luonnoksen tai keskeytetyn kokeilun, jolloin alkuperäisen sivun kävijöitä aletaan ohjata variantteihin. Kun starts_at on tulevaisuudessa, se odottaa kyseiseen aikaan. Koska se ohjaa oikeita kävijöitä, MCP-työkalu ei suorita sitä vaan vastaa arvolla human_only ja sivulla, jolla ihminen käynnistää sen. API suorittaa sen. Vaatii content.write-oikeuden.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Päivitä kokeilu
experiments_update
Muuttaa kokeilua. Vain lähettämäsi syötteet muuttuvat, ja variants korvaa koko listan. Kun kokeilu on alkanut, vain name ja send_to_winner voivat muuttua, koska uudet sivut, osuudet tai tavoitteet kesken kokeilun pilaisivat tuloksen: käytä experiments_duplicate-kutsua ja muokkaa kopiota. Vaatii content.write-oikeuden. Palauttaa kokeilun.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/experiments/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Koontinäkymät
GET
/workspaces/:workspace_id/dashboards/:id/cards/:index.json
Oman koontinäkymän yhden kortin tiedot
dashboards_card
Palauttaa mukautetun koontinäkymän yhden kortin live-datan. Koontinäkymät ovat korttien listoja (korttilista löytyy dashboards_get-kutsusta) ja jokainen kortti latautuu erikseen, joten kutsu tätä kerran korttia kohti sen sijainnilla index, laskettuna 0:sta. Palauttaa index, type, title, site_id, site_name, params, status ja data. status on ok, not_available (kortilla ei ole mitään näytettävää, esimerkiksi suppilokortti sivustolla, jolla ei ole suppiloita, tai käytettävyyskortti ilman tarkistuksia) tai no_access (kortti kuuluu sivustolle, jota tunnisteesi tai roolisi ei voi avata, ja silloin title, params ja data ovat tyhjiä). data-kentän muoto riippuu tyypistä. metric antaa {metric, value, previous, change, period} verrattuna edelliseen jaksoon. chart antaa {metric, interval, period, series: [{date, value}]}. breakdown antaa {dimension, label, rows}. goal antaa {rows} tavoitteiden suorituksista. live antaa {visitors}. funnel antaa {funnel_id, name, overall_conversion_rate, steps}. uptime antaa {checks: [{name, status, uptime}]}. vitals antaa {scorecard}. subscriptions antaa {currency, mrr_minor, previous_mrr_minor (30 päivää sitten), change (prosentti, null jos 30 päivää sitten ei ollut MRR:ää), active_subscriptions, subscription_churn_rate (viimeiset 30 päivää)} ja on not_available, kun sivustolla ei ole maksupalveluntarjoajaa yhdistettynä. Kortin params-oletukset ovat period 30d, metric visitors, dimension page ja 5 riviä (limit on rajattu 10:een). Listan ulkopuolinen index palauttaa 404. Käytä ensin dashboards_get-kutsua nähdäksesi, kuinka monta korttia on.
Oikeus: analytics.read
curl https://privatusanalytics.com/workspaces/:workspace_id/dashboards/:id/cards/:index.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/workspaces/:workspace_id/dashboards.json
Luo oma koontinäkymä
dashboards_create
Luo mukautetun koontinäkymän työtilaan. Mukautettu koontinäkymä on nimetty, järjestetty lista enintään 40 korttia, ja kortit voivat tulla työtilan eri sivustoilta. Anna name (enintään 100 merkkiä) ja cards, lista objekteja, joissa on type (metric, chart, breakdown, goal, live, funnel, uptime, vitals tai subscriptions), site_id (pa_..., sites_list-kutsusta) ja valinnaisesti title (enintään 80 merkkiä) ja params. Tyyppikohtaiset params-arvot ovat metric (period, metric), chart (period, metric, interval), breakdown (period, dimension, limit), goal (period, limit), funnel (period, funnel_id), uptime (limit) ja vitals (period). live ja subscriptions eivät ota yhtään. Muut params-arvot pudotetaan. period-arvon on oltava esiasetus, kuten 30d (ei custom), ja metric yksi arvoista visitors, visits, pageviews, views_per_visit, bounce_rate tai visit_duration. Jokaisen kortin on osoitettava sivustoon, johon tunnisteesi pääsee, ja vain joihinkin sivustoihin rajatun tunnisteen on sisällytettävä vähintään yksi kortti. Palauttaa koontinäkymän kentillä id (dash_...), name, cards ja aikaleimat. Lue se dashboards_get-kutsulla ja lataa kunkin kortin luvut dashboards_card-kutsulla. Vaatii content.write-oikeuden. Paketti määrää, kuinka monta koontinäkymää työtilalla on: 1 Free-paketissa, 3 Pro-paketissa, rajattomasti Business-paketissa. Yksi määrän yli hylätään validointivirheellä.
Oikeus: content.write
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
Poista oma koontinäkymä
dashboards_delete
Poistaa mukautetun koontinäkymän pysyvästi. Vain koontinäkymän asettelu poistetaan, analytiikkadataan ei kosketa, eikä kumoamista ole. Tarvitset pääsyn jokaiselle sivustolle, jolla on kortti koontinäkymässä, ja koontinäkymässä on oltava vähintään yksi kortti sivustolta, johon pääset. Palauttaa poistetun koontinäkymän. Käytä dashboards_update-kutsua koontinäkymän muuttamiseen sen sijaan. Tunnukset (dash_...) tulevat dashboards_list-kutsusta. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Listaa omat koontinäkymät
dashboards_list
Listaa työtilan mukautetut koontinäkymät nimen mukaan järjestettyinä. Jokaisella kohteella on id (dash_...), name, cards ja aikaleimat, sama muoto kuin dashboards_get-kutsussa. Vain joihinkin sivustoihin rajattu tunniste näkee vain koontinäkymät, joissa on kortti jollakin sen sivustoista, ja muiden sivustojen kortit tyhjennetään muotoon {type, status: no_access}. Sivutettu page- ja per_page-arvoilla (enintään 100). Käytä dashboards_card-kutsua kortin datan lataamiseen ja dashboards_create-kutsua koontinäkymän lisäämiseen. Yhdelle sivustolle stats_overview antaa samanlaiset luvut ilman koontinäkymää.
Oikeus: analytics.read
curl https://privatusanalytics.com/workspaces/:workspace_id/dashboards.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/workspaces/:workspace_id/dashboards/:id.json
Hae oma koontinäkymä ja sen kortit
dashboards_get
Palauttaa yhden mukautetun koontinäkymän: id (dash_...), name, cards sekä created_at ja updated_at. Jokainen kortti on {type, site_id, title, params} (type on metric, chart, breakdown, goal, live, funnel, uptime, vitals tai subscriptions). Kortti sivustolla, johon et pääse, palautetaan muodossa {type, status: no_access} ilman muita kenttiä. Tämä palauttaa vain asettelun, ei lukuja. Lataa kortin luvut dashboards_card-kutsulla käyttäen kortin sijaintia laskettuna 0:sta. Tunnukset tulevat dashboards_list-kutsusta. Paketin määrän ylittävä koontinäkymä (1 Free-paketissa, 3 Pro-paketissa) säilytetään ja lukitaan: se vastaa 402 plan_limit, kunnes työtila päivittää tai poistaa toisen.
Oikeus: analytics.read
curl https://privatusanalytics.com/workspaces/:workspace_id/dashboards/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/workspaces/:workspace_id/dashboards/:id.json
Nimeä oma koontinäkymä uudelleen tai korvaa sen kortit
dashboards_update
Nimeää mukautetun koontinäkymän uudelleen ja/tai korvaa sen koko korttilistan. Vain lähettämäsi kentät muuttuvat, ja name jätetään ennalleen, kun se on tyhjä. Korttien lähettäminen korvaa jokaisen kortin, joten lähetä koko lista haluamassasi järjestyksessä, otettuna dashboards_get-kutsusta ja muokattuna. Kortin muoto ja tyyppikohtaiset params ovat samat kuin dashboards_create-kutsussa (enintään 40 korttia). Muodossa {type, status: no_access} näytetty kortti kuuluu sivustolle, jota et voi avata. Lähetä se takaisin muuttamattomana säilyttääksesi sen, sitä ei voi muokata, eikä tällaisen sivuston viimeistä korttia voi poistaa. Vain joihinkin sivustoihin rajattu tunniste ei voi jättää koontinäkymää tyhjäksi. Palauttaa päivitetyn koontinäkymän. Vaatii content.write-oikeuden.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/workspaces/:workspace_id/dashboards/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Kumppanuusohjelma
GET
/account/affiliate/commissions.json
Listaa kumppanuusprovisiosi
affiliate_commissions_list
Provisiot, rahanpalautuksista ja takaisinveloituksista johtuvat takaisinperinnät sekä niiden peruutukset, uusimmat ensin. Summat ovat sentteinä.
Oikeus: member
curl https://privatusanalytics.com/account/affiliate/commissions.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/account/affiliate/signup-box.json
Hae kumppanin rekisteröitymislaatikon koodi ja tulokset
affiliate_signup_box_get
Rekisteröitymislaatikon upotuskoodi (skripti ja pelkkä iframe) valitulle teemalle, lomakkeen esitäyttävät attribuutit, skriptin sivullesi lähettämät tapahtumat sekä laatikon luvut: vahvistusta odottavat rekisteröitymiset, vahvistetut rekisteröitymiset ja maksavat asiakkaat. available on false, kunnes kumppanihakemuksesi on hyväksytty.
Oikeus: member
curl https://privatusanalytics.com/account/affiliate/signup-box.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/account/affiliate.json
Hae kumppanuustilasi, suosittelulinkkisi ja tilastosi
affiliate_get
Kumppanuushakemuksesi tila, suosittelulinkki, suosittelemasi rekisteröitymiset ja maksavat asiakkaat sekä saldot valuutoittain (pidossa, maksettavissa, maksettu). status on none, jos et ole hakenut.
Oikeus: member
curl https://privatusanalytics.com/account/affiliate.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Kyselyt
POST
/sites/:site_id/surveys.json
Luo kysely
surveys_create
Luo evästeettömän sivustokyselyn sivustolle. Se ei kerää mitään, ennen kuin sen status on active, joten luo se ensin luonnoksena tai anna status active aloittaaksesi heti. Pakollisia ovat name (sisäinen, kävijät eivät koskaan näe sitä, enintään 120 merkkiä) ja questions (1 - 5 riviä järjestyksessä). Jokainen kysymys on objekti, jossa on key (valinnainen, pysyvä tunnus pienistä kirjaimista, numeroista ja alaviivoista, generoidaan jos jätetään pois), kind (text, choice, multi, rating, nps tai yes_no), prompt (pakollinen, enintään 200 merkkiä), required (totuusarvo), choices (lista enintään 10 vaihtoehdosta, vain lajeille choice ja multi) ja scale (3, 5, 7 tai 10, vain lajille rating, oletus 5). NPS käyttää aina asteikkoa 0 - 10. Kohdennus on trigger_kind (immediate, delay, scroll, exit tai manual) arvoilla delay_seconds (0 - 600, oletus 10, vain delay-lajille) ja scroll_percent (1 - 100, oletus 50, vain scroll-lajille), paths (rivit match_type exact, prefix tai glob ja pattern, tyhjä tarkoittaa jokaista sivua), devices (desktop, mobile, tablet, tyhjä tarkoittaa kaikkia), position (bottom_right, bottom_left tai center), sample_rate (1 - 100 prosenttia kävijöistä), thank_you (enintään 200 merkkiä), starts_on ja ends_on (YYYY-MM-DD). Kyselyissä ei voi pyytää sähköpostiosoitetta, ja kirjoitetuista vastauksista puhdistetaan henkilötiedot. Free-paketti sallii 1 kyselyn työtilaa kohti ja rajoitetun määrän vastauksia kuukaudessa, maksulliset paketit ovat rajattomia. Vaatii content.write-oikeuden. Palauttaa kyselyn kentällä id (svy_...). Lue vastaukset surveys_get-kutsulla.
Oikeus: content.write
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
Poista kysely vastauksineen
surveys_delete
Poistaa kyselyn pysyvästi kaikkine vastauksineen. Tätä ei voi perua ja tulokset menetetään. Käytä sen sijaan surveys_pause-kutsua, jos haluat vain lopettaa keräämisen. id tulee surveys_list-kutsusta ja site_id vaaditaan. Vaatii content.write-oikeuden. Palauttaa poistetun kyselyn.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Listaa sivuston kyselyt vastausmäärineen
surveys_list
Listaa sivuston kyselyt uusin ensin asetuksineen ja vastausmäärineen. Suodata status-arvolla (draft, active, paused tai all, oletus all). Sivutettu page- ja per_page-arvoilla (oletus 25, enintään 100). Jokaisella kyselyllä on id (svy_...), name, status, questions, kohdennusasetukset, starts_on, ends_on, created_at, updated_at ja stats (responses-, completed- ja this_month-määrät). Käytä surveys_get-kutsua yhden kyselyn vastauksiin ja tuloksiin.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/surveys.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/surveys/:id/pause.json
Lopeta vastausten kerääminen ja säilytä jo annetut vastaukset
surveys_pause
Keskeyttää kyselyn, jolloin sitä ei enää tarjota kävijöille heti. Jo kerätyt vastaukset säilyvät ja näkyvät surveys_get-kutsussa, ja surveys_start jatkaa sitä. Käytä sitä surveys_delete-kutsun sijaan, kun haluat vain lopettaa keräämisen. id tulee surveys_list-kutsusta ja site_id vaaditaan. Vaatii content.write-oikeuden. Palauttaa kyselyn tilalla paused.
Oikeus: content.write
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
Kyselyn tulokset jaksolta, eriteltynä kysymyksittäin
surveys_get
Palauttaa yhden kyselyn tulosraportin jaksolta, ei vain sen asetuksia (käytä surveys_list-kutsua asetuksiin ja määriin). Valitse period-esiasetus (oletus 30d) tai period custom arvoilla from ja to. Vastauksessa on survey (sen asetukset), period (from ja to ISO 8601 -aikoina), responses (henkilöt, jotka vastasivat vähintään yhteen kysymykseen), completed (henkilöt, jotka vastasivat viimeiseen kysymykseen), questions (yksi merkintä kysymystä kohti kentillä key, kind, prompt ja answers-määrä sekä lajikohtainen erittely) ja pages, devices ja countries (enintään 10 riviä kutakin kentillä value ja count). Lajikohtainen erittely on texts (enintään 100 uusinta kirjoitettua vastausta kentillä text ja at) lajille text, choices (value, count, share prosenttina yhdellä desimaalilla, offered) lajeille choice, multi ja yes_no, average (null ilman vastauksia), scale ja distribution lajille rating sekä score (NPS välillä -100 - 100, null ilman vastauksia), promoters (9 ja 10), passives (7 ja 8), detractors (0 - 6) ja distribution lajille nps. Käytä surveys_themes-kutsua kirjoitettujen vastausten tiivistämiseen.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/surveys/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/surveys/:id/start.json
Aloita vastausten kerääminen
surveys_start
Asettaa kyselyn tilaan active, jotta sitä voidaan tarjota kävijöille. Se näkyy vain, kun nykyinen päivämäärä on välillä starts_on ja ends_on (kun asetettu), sivu täsmää sen polkuihin ja laitteisiin eikä paketin kuukausittaista vastauskiintiötä ole käytetty loppuun. Käytä sitä luonnokselle tai keskeytetylle kyselylle. id tulee surveys_list-kutsusta ja site_id vaaditaan. Vaatii content.write-oikeuden. Palauttaa kyselyn tilalla active. Pysäytä se taas surveys_pause-kutsulla.
Oikeus: content.write
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
Ryhmittele yhden kysymyksen vapaamuotoiset vastaukset teemoihin (Business-paketti)
surveys_themes
Käyttää tekoälyä ryhmitelläkseen yhden vapaatekstikysymyksen kirjoitetut vastaukset teemoihin. Vain Business-paketti. Valitse se, kun surveys_get näyttää tekstikysymyksen, jossa on tarpeeksi vastauksia, ja anna question_key (surveys_get-kutsun lajin text kysymyksen avain). Se tarvitsee vähintään 5 kirjoitettua vastausta ja käyttää 300 viimeisintä. Tulos listaa enintään 12 teemaa, kullakin label, count, sentiment (positive, neutral tai negative) ja example (edustava vastaus, voi olla null), sekä answers (kuinka monta vastausta tiivistettiin) ja generated_at. Jokainen uusi generointi kuluttaa yhden kysymyksen työtilan kuukausittaisesta tekoälykiintiöstä, joka palautetaan, jos se epäonnistuu. Tulos välimuistitetaan vastauksia vasten, joten uusi kutsu ilman uusia vastauksia ei maksa mitään. Se epäonnistuu validointivirheeseen, kun paketti ei sisällä sitä, kiintiö on käytetty, tekoälyä ei ole määritetty tai vastauksia on liian vähän.
Oikeus: analytics.read
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
Päivitä kysely
surveys_update
Muuttaa kyselyä. Vain lähettämäsi syötteet muuttuvat. Syötteet ja rajat ovat samat kuin surveys_create-kutsussa, ja status on draft, active tai paused. Kun lähetät questions, koko lista korvataan, joten sisällytä jokainen kysymys, jonka haluat säilyttää, ja säilytä jokaisen olemassa olevan key, jotta kerätyt vastaukset säilyvät (kysymyksen sanamuodon muuttaminen samalla key-arvolla ei jaa tuloksia). Pois jätetyt kysymykset lakkaavat näkymästä tuloksissa. Kohdennuksen muutokset tulevat voimaan kävijöille heti. id tulee surveys_list-kutsusta ja site_id vaaditaan. Vaatii content.write-oikeuden. Palauttaa päivitetyn kyselyn.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/surveys/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Käytettävyys
POST
/sites/:site_id/uptime.json
Lisää sivuston käytettävyystarkistus
uptime_checks_create
Lisää käytettävyystarkistuksen, joka on sidottu yhteen sivustoon. Käytä workspace_uptime_checks_create-kutsua tarkistukseen, joka ei kuulu millekään sivustolle. kind ratkaisee kohteen. http tarkistaa url-osoitteen tilakoodin, keyword tarkistaa, että url-osoitteen vastauksen sisältö sisältää keyword-arvon, tcp yhdistää arvoihin host ja port, ja dns tarkistaa, että host selviää. Muiden lajien kentät ohitetaan. url on oletuksena sivuston etusivu http-tarkistuksille. expected_status (100 - 599, oletus 200), http_method (GET tai HEAD) ja timeout_seconds (1 - 30, oletus 20) koskevat http- ja keyword-tarkistuksia. interval_seconds on aika kyselyjen välillä, sen on oltava vähintään paketin vähimmäisarvo (Free 300, Pro 60, Business 30) ja oletus on 300 tai vähimmäisarvo, jos se on suurempi. public true antaa tarkistuksen näkyä tilasivulla. Yksityiset ja sisäiset osoitteet hylätään, ja paketti rajoittaa tarkistusten määrää työtilaa kohti (Free 3, Pro 20, Business 100). Ensimmäinen kysely tehdään hetken kuluessa, ja status on aluksi pending. Vaatii uptime.manage-oikeuden. Palauttaa tarkistuksen kentällä id (upc_...).
Oikeus: uptime.manage
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
Poista käytettävyystarkistus ja sen historia
uptime_checks_delete
Poistaa käytettävyystarkistuksen pysyvästi tuloksineen ja häiriöhistorioineen ja poistaa sen kaikilta tilasivuilta, jotka sitä näyttävät. Tätä ei voi perua. Käytä uptime_checks_pause-kutsua lopettaaksesi kyselyt mutta säilyttääksesi historian. id tulee uptime_checks_list-kutsusta. Vaatii uptime.manage-oikeuden. Palauttaa poistetun tarkistuksen.
Oikeus: uptime.manage
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
Listaa sivuston käytettävyystarkistukset
uptime_checks_list
Listaa yhden sivuston käytettävyystarkistukset, mukaan lukien koko työtilan tarkistukset, jotka kyselevät sivuston verkkotunnusta tai sen aliverkkotunnusta. Lajiteltu nimen mukaan. Käytä workspace_uptime_checks_list-kutsua kaikille työtilan tarkistuksille. Suodata status-arvolla (up, down, pending tai paused) tai query-arvolla (osa nimestä, url-osoitteesta tai hostista). Sivutettu page- ja per_page-arvoilla (enintään 100). Jokaisella tarkistuksella on id (upc_...), workspace_id, site_id (null koko työtilan tarkistuksille), name, kind, url, host, port, keyword, expected_status, http_method, interval_seconds, timeout_seconds, status (up, down, pending tai paused), enabled, public, last_checked_at, next_check_at, last_response_ms (millisekunteina), ssl_expires_at, ssl_issuer, domain_expires_at ja created_at. Käytä uptime_checks_get-kutsua käytettävyysprosentteihin ja häiriöihin.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/uptime.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/uptime/checks/:id/pause.json
Keskeytä käytettävyystarkistus
uptime_checks_pause
Keskeyttää käytettävyystarkistuksen, jolloin sitä ei enää kysellä. Mahdollinen avoin häiriö suljetaan heti, eikä down- tai up-hälytyksiä lähetetä sen ollessa keskeytettynä. Historia säilyy ja sen tila näkyy arvona paused. Jatka sitä uptime_checks_resume-kutsulla. id tulee uptime_checks_list-kutsusta. Vaatii uptime.manage-oikeuden. Palauttaa tarkistuksen.
Oikeus: uptime.manage
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
Jatka keskeytettyä käytettävyystarkistusta
uptime_checks_resume
Jatkaa keskeytettyä käytettävyystarkistusta. Sitä kysellään seuraavalla ajastimen tickillä ja sen tila on pending, kunnes ensimmäinen tulos saapuu. id tulee uptime_checks_list-kutsusta. Vaatii uptime.manage-oikeuden. Palauttaa tarkistuksen.
Oikeus: uptime.manage
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
Hae käytettävyystarkistus: käytettävyys 24 h/7 pv/30 pv, vasteajat ja häiriöt
uptime_checks_get
Palauttaa yhden käytettävyystarkistuksen historioineen, ei vain asetuksia. Valitse range (24h oletus, 7d tai 30d) vasteaikakaaviolle. Vastauksessa on check (asetukset ja live-tila, katso uptime_checks_list), uptime (prosentti ajalle 24h, 7d ja 30d, null kunnes ensimmäinen kysely on tehty), range, response_times (yksikkö hour tai day, otsikot ISO 8601 -aikoina ja sarjat keskimääräisestä vasteajasta millisekunteina sijaintia kohti, null aukoille) sekä incidents (50 viimeisintä kentillä started_at, resolved_at null kun vielä auki, duration_seconds, cause ja failed_locations). Vain onnistuneet kyselyt lasketaan vasteaikoihin. id tulee uptime_checks_list-kutsusta.
Oikeus: analytics.read
curl https://privatusanalytics.com/uptime/checks/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/uptime/checks/:id.json
Muuta käytettävyystarkistusta
uptime_checks_update
Muuttaa käytettävyystarkistusta. Vain lähettämäsi syötteet muuttuvat. Säännöt ja rajat ovat samat kuin uptime_checks_create-kutsussa (välin on oltava vähintään paketin vähimmäisarvo, yksityiset osoitteet hylätään). kind-arvon muuttaminen tyhjentää kohdekentät, jotka eivät enää päde. interval_seconds-arvon muuttaminen ajastaa seuraavan kyselyn heti. id tulee uptime_checks_list-kutsusta. Vaatii uptime.manage-oikeuden. Palauttaa päivitetyn tarkistuksen.
Oikeus: uptime.manage
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
Koettimien konesali, User-Agent ja lähtevän liikenteen IP-alueet (käytettävyyskoettimiemme sallintaa varten)
uptime_probes_list
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/uptime/probes.json
POST
/uptime/probes/results.json
Lähetä ulkoisen koetinagentin tulokset (Bearer-käytettävyyskoetintunniste)
uptime_probes_results
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/uptime/probes/results.json \
-H "Content-Type: application/json" -d '{…}'
POST
/workspaces/:workspace_id/uptime.json
Lisää työtilan käytettävyystarkistus (ei sidottu sivustoon)
workspace_uptime_checks_create
Lisää käytettävyystarkistuksen, joka kuuluu koko työtilalle yhden sivuston sijaan. Käytä uptime_checks_create-kutsua sitoaksesi tarkistuksen sivustoon. Syötteet, paketin rajat ja säännöt ovat samat, katso uptime_checks_create. kind on http, keyword, tcp tai dns ja ratkaisee, mitkä arvoista url, keyword, host ja port pätevät. Koska sivustoa ei ole, http-tarkistus tarvitsee nimenomaisen url-osoitteen. Vain joihinkin sivustoihin rajatut kutsujat eivät voi luoda koko työtilan tarkistuksia. Tarvitsee workspace_id-arvon workspaces_list-kutsusta ja uptime.manage-oikeuden. Palauttaa tarkistuksen kentällä id (upc_...) ja site_id null.
Oikeus: uptime.manage
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
Listaa kaikki työtilan käytettävyystarkistukset
workspace_uptime_checks_list
Listaa työtilan jokaisen käytettävyystarkistuksen, mukaan lukien tarkistukset, jotka eivät kuulu millekään sivustolle, nimen mukaan lajiteltuina. Vain joihinkin sivustoihin rajattu kutsuja näkee vain näiden sivustojen tarkistukset. Käytä uptime_checks_list-kutsua yhden sivuston tarkistuksiin. Suodata status-arvolla (up, down, pending tai paused) tai query-arvolla (osa nimestä, url-osoitteesta tai hostista). Sivutettu page- ja per_page-arvoilla (enintään 100). Jokaisella kohteella on uptime_checks_list-kutsussa kuvatut kentät. Tarvitsee workspace_id-arvon workspaces_list-kutsusta.
Oikeus: analytics.read
curl https://privatusanalytics.com/workspaces/:workspace_id/uptime.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Laskutus
POST
/workspaces/:workspace_id/billing/badge.json
Ota merkkibonus käyttöön tai pois käytöstä (ilmainen paketti)
billing_badge
Ottaa Free-työtilan mukaan Privatus Analytics -merkin bonukseen tai pois siitä, mikä nostaa kuukauden tapahtumakiintiötä. Aseta enabled arvoon true ottaaksesi käyttöön. Taustatarkistus etsii sitten merkkiä työtilan sivustoilta ja vahvistaa sen, mikä voi kestää hetken, joten lue billing_get-kutsu sen jälkeen ja katso badge.verified_at. Aseta enabled arvoon false poistaaksesi käytöstä, mikä tyhjentää tarkistus- ja vahvistuspäivät ja poistaa bonuksen. Käyttöönotto Pro- tai Business-työtilassa hylätään, koska maksullisissa paketeissa ei ole bonusta. Palauttaa työtilan laskutusobjektin kuten billing_get. Vaatii billing.manage-oikeuden.
Oikeus: billing.manage
· Vain HTTP (ei MCP-työkalu)
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
Peruuta laskutusjakson lopussa
billing_cancel
Peruu maksullisen tilauksen nykyisen maksetun jakson lopussa. Mitään ei hyvitetä ja paketti pysyy aktiivisena kunnes current_period_ends_at, minkä jälkeen työtila siirtyy Free-pakettiin. Käytä billing_resume-kutsua perumisen kumoamiseen sitä ennen. Epäonnistuu, kun työtilalla ei ole tilausta tai peruutus on jo ajastettu. Valinnainen reason (yksi enum-arvoista) ja comment ovat poistumiskysely. Kommentti, jos se annetaan, lähetetään sähköpostilla Privatus Analytics -tiimille palauteviestinä jäseneltä, eikä sitä tallenneta. Palauttaa laskutusobjektin, jossa cancel_at_period_end on true. Vaatii billing.manage-oikeuden.
Oikeus: billing.manage
· Vain HTTP (ei MCP-työkalu)
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
Vaihda pakettia, tasoa tai jaksoa (suhteutettuna)
billing_change_plan
Siirtää olemassa olevan tilauksen toiseen pakettiin, tapahtumatasoon tai laskutusjaksoon. Tämä veloittaa rahaa. Muutos tulee voimaan heti ja Paddle jaksottaa sen suhteellisesti, joten veloitus tai hyvitys kohdistuu heti tallennettuun maksutapaan. Suorita ensin billing_preview samoilla syötteillä nähdäksesi täsmälliset summat. Epäonnistuu, jos työtilalla ei ole tilausta (käytä siihen billing_checkout-kutsua), jos kohde on nykyinen paketti, taso ja jakso, tai jos paketin ja tapahtumien yhdistelmälle ei ole hintaa. events-arvon on oltava yksi plans_list-kutsun tasoista. Palauttaa päivitetyn laskutusobjektin. Vaatii billing.manage-oikeuden.
Oikeus: billing.manage
· Vain HTTP (ei MCP-työkalu)
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
Aloita Paddle-kassa maksulliselle paketille
billing_checkout
Aloittaa Paddle-kassan työtilalle, jolla ei vielä ole tilausta, ja palauttaa isännöidyn kassan URL-osoitteen. Mitään ei veloiteta ennen kuin henkilö viimeistelee kassan selaimessa, joten anna url henkilölle. Käytä sen sijaan billing_change_plan-kutsua, kun työtilalla on jo tilaus. Syötteet ovat plan (pro tai business), events (kuukausittaisten tapahtumien taso plans_list-kutsusta) ja interval (month tai year, oletus month). Hinnat sisältävät arvonlisäveron tai myyntiveron. Hyväksytty alennusohjelma otetaan käyttöön automaattisesti ja siitä kerrotaan kentässä discount_id. Palauttaa transaction_id, url (voi olla null), price_id, plan, events, interval, amount (kokonaisina Yhdysvaltain dollareina jaksolle), client_token ja environment (sandbox tai production, Paddlen overlay-ikkunan käyttämät), custom_data ja discount_id (voi olla null). Epäonnistuu, jos työtilalla on jo tilaus. Vaatii billing.manage-oikeuden.
Oikeus: billing.manage
· Vain HTTP (ei MCP-työkalu)
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
Hae voittoa tavoittelemattoman, koulutuksen tai avoimen lähdekoodin alennusta
billing_discount
Hakee työtilalle alennusohjelmaa. Tämä lähettää hakemuksen henkilökunnan tarkistettavaksi ja ilmoittaa Privatus Analytics -tiimille sähköpostilla, mutta ei myönnä alennusta itsestään. Ohjelmat ovat nonprofit, education, open_source (50 prosentin alennus), open_source_free (ilmainen Pro enintään 1 M tapahtumaan kuukaudessa) ja agency (20 prosentin alennus jokaisesta omistamastasi työtilasta). Työtilaa kohti sallitaan vain yksi avoin hakemus (pending, approved tai active), ja voit hakea uudelleen hylkäyksen tai peruutuksen jälkeen. license säilytetään vain kahdelle avoimen lähdekoodin ohjelmalle. Palauttaa hakemuksen kentillä program, status, percent, comp_events (voi olla null), organization_name, website, proof_url, license, note, rejection_reason, created_at, reviewed_at, applied_at ja revoked_at (aikaleimat, voivat olla null). Seuraa etenemistä myöhemmin billing_get-kutsun discount-kentästä. Vaatii billing.manage-oikeuden.
Oikeus: billing.manage
· Vain HTTP (ei MCP-työkalu)
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
Hae linkki maksutavan päivittämiseen
billing_payment_method
Palauttaa Paddle-linkin, jossa henkilö voi päivittää tilauksen maksutavan. Itse kutsu ei muuta mitään. Anna url henkilölle avattavaksi selaimessa. Tuloksessa on kind (payment_method) ja url. Epäonnistuu, kun työtilalla ei ole aktiivista tilausta. Laskuja, osoitteita ja kaikkia muita laskutustietoja varten käytä billing_portal-kutsua. Vaatii billing.manage-oikeuden.
Oikeus: billing.manage
· Vain HTTP (ei MCP-työkalu)
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
Hae Paddlen asiakasportaalin linkki
billing_portal
Palauttaa linkin Paddlen asiakasportaaliin, jossa henkilö voi nähdä laskut, maksutavat ja osoitteet. Itse kutsu ei muuta mitään. Anna url henkilölle avattavaksi selaimessa. Tuloksessa on kind (portal) ja url. Epäonnistuu, jos työtilalla ei ole vielä Paddle-asiakasta (se ei ole koskaan käynyt kassalla) tai kun asiakas on jaettu muiden työtilojen kanssa, joihin kutsuja ei pääse, koska portaali paljastaa kaikki asiakkaan tiedot. Käytä billing_payment_method-kutsua pelkkään korttiin. Vaatii billing.manage-oikeuden.
Oikeus: billing.manage
· Vain HTTP (ei MCP-työkalu)
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
Esikatsele paketin vaihtoa suhteutuksella
billing_preview
Näyttää, mitä tilauksen siirtäminen toiseen pakettiin, tasoon tai jaksoon maksaisi juuri nyt, muuttamatta mitään. Suorita se aina ennen billing_change_plan-kutsua samoilla plan-, events- ja interval-syötteillä. Epäonnistuu, jos työtilalla ei ole tilausta tai kohde vastaa nykyistä hintaa. Palauttaa plan, events, interval, price_id, amount (kokonaisina Yhdysvaltain dollareina listahinta jaksolle), currency, charge_minor (mitä veloitettaisiin nyt), credit_minor (hyvitys käyttämättömästä ajasta) ja result_minor (nettosumma), kaikki valuutan pienimmissä yksiköissä, result_action (charge tai credit, voi olla null), next_billed_at (voi olla null) ja warnings (merkkijonoja, esimerkiksi viime kuun käyttö ylittää uuden tason tai paketin rajat, kuten sivustot tai jäsenet, jotka uusi paketti rikkoisi). Vaatii billing.manage-oikeuden.
Oikeus: billing.manage
curl https://privatusanalytics.com/workspaces/:workspace_id/billing/preview.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/workspaces/:workspace_id/billing/resume.json
Peru ajastettu peruutus tai jatka tauolla ollutta tilausta
billing_resume
Kumoaa ajastetun peruutuksen tai jatkaa keskeytettyä tilausta, jolloin paketti uusiutuu edelleen. Käytä sitä billing_cancel-kutsun jälkeen ja ennen current_period_ends_at-hetkeä. Keskeytetty tilaus jatkuu heti. Epäonnistuu, kun ajastettua peruutusta ei ole eikä tilaus ole keskeytetty. Palauttaa päivitetyn laskutusobjektin. Vaatii billing.manage-oikeuden.
Oikeus: billing.manage
· Vain HTTP (ei MCP-työkalu)
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
Hae paketti, tilaus ja käyttö
billing_get
Palauttaa työtilan paketin ja laskutustilan. Käytä sitä ennen laskutuksen muuttamista ja selvittääksesi, onko tilaus aktiivinen vai peruuntumassa. Kenttiä ovat workspace_id, plan (free, pro, business tai enterprise), plan_events (myyty kuukausittaisten tapahtumien taso), allowance (todella sallitut tapahtumat kuukaudessa, mukaan lukien mahdollinen merkkibonus), billing_interval (month tai year, voi olla null), price (kokonaisina Yhdysvaltain dollareina jaksolle, voi olla null), subscription_status, current_period_ends_at, cancel_at_period_end (true, kun peruutus on ajastettu), canceled_at, auto_upgrade, discount (uusin alennushakemus, voi olla null), discount_percent, billing_emails (taulukko), tax_id, badge (opted_in, verified_at, checked_at ja bonuksen koko) sekä usage (sama objekti, jonka billing_usage palauttaa). Vaatii billing.manage-oikeuden. Laskut ovat billing_invoices_list-kutsussa ja kuukausikohtainen käyttönäkymä on billing_usage.
Oikeus: billing.manage
curl https://privatusanalytics.com/workspaces/:workspace_id/billing.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/workspaces/:workspace_id/billing.json
Päivitä laskutussähköpostit, verotunnus ja automaattinen päivitys
billing_update
Päivittää työtilan laskutusasetukset. Vain lähettämäsi syötteet muuttuvat. billing_emails on taulukko, jossa on enintään 5 lisäosoitetta laskuille ja laskutusilmoituksille, ja se korvaa koko listan. tax_id tallennetaan työtilaan, mutta sitä ei lisätä laskuille, joten se on syötettävä myös kassalla. auto_upgrade on oletuksena false. Kun se on true, kuukauden tapahtumarajan saavuttaminen siirtää työtilan seuraavalle tasolle ja veloittaa erotuksen keräyksen keskeyttämisen sijaan. Sen kytkeminen päälle, kun keräys on jo keskeytetty rajalla, päivittää ja veloittaa heti ja lähettää vahvistussähköpostin, ja jos Paddle hylkää päivityksen, mitään ei tallenneta. Palauttaa laskutusobjektin kuten billing_get. Vaatii billing.manage-oikeuden.
Oikeus: billing.manage
· Vain HTTP (ei MCP-työkalu)
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
Hae tämän kuun käyttö, ennuste ja sivustokohtainen jakauma
billing_usage
Palauttaa työtilan tapahtumakäytön yhdeltä kuukaudelta. Käytä sitä tarkistaaksesi, kuinka lähellä työtila on kuukausittaista kovaa rajaansa. Syötteenä on month (mikä tahansa kuukauden päivä, oletuksena nykyinen kuukausi). Vain sivunäytöt ja omat tapahtumat lasketaan. Kenttiä ovat month, events, bots (bottien kokonaismäärä, ei laskuteta), allowance, percent (0 - 100 ja yli, yksi desimaali), forecast ja forecast_percent (suoraviivainen ennuste kuun loppuun, null menneille kuukausille), days_left, status (ok, warning 80 prosentissa, over 100 prosentissa, paused tai locked), sites (sivustoittain site_id, domain, name, events ja share-prosentti, suurin ensin), history (aiemmat kuukaudet kentillä month ja events), access_locked_at, collection_paused (true, kun uusia tapahtumia hylätään), pause_reason (limit tai staff, voi olla null), collection_paused_at ja resumes_at (seuraavan kuun 1. päivä, kun keräys on keskeytetty rajan vuoksi). Vaatii billing.manage-oikeuden.
Oikeus: billing.manage
curl https://privatusanalytics.com/workspaces/:workspace_id/billing/usage.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/workspaces/:workspace_id/billing/invoices.json
Listaa laskut
billing_invoices_list
Listaa työtilan laskutustapahtumat uusin ensin. Jokaisella kohteella on id (käytä sitä billing_invoices_get-kutsun kanssa), invoice_number (voi olla null), status, amount_minor (kokonaisluku valuutan pienimmissä yksiköissä, joten 900 tarkoittaa 9,00), currency (ISO-koodi, kuten USD) ja billed_at (ISO 8601, voi olla null). Sivutettu page- ja per_page-arvoilla (enintään 100). Se listaa vain tapahtumat. PDF:n saat billing_invoices_get-kutsulla ja kortin päivität billing_payment_method-kutsulla. Vaatii billing.manage-oikeuden.
Oikeus: billing.manage
curl https://privatusanalytics.com/workspaces/:workspace_id/billing/invoices.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/workspaces/:workspace_id/billing/invoices/:id.json
Hae laskun PDF-linkki
billing_invoices_get
Palauttaa linkin yhden laskutetun tapahtuman PDF-laskuun. Hae laskun id billing_invoices_list-kutsusta (id-kenttä, Paddlen tapahtumatunnus). Tuloksessa on kind (invoice) ja url, joka on Paddlen linkki PDF-tiedostoon, joten hae tai jaa se pian kutsun jälkeen. Epäonnistuu, jos id ei kuulu tälle työtilalle tai Paddlella ei ole siitä laskua. Vaatii billing.manage-oikeuden.
Oikeus: billing.manage
curl https://privatusanalytics.com/workspaces/:workspace_id/billing/invoices/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Liikennesäännöt
POST
/sites/:site_id/traffic_rules.json
Lisää liikennesääntö
traffic_rules_create
Lisää mallin yhteen sivuston esto- tai sallintalistoista. list on yksi arvoista hostnames, paths, referrers, countries, ip_ranges, user_agents tai events. pattern käyttää * jokerimerkkinä ja vertailu ei erottele kirjainkokoa, esimerkiksi /admin/*, isäntänimi, viittaajan isäntä kuten spam.example, kaksikirjaiminen maakoodi (tallennetaan isoilla kirjaimilla), selaimen nimi pääversiolla, koska user agent typistetään (esimerkiksi Chrome 120), tai oman tapahtuman nimi. ip_ranges ottaa IPv4- tai IPv6-osoitteen tai CIDR-alueen (203.0.113.0/24), jonka on oltava kelvollinen. Malli voi olla kerran listaa kohti ja sivustolla voi olla enintään 500 sääntöä. Se, estääkö vai sallitaanko lista täsmäävät, riippuu sen tilasta, joka on oletuksena block ja jota muutetaan sites_update-kutsulla. Täsmäävät osumat pudotetaan keräyksessä eikä niitä tallenneta, ja sääntö koskee vain uusia osumia muutaman minuutin sisällä. Vaatii sites.manage-oikeuden. Vaatii Pro-paketin tai sitä ylemmän (muuten 402 plan_limit).
Oikeus: sites.manage
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
Poista liikennesääntö
traffic_rules_delete
Poistaa liikennesäännön, löydettynä id:llä traffic_rules_list-kutsusta. Osumat, joita se pudotti, lasketaan siitä lähtien taas, ja jo pudotetut osumat ovat lopullisesti poissa. Huomaa, että allow-tilaisen listan viimeisen mallin poistaminen saa kyseisen listan lopettamaan suodattamisen. Palauttaa poistetun säännön. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
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
Listaa liikennesäännöt
traffic_rules_list
Listaa sivuston liikennesäännöt, jotka ovat keräyshetkellä sovellettavia esto- tai sallintalistoja ja ratkaisevat, mitkä osumat lasketaan. Jokaisella säännöllä on id (UUID päivitystä ja poistoa varten), list (hostnames, paths, referrers, countries, ip_ranges, user_agents tai events), pattern, label (valinnainen huomautus), mode (block tai allow, koko kyseisen listan tila) ja created_at. Block-tilassa osuma, joka täsmää mihin tahansa listan malliin, pudotetaan, allow-tilassa osuma, joka ei täsmää mihinkään, pudotetaan, ja tyhjä lista ei suodata mitään. Suodata list-arvolla. Listan tilaa ei aseteta täällä, se asetetaan sites_update-kutsulla käyttäen traffic_rule_modes-arvoa. Käytä traffic_rules_test-kutsua esimerkkiosuman tarkistamiseen. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/traffic_rules.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/traffic_rules/test.json
Testaa, laskettaisiinko kutsu sivuston nykyisillä säännöillä
traffic_rules_test
Kuivaharjoitus, joka kertoo, lasketaanko esimerkkiosuma sivuston nykyisillä liikennesäännöillä. Mitään ei tallenneta. Lähetä mitä tahansa seuraavista: url (täysi sivun URL, sen isäntä ja polku tarkistetaan), referrer (URL tai isäntänimi), country (kaksikirjaiminen koodi), ip (tarkistetaan ip_ranges-listaa vasten, ei koskaan tallenneta), user_agent (täysi User-Agent-merkkijono, typistetään selaimeksi ja pääversioksi) ja event (oman tapahtuman nimi). Pois jätettyjä arvoja ei tarkisteta. Tuloksessa on counted (true, jos osuma tallennettaisiin), blocked_by (lista, joka pudotti sen, tai null), mode (block tai allow kyseiselle listalle, tai null) ja values (tarkistetut normalisoidut arvot). Säännöt luetaan live-tilassa, joten uusi sääntö näkyy heti. Vaatii analytics.read-oikeuden. Vaatii Pro-paketin tai sitä ylemmän (muuten 402 plan_limit).
Oikeus: analytics.read
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
Muuta liikennesääntöä
traffic_rules_update
Muuttaa liikennesäännön mallia tai nimikettä, löydettynä id:llä traffic_rules_list-kutsusta. Vain lähettämäsi syötteet muuttuvat. Listaa ei voi muuttaa, poista sääntö ja luo se uudelleen siirtääksesi sen toiselle listalle. Mallin on pysyttävä kelvollisena listalleen (CIDR kentälle ip_ranges) ja yksilöllisenä sen sisällä. Lähetä tyhjä label tyhjentääksesi sen. Koskee vain uusia osumia. Vaatii sites.manage-oikeuden. Vaatii Pro-paketin tai sitä ylemmän (muuten 402 plan_limit).
Oikeus: sites.manage
curl -X PATCH https://privatusanalytics.com/sites/:site_id/traffic_rules/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Live
GET
/sites/:site_id/live.json
Live-kävijät, aktiviteettivirta ja juuri nyt suosittu (viimeiset 30 minuuttia)
live_get
Mitä sivustolla tapahtuu juuri nyt. Palauttaa live_visitors (kävijät viimeisen 5 minuutin aikana), window_minutes (30), sparkline (käynnit minuutissa viimeisen 30 minuutin ajalta, vanhin ensin, kukin {minute, visits}), feed (viimeisin toiminta), top_pages, top_referrers, top_countries (kukin enintään 8 riviä muodossa {value, visits}) ja top_events (enintään 8 muodossa {value, completions}) viimeisen 30 minuutin ajalta. feed-merkinnöillä on occurred_at, kind, name, path, channel, referrer_host, country, device ja browser. Ne ovat anonyymejä, ilman IP-osoitetta, kaupunkia tai kävijän jälkeä. feed näyttää oletuksena kaikki osumat tai vain sivunäytöt tai tapahtumat, limit-arvon verran merkintöjä (oletus 50, enintään puskurin koko 100). Lukuja ei välimuistiteta, eikä niille anneta jaksoa. Anna filters (sama muoto kuin stats_aggregate-kutsussa) rajataksesi jokaisen luvun ja syötteen vastaaviin osumiin. Käytä live_wallboard-kutsua tiiviiseen usean sivuston näkymään ja stats_overview-kutsua kokonaiseen jaksoon.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/live.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/live/wallboard.json
Seinänäytön kortit (live ja tänään) yhdelle tai useammalle sivustolle
live_wallboard
Tiiviit isojen lukujen kortit yhdelle tai useammalle sivustolle, tehty toimiston näytölle. Palauttaa rotate_seconds, generated_at ja sites. Jokaisella sivustokortilla on id (pa_...), name, domain, live_visitors (viimeiset 5 minuuttia), sparkline (minuutti kerrallaan, viimeiset 30 minuuttia), visitors_today, pageviews_today, bounce_rate_today (prosentti, 0 - 100), top_pages, top_countries ja top_referrers (5 riviä kukin). Tänään tarkoittaa sivuston omaa aikavyöhykettä, ja luvut luetaan live-datasta. site_ids listaa mukaan otettavat sivustot (enintään 12, vain sivustot, jotka tunnisteesi voi avata), muuten käytetään polun sivustoa. rotate_seconds rajataan välille 5 - 300 ja se kertoo näytölle vain, kuinka kauan kukin kortti näytetään. Jaettavaa julkista näyttöä varten käytä wallboard_links_create-kutsua. Käytä live_get-kutsua yhden sivuston täyteen live-näkymään.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/live/wallboard.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/wallboard/:token.json
Seinänäyttö seinänäyttötunnisteella (ei kirjautumista)
live_public_wallboard
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/wallboard/:token.json
POST
/sites/:site_id/live/wallboard/links.json
Luo seinänäyttölinkki (vain luku, peruutettavissa)
wallboard_links_create
Luo vain luku -tilaisen wallboard-URL-osoitteen, jonka kuka tahansa sen haltija voi avata kirjautumatta, joten jaa se vain ihmisille, joiden tulee nähdä nämä luvut. Polku ottaa site_id-arvon ja tämä sivusto on aina mukana. site_ids lisää kierrätettäviä sivustoja (pa_...-tunnukset, joihin pääset, yhteensä enintään 12 sivustoa). rotate_seconds on aika, jonka kukin sivusto pysyy näytöllä, 5 - 300 (oletus 20, arvot rajan ulkopuolella rajataan). expires_at on ISO 8601 -päivämäärä ja aika tai pelkkä YYYY-MM-DD-päivämäärä, joka tarkoittaa kyseisen päivän loppua sivuston aikavyöhykkeellä. Wallboard näyttää vain live-luvut ja tämän päivän koosteluvut. Palauttaa linkin url-osoitteineen. Peruuta se wallboard_links_delete-kutsulla.
Oikeus: sites.manage
curl -X POST https://privatusanalytics.com/sites/:site_id/live/wallboard/links.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
DELETE
/sites/:site_id/live/wallboard/links/:id.json
Peruuta seinänäyttölinkki
wallboard_links_delete
Peruuttaa wallboard-linkin, jolloin sitä näyttävät televisiot lakkaavat päivittymästä ja URL-osoite lakkaa toimimasta. Tätä ei voi perua, luo sen sijaan uusi linkki. Jo peruutetun linkin peruuttaminen ei tee mitään. id (shr_...) tulee wallboard_links_list-kutsusta. Palauttaa linkin, jossa revoked_at on asetettu.
Oikeus: sites.manage
curl -X DELETE https://privatusanalytics.com/sites/:site_id/live/wallboard/links/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
GET
/sites/:site_id/live/wallboard/links.json
Listaa sivuston seinänäyttölinkit
wallboard_links_list
Listaa sivuston wallboard-linkit (polku ottaa site_id-arvon) uusin ensin ja peruutetut mukaan lukien. Wallboard-linkki on salainen URL-osoite, joka näyttää live-kävijät ja tämän päivän luvut televisiossa ilman kirjautumista. Jokaisella on id (shr_...), name, url, site_ids (niiden sivustojen pa_...-tunnukset, joiden välillä se kierrättää), rotate_seconds, expires_at, revoked_at (asetettu peruutettaessa) ja created_at. Vain joihinkin sivustoihin rajatut kutsujat näkevät vain linkit, joiden kaikki sivustot ovat heidän omiaan. Itse wallboard-dataan käytä live_wallboard-kutsua. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
curl https://privatusanalytics.com/sites/:site_id/live/wallboard/links.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Lomakkeet
POST
/sites/:site_id/testimonials/forms.json
Luo lomake
testimonial_forms_create
Yksi kutsu sisältää koko lomakkeen: vaiheet, kysymykset, ohitusehdot, suostumusteksti ja kielen. Pois jätetty alkaa järkevästä oletuksesta lomakkeen kielellä, ja slug tulee nimestä. Linkki on https://privatus.page/f/<slug>. Matalan arvosanan ohjaus ja oma CSS vaativat Business-paketin (402 plan_limit ilman). Video- ja äänivastaukset tarjotaan antajalle Pro-paketissa ja ylöspäin.
Oikeus: content.write
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
Poista lomake pysyvästi
testimonial_forms_delete
Poistaa lomakkeen, sen lähetystietueet, palkinnon ja yksityisen palautteen. Sen keräämät suositukset säilytetään. Sitä ei voi perua, joten henkilö tekee sen sivulla. API ottaa kentän confirm (lomakkeen nimi tai tunniste).
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Siirrä lomake roskakoriin
testimonial_forms_trash
Sen linkki vastaa, että lomake on suljettu, kunnes se palautetaan. Roskakori tyhjennetään 30 päivän kuluttua. MCP:n kautta työkalu ei muuta mitään ja vastaa sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Kopioi lomake, tarvittaessa toiselle kielelle
testimonial_forms_duplicate
Kopioi jokaisen asetuksen paitsi slugin, tilastot ja palkinnon.
Oikeus: content.write
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
Listaa sivuston lomakkeet
testimonial_forms_list
Roskakorissa olevat lomakkeet listataan arvolla trashed true ja jätetään muuten pois. Jokaisella lomakkeella on asetukset, palkinto ja lähetysten määrä.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/forms.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/testimonials/forms/:id/qr.json
Hae lomakkeen QR-koodi SVG- tai PNG-muodossa
testimonial_forms_qr
Koodi sisältää lomakkeen linkin ja ?src=qr, joten skannaukset lasketaan omaksi kanavakseen. Muutettu slug pitää painetun koodin toimivana.
Oikeus: analytics.read
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
Palauta lomake roskakorista. Sen linkki toimii taas
testimonial_forms_restore
Ottaa lomakkeen pois roskakorista sellaisena kuin se oli kysymyksineen, lähetyksineen ja yksityisine palautteineen. Sen linkki (/f/<slug>) ja upotukset ottavat taas vastauksia. Palvelin vastaa 422:lla ja koodilla not_in_trash lomakkeelle, joka ei ole roskakorissa.
Oikeus: content.write
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.json
Hae yksi lomake kaikkine vaiheineen, kysymyksineen, sääntöineen ja asetuksineen
testimonial_forms_get
Palauttaa koko lomakkeen sellaisena kuin testimonial_forms_create ja testimonial_forms_update sen ottavat, slugineen, linkkeineen, palkintoineen ja lähetysmäärineen. Roskakorissa olevaa lomaketta ei löydy täältä: palauta se ensin.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/forms/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/testimonials/forms/:id.json
Muuta lomaketta. Vain lähetetyt syötteet muuttuvat
testimonial_forms_update
Vaiheen, kysymyksen tai suostumustekstin muutos nostaa lomakkeen versiota, jonka jokainen suostumustietue tallentaa. Muutettu slug jättää vanhan linkin uudelleenohjaamaan. Lähetä kysymykset koko listana.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/forms/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Mainokset
POST
/sites/:site_id/experiments/ads/:ad_placement_id/creatives.json
Lisää mainos mainospaikalle
ad_creatives_create
Lisää mainospaikan muotoisen kuvan (vähintään sen kokoinen, kaksinkertainen koko näyttää terävimmältä) ja osoitteen, johon klikkaus johtaa. Lähetä kuva multipart-tiedostona tai anna image_url, jolloin se ladataan. Se käsitellään taustalla, joten kysele ad_creatives_get, kunnes state on ready. Aikataulu, laitteet ja polut ovat Pro ja ylemmät. Vaatii content.write.
Oikeus: content.write
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
Poista mainos ja sen kuva
ad_creatives_delete
Poistaa pysyvästi mainoksen ja sen kuvan. Mainosta, jota koe vertailee, ei voi poistaa: poista se kierrosta. MCP-työkalu ei suorita tätä vaan vastaa human_only-vastauksella ja sivulla, jolla ihminen poistaa sen. Vaatii content.write.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Hae yksi mainos tiloineen
ad_creatives_get
Mainos on processing, kunnes sen kuva on tehty, sitten ready (tai failed, jolloin syy on kentässä error). Vaatii analytics.read.
Oikeus: analytics.read
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
Muuta mainosta
ad_creatives_update
Muuttaa linkin, painon, aikataulun tai kohdennuksen, poistaa sen kierrosta (active false) tai vaihtaa kuvan. Vain annetut syötteet muuttuvat. Uusi kuva korvaa vanhan, kun se on valmis. Vaatii content.write.
Oikeus: content.write
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 '{…}'
Mainospaikat
POST
/sites/:site_id/experiments/ads.json
Luo mainospaikka
ad_placements_create
Luo yhden koon paikan sivustolle. Anna size (yleinen koko, kuten medium_rectangle tai leaderboard) tai width ja height pikseleinä. key on nimi, jolla sivuston tunniste viittaa paikkaan, ja se muodostetaan nimestä, jos se jätetään pois. Lisää sitten mainoksia komennolla ad_creatives_create ja laita ad_placements_embed-komennon tunniste sivustolle. Vaatii content.write.
Oikeus: content.write
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
Poista mainospaikka mainoksineen
ad_placements_delete
Poistaa pysyvästi mainospaikan mainoksineen ja kuvineen, sen mainoskokeet tuloksineen ja sponsorilinkit. Sivuston tunniste ei sen jälkeen piirrä mitään. MCP-työkalu ei suorita tätä vaan vastaa human_only-vastauksella ja sivulla, jolla ihminen poistaa sen. Vaatii content.write.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Hae tunniste, joka näyttää mainospaikan sivustolla
ad_placements_embed
Lataajan skripti (kerran sivulla) ja tämän mainospaikan paikka liitettävänä html:nä. Paikka säilyttää kokonsa ennen lataajan ajoa. Vaatii analytics.read.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/experiments/ads/:id/embed.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/experiments/ads.json
Listaa sivuston mainospaikat ja niiden viimeiset 30 päivää
ad_placements_list
Jokainen mainospaikka avaimineen, kokoineen, mainosten määrineen ja tilastoineen (näyttökerrat, näkyvät näyttökerrat, klikkaukset ja ctr eli klikkausprosentti näkyvää näyttökertaa kohti) viimeisen 30 päivän ajalta. Vaatii analytics.read.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/experiments/ads.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/experiments/ads/:id.json
Hae mainospaikka ja jokaisen mainoksen luvut
ad_placements_get
Mainospaikka, sen mainokset ja niiden tilastot jaksolta (7d, 30d tai 90d) sekä mainospaikan luvut päivittäin. humans_only säilyttää sen, minkä bottipisteet luokittelevat todennäköisesti ihmiseksi (Pro ja ylemmät). Vaatii analytics.read.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/experiments/ads/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/experiments/ads/:id.json
Muuta mainospaikkaa
ad_placements_update
Muuttaa nimen, avaimen, koon tai tekstin. Vain annetut syötteet muuttuvat. Uusi avain vaatii uuden tunnisteen sivustolle. Vaatii content.write.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/experiments/ads/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Mobiilisovellus
GET
/workspaces/:workspace_id/app.json
Hae tiedot, joita mobiilisovellus tarvitsee työtilan avaamiseen
mobile_bootstraps_get
Palauttaa yhdelle työtilalle (polku ottaa workspace_id:n) kutsujan roolin ja oikeudet siellä, features (mitkä rajatut raportit paketti sisältää: traffic_quality, bot_detection, external_experiments, campaign_costs, status_pages, traffic_rules, experiment_advanced (kokeen lisäasetukset) ja survey_ai_themes (kyselyn kirjoitettujen vastausten teemat) arvoina true tai false, ja retention_months kuukausien määränä tai null, jos rajaa ei ole), sites_count (sivustot, jotka kutsuja voi avata) ja min_app_version (vanhin mobiilisovelluksen versio, jota API vielä palvelee). Mobiilisovellus lukee sen kerran avatessaan työtilan, jotta se voi näyttää raportin, jota paketti ei sisällä, merkittynä ei sisältyväksi sen sijaan, että pyytäisi sitä. Vaatii analytics.read.
Oikeus: analytics.read
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/workspaces/:workspace_id/app.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
DELETE
/account/device.json
Lopeta push-ilmoitukset mobiilisovellukseen
mobile_devices_delete
Poistaa kutsuvan mobiilisovelluksen kirjautumisen push-rekisteröinnin, jolloin laite ei saa enää push-ilmoituksia. Kirjautuminen itse säilyy, ja sovellus voi rekisteröityä uudelleen. Uloskirjautuminen (POST /oauth/revoke päivitystunnuksella) poistaa sen myös. Vain mobiilisovelluksen tunnus voi kutsua tätä.
Oikeus: member
· Vain HTTP (ei MCP-työkalu)
curl -X DELETE https://privatusanalytics.com/account/device.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
GET
/account/device.json
Hae mobiilisovelluksen push-rekisteröinti
mobile_devices_get
Palauttaa kutsuvan mobiilisovelluksen kirjautumisen laitteen: registered (false, kunnes sovellus on rekisteröinyt push-tunnuksen), platform, locale, timezone, app_version, kinds (kaikki push-ilmoitusten lajit), muted_kinds ja muted_site_ids (mitä henkilö on kytkenyt pois). Vain mobiilisovelluksen tunnus voi kutsua tätä.
Oikeus: member
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/account/device.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/account/device.json
Rekisteröi mobiilisovellus push-ilmoituksille
mobile_devices_update
Rekisteröi kutsuvan mobiilisovelluksen kirjautumisen laitteen push-ilmoituksille tai muuttaa, mitä se saa. Vain lähettämäsi syötteet muuttuvat. Ensimmäinen kutsu vaatii platform- ja push_token-arvot. Laite saa push-ilmoituksen kohteista uptime (tarkistus meni alas tai palasi), alert (hälytys laukesi tai purkautui), site_audit (sivustotarkastus valmistui), experiment (kokeella on tulos tai se päättyi) ja usage (kuukausikiintiö on lähes tai kokonaan käytetty), kaikille sivustoille, jotka sen jäsen voi avata, kaikissa paketeissa. muted_kinds ja muted_site_ids kytkevät lajeja ja sivustoja pois, ja kumpikin korvaa koko listansa. Push-tunnuksen rekisteröinti, jonka jokin toinen sovelluksen kirjautuminen omistaa, siirtää sen tälle kirjautumiselle. Vain mobiilisovelluksen tunnus voi kutsua tätä. Se on yksi kahdesta kirjoitustoiminnosta, joita tällainen tunnus saa tehdä.
Oikeus: member
· Vain HTTP (ei MCP-työkalu)
curl -X PATCH https://privatusanalytics.com/account/device.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Muistiinpanot
POST
/sites/:site_id/notes.json
Lisää muistiinpano sivustolle (käytä lähdettä "deploy" julkaisuwebhookeille)
notes_create
Lisää huomautuksen yhden sivuston kaavioihin, esimerkiksi julkaisun, kampanjan tai version. Käytä sen sijaan workspace_notes_create-kutsua huomautukseen, joka näkyy jokaisella sivustolla. date on oletuksena tämä päivä sivuston aikavyöhykkeellä, ja end_date merkitsee jakson (YYYY-MM-DD). title näytetään kaaviossa, body on pelkkää tekstiä ja url voi osoittaa PR:ään tai muutoslokiin. color on yksi arvoista neutral, brand, blue, amber, red tai violet, oletus neutral. source on oletuksena manual. Käyttöönottointegraatiot lähettävät source-arvon deploy, jolloin title on oletuksena version (julkaisuversio tai commit) pohjalta muodostettu teksti ja color on oletuksena blue. Vaatii content.write-oikeuden. Palauttaa luodun huomautuksen (kentät ovat notes_list-kutsussa).
Oikeus: content.write
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
Poista muistiinpano
notes_delete
Poistaa sivuston huomautuksen pysyvästi, ja se katoaa kaavioista eikä sitä voi palauttaa. Huomautuksen on kuuluttava tälle sivustolle, koko työtilan huomautukset poistetaan workspace_notes_delete-kutsulla. Ota id (note_...) notes_list-kutsusta. Vaatii content.write-oikeuden. Palauttaa poistetun huomautuksen.
Oikeus: content.write
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
Listaa sivuston muistiinpanot (myös koko työtilan muistiinpanot)
notes_list
Listaa sivuston kaavioissa näytettävät huomautukset uusin päivämäärä ensin ja sivutettuna. Palauttaa sivuston omat huomautukset sekä koko työtilan huomautukset, jotka koskevat jokaista sivustoa. Suodata arvoilla from ja to (YYYY-MM-DD, huomautus täsmää, kun sen päivämäärä osuu välille), source (manual, deploy, system, import tai incident) ja query (kirjainkoosta riippumaton haku kentistä title, body ja url). Käytä workspace_notes_list-kutsua työtilan näkymään kaikkien sivustojen yli. Jokaisella huomautuksella on id (note_...), site_id (sivuston julkinen tunnus pa_..., null koko työtilan huomautukselle), date, end_date (null yhdelle päivälle), title, body (pelkkä teksti, voi olla null), url (voi olla null), color (neutral, brand, blue, amber, red tai violet), source ja created_at. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/notes.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/notes/:id.json
Hae muistiinpano
notes_get
Palauttaa yhden huomautuksen id:n perusteella (note_..., notes_list-kutsusta) sivustolle, mukaan lukien koko työtilan huomautukset, jotka koskevat sivustoa. Huomautus on päivämäärällinen merkintä, joka näytetään kaavioissa, esimerkiksi julkaisu, kampanja tai käyttöönotto. Kenttiä ovat id, site_id (null, kun koko työtilan), date ja end_date (YYYY-MM-DD, end_date null yhdelle päivälle), title, body (voi olla null), url (voi olla null), color (neutral, brand, blue, amber, red tai violet), source (manual, deploy, system, import tai incident) ja created_at. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/notes/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/notes/:id.json
Muokkaa muistiinpanoa
notes_update
Muokkaa sivuston huomautusta muuttaen vain lähettämäsi kentät (date, end_date, title, body, url, color). source-arvoa ei voi muuttaa. Tyhjän url-arvon lähettäminen poistaa linkin, ja date-arvo null ohitetaan. Huomautuksen on kuuluttava tälle sivustolle, koko työtilan huomautuksia muokataan workspace_notes_update-kutsulla. Ota id (note_...) notes_list-kutsusta. Vaatii content.write-oikeuden. Palauttaa päivitetyn huomautuksen.
Oikeus: content.write
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
Lisää koko työtilan muistiinpano (näytetään jokaisella sivustolla)
workspace_notes_create
Lisää koko työtilan huomautuksen, joka näkyy työtilan jokaisen sivuston kaavioissa, esimerkiksi yrityksen laajuisen julkaisun tai katkoksen. Se luodaan ilman sivustoa (site_id on null). Käytä notes_create-kutsua yhden sivuston huomautukseen. date on oletuksena tämä päivä työtilan aikavyöhykkeellä, end_date merkitsee jakson (YYYY-MM-DD), color on yksi arvoista neutral, brand, blue, amber, red tai violet. Vaatii content.write-oikeuden, ja vain joihinkin sivustoihin rajattu kutsuja ei voi luoda koko työtilan huomautuksia. Palauttaa luodun huomautuksen.
Oikeus: content.write
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
Poista työtilan muistiinpano
workspace_notes_delete
Poistaa koko työtilan huomautuksen pysyvästi, jolloin se katoaa jokaisen sivuston kaavioista, eikä sitä voi palauttaa. Täällä voi poistaa vain huomautuksia, joilla ei ole sivustoa, käytä notes_delete-kutsua sivuston huomautukseen. Ota id (note_...) workspace_notes_list-kutsusta. Vaatii content.write-oikeuden, ja vain joihinkin sivustoihin rajattu kutsuja ei voi poistaa koko työtilan huomautuksia. Palauttaa poistetun huomautuksen.
Oikeus: content.write
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
Listaa työtilan muistiinpanot
workspace_notes_list
Listaa työtilan huomautukset uusin päivämäärä ensin ja sivutettuna. Palauttaa koko työtilan huomautukset (jotka näkyvät jokaisella sivustolla) sekä jokaisen sivuston huomautukset, joihin kutsujalla on pääsy, joten tarkista site_id jokaisesta kohteesta (null tarkoittaa koko työtilaa). Käytä notes_list-kutsua yhdelle sivustolle. Suodata arvoilla from ja to (YYYY-MM-DD), source (manual, deploy, system, import tai incident) ja query (hakee kentistä title, body ja url). Kenttiä ovat id (note_...), site_id, date, end_date, title, body, url, color (neutral, brand, blue, amber, red tai violet), source ja created_at. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/workspaces/:workspace_id/notes.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/workspaces/:workspace_id/notes/:id.json
Muokkaa työtilan muistiinpanoa
workspace_notes_update
Muokkaa koko työtilan huomautusta muuttaen vain lähettämäsi kentät (date, end_date, title, body, url, color). Täällä voi muokata vain huomautuksia, joilla ei ole sivustoa, käytä notes_update-kutsua sivuston huomautukseen. Ota id (note_...) workspace_notes_list-kutsusta. Vaatii content.write-oikeuden, ja vain joihinkin sivustoihin rajattu kutsuja ei voi muokata koko työtilan huomautuksia. Palauttaa päivitetyn huomautuksen.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/workspaces/:workspace_id/notes/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Ohje ja palaute
POST
/help.json
Lähetä kysymys tai palaute Privatus Analytics -tiimille
support_message_send
Viesti lähetetään tiimille sähköpostilla, ja mukaan liitetään tilisi, työtilasi ja tilauksesi tiedot. Vastaus ja kuittaus lähetetään tilisi sähköpostiosoitteeseen. Enintään 10 viestiä päivässä.
Oikeus: member
curl -X POST https://privatusanalytics.com/help.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Paketit
GET
/plans.json
Listaa paketit, hinnat ja rajat
plans_list
Listaa julkiset paketit (free, pro, business ja enterprise) rajoineen ja hintatasoineen, jotta voit valita kelvolliset arvot kutsuille billing_checkout, billing_preview ja billing_change_plan. Jokaisella paketilla on name, events (mukaan sisältyvät tapahtumat kuukaudessa, null porrastetuille tai räätälöidyille paketeille), badge_bonus (merkistä saatavat lisätapahtumat kuukaudessa, vain Free, muuten null), limits (objekti paketin rajoista, kuten sivustot, jäsenpaikat, historian säilytys kuukausina, tavoitteet sivustoa kohti, tekoälykysymykset ja API-pyynnöt tunnissa), tiers (kukin kuukausittaisilla tapahtumilla sekä kuukausi- ja vuosihinnalla kokonaisina Yhdysvaltain dollareina, arvonlisävero tai myyntivero mukaan lukien) ja contact_sales (true räätälöidyille paketeille). meta-objekti lisää currency, huomautuksen vuosihinnoittelusta, counted (mikä lasketaan laskutettavaksi tapahtumaksi) ja not_counted. Yhden työtilan omaan pakettiin käytä billing_get-kutsua. Julkinen, ei vaadi tunnistautumista.
Oikeus: public
curl https://privatusanalytics.com/plans.json
Palkinnot
POST
/sites/:site_id/testimonials/settings/rewards/:id/copy.json
Kopioi lomakkeen palkinto saman sivuston muille lomakkeille
testimonial_rewards_copy
Kopioi tämän lomakkeen palkinnon otsikon, tekstin, koodin ja päällä tai pois -tilan jokaiselle kentän form_ids lomakkeelle (1-100 saman sivuston lomaketta, jotka eivät ole roskakorissa). Kohdelomakkeen jo omistama palkinto korvataan. Palvelin vastaa 422:lla ja koodilla unknown_ids, kun tunniste ei ole sivuston lomake, eikä silloin kopioida mitään.
Oikeus: sites.manage
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
Listaa sivuston jokaisen lomakkeen palkinto
testimonial_rewards_list
Yksi rivi lomaketta kohden. Lomakkeella, jolle ei ole asetettu palkintoa, on enabled false.
Oikeus: analytics.read
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
Aseta palkinto, jonka lomake näyttää kiitosvaiheessaan
testimonial_rewards_update
Tunniste on lomakkeen tunniste. Koodi on teksti, jonka annat. Privatus Analytics ei luo, tarkista tai vanhenna sitä.
Oikeus: sites.manage
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 '{…}'
Poistopyynnöt
POST
/sites/:site_id/testimonials/removal_requests/:id/dismiss.json
Hylkää poistopyyntö
testimonial_removal_requests_dismiss
Sulkee pyynnön huomautuksella ja jättää suosituksen näkyviin. Mitään ei poisteta eikä pyytäneelle henkilölle lähetetä sähköpostia. Huomautus on pakollinen. Jo päätetty pyyntö vastaa 422.
Oikeus: content.write
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
Listaa sivuston poistopyynnöt
testimonial_removal_requests_list
Avoimet pyynnöt, ellei toista tilaa pyydetä. Antajan kirjoittama sähköposti palautetaan vain kutsujalle, joka saa muuttaa sisältöä.
Oikeus: analytics.read
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
Päätä poistopyynnöstä
testimonial_removal_requests_resolve
trash siirtää suosituksen roskakoriin, mikä poistaa sen heti jokaiselta widgetiltä, seinältä ja julkiselta sivulta ja voidaan perua 30 päivän ajan. dismiss jättää sen näkyviin ja vaatii huomautuksen.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Hae yksi poistopyyntö
testimonial_removal_requests_get
Yksi pyyntö suosituksineen, jota se koskee, henkilön jättämä huomautus, vastaako hänen kirjoittamansa sähköposti suosituksen sähköpostia, kuinka monta kertaa hän pyysi ja päätös, kun sellainen on. Itse sähköposti palautetaan vain kutsujalle, jolla on content.write.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/removal_requests/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Roolit
POST
/workspaces/:workspace_id/roles.json
Luo oma rooli
roles_create
Luo mukautetun roolin, nimetyn oikeuksien joukon, jonka voit antaa jäsenille kutsuilla invitations_create tai members_update roolilla custom ja roolin id:llä custom_role_id-arvona. Se vaatii Business-paketin ja members.manage-oikeuden. permissions-arvon on listattava vähintään yksi nimi sallituista arvoista (analytics.read, analytics.export, content.write, sites.manage, uptime.manage, members.manage, tokens.manage, billing.manage, workspace.manage), etkä voi sisällyttää oikeutta, jota sinulla ei itselläsi ole. Palauttaa roolin (kentät ovat roles_list-kutsussa).
Oikeus: members.manage
· Vain HTTP (ei MCP-työkalu)
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
Poista oma rooli (ei saa olla käytössä)
roles_delete
Poistaa mukautetun roolin. Tätä ei voi perua, ja se epäonnistuu niin kauan kuin jokin jäsen tai odottava kutsu käyttää roolia, joten siirrä ensin kyseiset henkilöt toiseen rooliin members_update-kutsulla (löydät heidät members_list-kutsulla). Sisäänrakennettuja rooleja ei voi poistaa. Ota id (uuid) roles_list-kutsusta. Vaatii members.manage-oikeuden. Palauttaa poistetun roolin.
Oikeus: members.manage
· Vain HTTP (ei MCP-työkalu)
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
Listaa omat roolit
roles_list
Listaa työtilan mukautetut roolit nimen mukaan järjestettyinä. Mukautetut roolit ovat Business-paketin ominaisuus, joka niputtaa oikeudet oman nimesi alle, eikä sisäänrakennettuja rooleja (owner, admin, editor, analyst, viewer, billing) listata täällä. Jokaisella roolilla on id (uuid, jota käytetään custom_role_id-arvona kutsuissa invitations_create ja members_update), name, permissions (nimet kuten analytics.read, content.write, members.manage), members (sen haltijoiden määrä) ja created_at. Vain joihinkin sivustoihin rajatut kutsujat näkevät vain ulottuvillaan olevat roolit.
Oikeus: member
curl https://privatusanalytics.com/workspaces/:workspace_id/roles.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/workspaces/:workspace_id/roles/:id.json
Päivitä oma rooli
roles_update
Nimeää mukautetun roolin uudelleen ja/tai korvaa sen koko oikeuslistan. Vain lähettämäsi syötteet muuttuvat, ja permissions korvaa olemassa olevan listan sen sijaan, että lisäisi siihen. Muutos koskee heti jokaista jäsentä ja odottavaa kutsua, joilla on rooli. Voit muokata vain roolia, jonka oikeudet sinulla on kokonaan, ja vain joihinkin sivustoihin rajatulla kutsujalla on oltava ulottuvuus sen haltijoiden jokaiselle sivustolle. Vaatii members.manage-oikeuden. Ota id (uuid) roles_list-kutsusta. Palauttaa päivitetyn roolin.
Oikeus: members.manage
· Vain HTTP (ei MCP-työkalu)
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
Provisioi käyttäjä
scim_users_create
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/scim/v2/Users.json \
-H "Content-Type: application/json" -d '{…}'
DELETE
/scim/v2/Users/:id.json
Poista käyttäjän provisiointi
scim_users_delete
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X DELETE https://privatusanalytics.com/scim/v2/Users/:id.json \
-H "Content-Type: application/json" -d '{…}'
GET
/scim/v2/Users.json
Listaa provisioidut käyttäjät
scim_users_list
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/scim/v2/Users.json
GET
/scim/v2/Users/:id.json
Hae provisioitu käyttäjä
scim_users_get
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/scim/v2/Users/:id.json
PATCH
/scim/v2/Users/:id.json
Päivitä käyttäjä (PATCH active, name)
scim_users_update
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
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
Ota käyttöön testattu SSO-määritys
sso_activate
Kytkee SSO:n päälle työtilalle. Määrityksen tilan on jo oltava tested, mikä tapahtuu onnistuneen kokeilukirjautumisen jälkeen (aloitetaan sovelluksen työtilan SSO-asetussivulta, se vaatii selainkirjautumisen eikä sitä voi suorittaa täältä), tai oltava jo active. Vain Business-paketti. Aktivoinnin jälkeen jäsenet voivat kirjautua SSO:lla, ja enforced-arvon asettaminen sso_update-kutsulla vaatii sitten SSO:n jokaiseen kirjautumiseen. Se epäonnistuu, kun määritystä ei ole testattu tai paketissa ei ole SSO:ta. Vaatii workspace.manage-oikeuden. Palauttaa määrityksen tilalla active (katso sso_get).
Oikeus: workspace.manage
· Vain HTTP (ei MCP-työkalu)
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
Kytke SSO pois päältä (takaisin luonnokseen)
sso_deactivate
Kytkee SSO:n pois palauttamalla määrityksen tilaan draft ja tyhjentämällä enforced-arvon, jolloin jäsenet palaavat työtilan muihin kirjautumistapoihin. Tunnistustarjoajan tiedot säilyvät. Uudelleenaktivointi vaatii uuden kokeilukirjautumisen ja sso_activate-kutsun. Varmista ensin, että jäsenillä on toinen tapa kirjautua. Tämä toimii missä tahansa paketissa. Vaatii workspace.manage-oikeuden. Palauttaa määrityksen tilalla draft (katso sso_get).
Oikeus: workspace.manage
· Vain HTTP (ei MCP-työkalu)
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
Luo uusi SCIM-tunniste (näytetään vain kerran)
sso_scim_token
Oikeus: workspace.manage
· Vain HTTP (ei MCP-työkalu)
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
Hae SSO-asetukset
sso_get
Palauttaa työtilan kertakirjautumisen (SSO) määrityksen tai tyhjän luonnoksen, kun sellaista ei ole. Kenttiä ovat protocol (saml tai oidc), status (draft, testing, tested tai active), enforced (jäsenten on kirjauduttava SSO:n kautta), domains (sähköpostiverkkotunnukset, jotka käyttävät tätä SSO:ta), idp_sso_url ja idp_entity_id SAML:lle, oidc_issuer ja oidc_client_id OIDC:lle, default_role ja jit_provisioning (luo jäsenet ensimmäisellä SSO-kirjautumisella) sekä scim_enabled. Salaisuuksia ei koskaan palauteta, vain totuusarvot idp_cert_present ja oidc_client_secret_present. SSO on Business-paketin ominaisuus. Vaatii workspace.manage-oikeuden.
Oikeus: workspace.manage
curl https://privatusanalytics.com/workspaces/:workspace_id/sso.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/workspaces/:workspace_id/sso.json
Luo tai päivitä SSO-asetukset
sso_update
Luo tai muokkaa työtilan SSO-asetuksia. Vain Business-paketti. Vain lähettämäsi syötteet muuttuvat. SAML:lle lähetä protocol saml arvoilla idp_sso_url, idp_entity_id ja idp_cert (PEM-teksti). OIDC:lle lähetä protocol oidc arvoilla oidc_issuer, oidc_client_id ja oidc_client_secret, joka on vain kirjoitettava, ja tyhjä arvo säilyttää olemassa olevan salaisuuden. domains listaa sähköpostiverkkotunnukset, jotka käyttävät tätä SSO:ta. default_role on rooli, joka annetaan ensimmäisellä kirjautumisella tai SCIM:llä luoduille jäsenille (ei owner tai custom), ja voit asettaa vain roolin, jonka voisit itse myöntää. Minkä tahansa tunnistustarjoajan tiedon muuttaminen palauttaa aktiivisen tai testatun määrityksen tilaan draft ja kytkee enforced-arvon pois, joten se on testattava uudelleen, ennen kuin sso_activate toimii. enforced true hyväksytään vain, kun status on active. Vaatii workspace.manage-oikeuden. Palauttaa määrityksen (katso sso_get).
Oikeus: workspace.manage
· Vain HTTP (ei MCP-työkalu)
curl -X PATCH https://privatusanalytics.com/workspaces/:workspace_id/sso.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Segmentit
POST
/sites/:site_id/segments.json
Tallenna suodattimet segmenttinä
segments_create
Tallentaa suodatinjoukon nimettynä segmenttinä, jota voi käyttää uudelleen missä tahansa tilastotyökalussa segment_id-arvon kautta. Anna name ja filters (kaikkien ehtojen on täsmättävä, ja {any: [...]}-ryhmä täsmää, kun yksi useasta täsmää, katso dimensioiden nimet ja operaattorit filters-syötteestä). Suodattimet tarkistetaan, joten tuntematon dimensio tai virheellinen arvo palauttaa 422-virheen, jossa on viesti riviä kohti. Käytä ensin segments_preview-kutsua tarkistaaksesi, mitä suodatinjoukko täsmää. shared on oletuksena true ja tekee segmentin näkyväksi kaikille, joilla on pääsy sivustoon, false pitää sen yksityisenä sinulle. Palauttaa segmentin kentillä id (seg_...), site_id, name, description, filters, summary (selkokielinen kuvaus), shared, mine ja aikaleimat. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Poista segmentti
segments_delete
Poistaa tallennetun segmentin pysyvästi. Sitä käyttävät koontinäkymät ja linkit palaavat koko liikenteeseen. Analytiikkadataan ei kosketa eikä kumoamista ole. Palauttaa poistetun segmentin. Tunnukset (seg_...) tulevat segments_list-kutsusta. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Listaa sivustolla käytettävissäsi olevat segmentit
segments_list
Listaa sivuston tallennetut segmentit nimen mukaan järjestettyinä: jaetut sekä omat yksityiset segmenttisi. Jokaisella segmentillä on id (seg_...), site_id, name, description, filters, summary, shared, mine ja aikaleimat. Anna id segment_id-arvona mille tahansa tilastotyökalulle (stats_aggregate, stats_breakdown, funnels_get ja muut) soveltaaksesi segmentin suodattimia. Sivutettu tavallisilla sivutusparametreilla. Käytä segments_create-kutsua lisätäksesi uuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/segments.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/segments/preview.json
Kuvaa suodattimet selkokielellä ja laske niihin viimeisten 30 päivän aikana osuneet kävijät
segments_preview
Tarkistaa suodatinjoukon tallentamatta mitään. Palauttaa summary (suodattimet selkokielellä), visitors (kuinka monta kävijää täsmäsi viimeisen 30 päivän aikana, null kun suodattimet ovat virheellisiä), period (aina 30d) ja filters (puhdistettu, kanoninen muoto, joka tallennettaisiin). Suodattimet käyttävät samaa muotoa kuin segments_create-kutsussa, mukaan lukien {any: [...]}-ryhmät ja valinnaiset kirjoitetut nimet maille, kanaville ja tavoitteille, jotka muunnetaan koodeiksi ja tunnuksiksi. Virheelliset suodattimet palauttavat 422-virheen, joka nimeää rivin. Käytä sitä kokeillaksesi suodattimia ennen segments_create-kutsua ja stats_aggregate-kutsua suodattimilla lukuihin toiselta jaksolta.
Oikeus: analytics.read
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
Hae segmentti
segments_get
Palauttaa yhden tallennetun segmentin: id (seg_...), site_id, name, description, filters (tallennetut ehdot), summary (selkokielinen kuvaus, kuten Visitors from the United States on mobile), shared (näkyvissä kaikille, joilla on pääsy sivustoon), mine (true, kun olet luonut sen) ja aikaleimat. Voit lukea jaetut segmentit ja omat yksityiset segmenttisi. Tunnukset tulevat segments_list-kutsusta. Jos haluat laskea, kuinka monta kävijää suodatinjoukko täsmää, käytä segments_preview-kutsua.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/segments/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/segments/:id.json
Nimeä segmentti uudelleen tai muuta sen suodattimia tai jakamista
segments_update
Nimeää segmentin uudelleen, korvaa sen suodattimet tai muuttaa, ketkä voivat nähdä sen. Vain lähettämäsi syötteet muuttuvat. filters-arvon lähettäminen korvaa kaikki olemassa olevat suodattimet samassa muodossa ja samoilla tarkistuksilla kuin segments_create-kutsussa. shared false tekee siitä yksityisen sen luojalle. description voidaan tyhjentää lähettämällä se tyhjänä. Kaikki, mikä käyttää segmenttiä, kuten tilastokutsut sen segment_id-arvolla, muuttuu heti. Palauttaa segmentin. Tunnukset tulevat segments_list-kutsusta. Vaatii content.write-oikeuden.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/segments/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Seuranta
POST
/sites/:site_id/tracking/ingest_key.json
Luo tai vaihda indeksoijalokien avain (näytetään vain kerran)
tracking_ingest_key_rotate
Luo sivustolle uuden salaisen indeksoijalokien avaimen (alkaa pik_) ja korvaa mahdollisen olemassa olevan avaimen. Avain todentaa palvelimen käyttölokien lähetykset tekoälyindeksoijien raporttia varten (POST /api/logs). Käytä sitä sekä ensimmäisen avaimen luomiseen että kierrätykseen. Uusi avain toimii heti ja vanha lakkaa toimimasta heti, joten ota uusi avain käyttöön välittömästi välttääksesi 401-virheet lokien lähetyksissä. Koko avain palautetaan vain tässä vastauksessa, key-kentässä, joten tallenna se salaisuuksien säilytyspaikkaan. Jälkeenpäin säilytetään ja näytetään vain lyhyt etuliite (tässä prefix, sivustolla ingest_key_prefix). Palauttaa site_id, key ja prefix. Vaatii sites.manage-oikeuden. Käytä tracking_ingest_key_revoke-kutsua poistaaksesi avaimen korvaamatta sitä.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Peruuta indeksoijalokien avain
tracking_ingest_key_revoke
Poistaa sivuston indeksoijalokien avaimen. Siitä lähtien jokainen kyseisellä avaimella tehty lokien lähetys hylätään 401-virheellä, kunnes luot uuden tracking_ingest_key_rotate-kutsulla. Selainseurantaan julkisella sivuston tunnuksella ei vaikuteta. Avainta ei voi palauttaa. Vaatii sites.manage-oikeuden. Palauttaa sivustoobjektin (katso sites_get), jossa ingest_key_prefix on nyt null.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Tarkista, että seurantakoodi on asennettu sivustolle (script-tunniste, site id, CSP ja referrer-käytäntö)
tracking_verify
Hakee sivuston sivun ja tarkistaa, että Privatus Analytics -seurantaskripti on asennettu oikein, ja merkitsee sivuston vahvistetuksi, kun skripti tämän sivuston tunnuksella löytyy. Oletuksena se pyytää etusivua (https://domain/) ja url voi nimetä toisen sivun, mutta vain sivuston omalla verkkotunnuksella, lisäverkkotunnuksilla tai niiden aliverkkotunnuksilla. Tulos (data-kentän alla) sisältää url, status (HTTP-tila), script_found, site_ids (jokainen sivulta löytynyt data-site-tunnus), installed (true, kun tämän sivuston tunnus on niiden joukossa), csp ja csp_ok (sallivatko sivun Content-Security-Policy-säännöt seurantakoodin latautumisen ja lähetyksen), referrer_policy ja referrer_ok (no-referrer-käytäntö tarkoittaa, että jokainen käynti näkyy suorana) sekä checked_at. Se hakee julkisen internetin yli, lukee enintään 2 Mt ja on nopeusrajoitettu työtilaa ja isäntää kohti, joten se vastaa 429, kun sitä kutsutaan liian usein. Jos sivu ei ole tavoitettavissa, se palauttaa validointivirheen. Käytä sites_setup_get-kutsua nähdäksesi, onko tapahtumia saapunut. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
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
Rakenna seurantakoodinpätkä valituilla asetuksilla
tracking_snippet
Rakentaa HTML-script-tunnisteen seurannan asentamiseen sivustolle ja palauttaa sen sivuston tunnuksen kanssa kentissä data.site_id ja data.snippet. Valitse tämä sites_setup_get-kutsun sijaan, kun haluat räätälöidä sitä, ja käytä sen jälkeen tracking_verify-kutsua live-sivun tarkistamiseen. Oletuksena jokainen seurantamoduuli ladataan ja sivunäytöt ovat automaattisia. modules rajaa sen osajoukkoon arvoista engage (aika ja vieritys), auto (lähtevät linkit, lataukset, lomakkeet, 404-sivut), vitals (Web Vitals), clicks (klikkauskartat) ja ask (sivustokyselyt). manual true poistaa automaattisen sivunäytön käytöstä, jolloin lähetät ne itse. spa asettaa yhden sivun sovelluksen navigoinnin seurannan arvoon auto, history, hash tai off. domains rajaa seurannan näihin isäntänimiin, exclude listaa ohitettavat polkujen glob-mallit, query_params listaa säilytettävät lisäkyselyparametrit ja mask listaa asiakaspuolen polkumaskit muodossa /u/*->/u/:id. Mitään ei tallenneta, koodinpätkä generoidaan syötteistä joka kerta. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/tracking/snippet.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Sivustot
POST
/sites/:site_id/data_reset.json
Poista kaikki tapahtumat ja käynnit aikaväliltä (ajetaan taustalla, ei voi perua)
sites_reset_data
Poistaa peruuttamattomasti sivuston sivunäytöt, omat tapahtumat ja käynnit päivämääräväliltä, eikä sitä voi perua. Käytä sitä testiliikenteen tyhjentämiseen tai huonon jakson poistamiseen. Se ei poista sivustoa, sen tavoitteita tai asetuksia (käytä sites_delete-kutsua sivustolle). from ja to ovat YYYY-MM-DD-päivämääriä, molemmat mukaan lukien ja luettuna sivuston aikavyöhykkeellä, ja to ei saa olla ennen from-päivää. confirm on oltava sivuston verkkotunnus täsmälleen kuten sites_get sen näyttää (kirjainkoolla ei ole väliä). Pyyntö hyväksytään ja palaa heti tilalla queued sekä kentillä site_id, from ja to. Poisto suoritetaan taustalla erissä, joten tilastotyökalujen luvut voivat kestää hetken asettua, eikä kyselyyn ole tilapäätepistettä, tarkista tilastotyökaluja, kunnes alue on tyhjä. Toimenpide kirjataan tarkastuslokiin. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Suodatetun liikenteen yhteenveto: botit, liikennesäännöt tai PII-piilotukset syyn ja maan mukaan (vain määrät)
sites_filter_stats
Lukumäärät osumista, jotka pudotettiin tai puhdistettiin ennen tallennusta, viimeisten päivien aikana. Käytä sitä nähdäksesi, kuinka paljon bottiliikennettä, sääntöjen estämää liikennettä tai sensurointia sivustolla on. Valitse kind arvoista bot (botteina pudotetut osumat), rule (liikennesääntöjen pudottamat osumat) tai redaction (henkilötietojen puhdistajan sensuroimat arvot). Palauttaa kind, days, total, by_reason, by_country ja by_day. by_reason ja by_country ovat listoja muodossa {value, count} (enintään 50, suurin ensin, value null kun tuntematon) ja by_day on lista muodossa {date, count}. days rajataan välille 1 - 395 ja oletus on 30. Nämä ovat vain koosteena olevia lukumääriä. IP-osoitteita, user agent -tunnisteita tai sensuroituja arvoja ei tallenneta, joten mitään ei voi jäljittää henkilöön. Näitä osumia ei lasketa laskutettaviksi tapahtumiksi. Käytä traffic_rules_list-kutsua nähdäksesi tai muuttaaksesi sääntöjä.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/filter_stats.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/access.json
Listaa jäsenet ja se, näkevätkö he tämän sivuston
sites_access_list
Näyttää, mitkä työtilan jäsenet näkevät yhden sivuston. Jokainen työtilan jäsen listataan liittymisjärjestyksessä, ei sivutettu. Kenttiä ovat membership_id (uuid, jota sites_access_update käyttää), email, name, role, access (true, kun jäsen näkee tämän sivuston) ja locked (true omistajille ja ylläpitäjille, joilla on aina pääsy ja joita ei voi muuttaa). Muilla jäsenillä on pääsy, kun heillä on kaikki sivustot tai nimenomainen oikeus tälle sivustolle. Käytä members_list-kutsua nähdäksesi jäsenen koko sivustolistan. Vaatii members.manage-oikeuden.
Oikeus: members.manage
curl https://privatusanalytics.com/sites/:site_id/access.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/access.json
Myönnä tai poista yhden jäsenen pääsy tähän sivustoon
sites_access_update
Myöntää tai poistaa yhden jäsenen pääsyn yhdelle sivustolle. membership_id tulee sites_access_list-kutsusta (tai members_list-kutsusta) ja access on true myöntääksesi tai false poistaaksesi. Omistajilla ja ylläpitäjillä on aina pääsy eikä heitä voi muuttaa. Pääsyn poistaminen jäseneltä, jolla oli kaikki sivustot, vaihtaa hänet nimenomaiseen listaan kaikista muista työtilan sivustoista ja kytkee pois hänen include_future_sites-asetuksensa, joten hän ei saa myöhemmin luotuja sivustoja. Myöntäminen jollekulle, jolla on jo kaikki sivustot, ei muuta mitään. Et voi muuttaa jäsentä, jolla on oikeuksia, joita sinulla ei ole, tai sivustoja omiesi ulkopuolelta. Vaatii members.manage-oikeuden. Palauttaa kyseisen jäsenen rivin samassa muodossa kuin sites_access_list.
Oikeus: members.manage
· Vain HTTP (ei MCP-työkalu)
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
Merkitse sivusto tähdellä (kiinnitetään ensimmäiseksi kohdassa Kaikki sivustot)
sites_favorite
Tähdittää sivuston kutsuvalle käyttäjälle, jolloin se listataan ensimmäisenä sites_list-kutsussa ja Kaikki sivustot -sivulla. Se vaikuttaa vain kutsujaan, ei koskaan muihin jäseniin, ja jo tähditetyn sivuston tähdittäminen ei muuta mitään. Kutsu ei tarvitse muuta syötettä kuin sivuston tunnuksen. Käytä sites_unfavorite-kutsua tähden poistamiseen. Vaatii analytics.read-oikeuden. Palauttaa sivuston (katso sites_get), jossa favorite on true.
Oikeus: analytics.read
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
Poista sivuston tähti
sites_unfavorite
Poistaa kutsuvan käyttäjän tähden sivustolta, joten se ei ole enää kiinnitetty ensimmäiseksi sites_list-kutsussa. Se vaikuttaa vain kutsujaan eikä tee mitään, jos sivustoa ei ollut tähditetty. Käytä sites_favorite-kutsua tähdittääksesi sen uudelleen. Vaatii analytics.read-oikeuden. Palauttaa sivuston (katso sites_get), jossa favorite on false.
Oikeus: analytics.read
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
Sivuston asennustila ja koodinpätkä
sites_setup_get
Palauttaa sen, mitä tarvitaan seurannan asentamiseen sivustolle ja onko dataa saapunut. Kenttiä ovat site_id, snippet (valmis liitettävä HTML-script-tunniste, jossa jokainen seurantamoduuli on käytössä), receiving_data (true, kun ensimmäinen tapahtuma on vastaanotettu) ja first_event_at (ISO 8601, null siihen asti). Kysele tätä asennuksen jälkeen nähdäksesi, tuleeko tapahtumia. Käytä sen sijaan tracking_snippet-kutsua, kun haluat räätälöidyn koodinpätkän (valitut moduulit, manuaaliset sivunäytöt, SPA-tila, maskit), ja tracking_verify-kutsua hakeaksesi live-sivun ja tarkistaaksesi, että skripti on paikallaan. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/setup.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/transfers/:token/accept.json
Hyväksy sivuston siirto yhteen työtiloistasi
site_transfers_accept
Hyväksyy sivuston siirtokutsun ja siirtää sivuston yhteen kutsujan työtiloista. Polkuparametri token on kutsulinkistä ja workspace_id on kohdetyötila (ws_...), jossa kutsujalla on sites.manage. Kutsujan oman sähköpostin on vastattava osoitetta, johon kutsu lähetettiin, eikä kohde voi olla työtila, josta sivusto tuli. Sivusto säilyttää tunnuksensa, asetuksensa, tavoitteensa ja datansa, mutta jäsenkohtaiset pääsyoikeudet tyhjennetään ja sen jakolinkit siirtyvät uuteen työtilaan. Se epäonnistuu, kun kutsu ei ole enää odottava tai on vanhentunut, kun kohde on paketin sivustorajalla tai kun sillä on jo aktiivinen sivusto samalla verkkotunnuksella. Siirtoa ei voi perua muuten kuin siirtämällä takaisin. Tämän kutsun tekevän tunnisteen on kuuluttava kohdetyötilaan ja sillä on oltava sites.manage. Palauttaa siirron tilalla accepted.
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/transfers/:token/accept.json \
-H "Content-Type: application/json" -d '{…}'
POST
/sites/:site_id/transfer.json
Aloita sivuston siirto toiseen työtilaan (lähettää sähköpostin vastaanottajalle)
sites_transfer_start
Aloittaa sivuston siirron toiseen työtilaan lähettämällä vastaanottajalle sähköpostilla kutsulinkin, joka on voimassa 7 päivää. Mikään ei siirry ennen kuin vastaanottaja kirjautuu sisään kyseisellä sähköpostilla ja hyväksyy (site_transfers_accept), joten sivusto pysyy täällä siihen asti. Uuden siirron aloittaminen peruu aiemman odottavan siirron samalle sivustolle. email on oltava kelvollinen osoite ja vastaanottaja valitsee kohdetyötilan. Siirtosähköpostit on nopeusrajoitettu. Käytä sites_transfer_cancel-kutsua perumiseen. Vaatii sites.manage-oikeuden. Palauttaa siirron kentillä site_id, site_domain, from_workspace, to_email, status pending ja expires_at.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Peruuta odottava sivuston siirto
sites_transfer_cancel
Peruu sivuston odottavan siirtokutsun, jolloin sen linkki lakkaa toimimasta. Se epäonnistuu validointivirheeseen, kun mikään siirto ei ole odottava. Jo hyväksyttyä siirtoa ei voi peruuttaa. Vaatii sites.manage-oikeuden. Palauttaa siirron tilalla canceled.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Hae odottava siirto sähköpostitse lähetetyllä tunnisteella
site_transfers_get
Näyttää sivuston siirtokutsun linkin tunnisteen perusteella (polkuparametri token, sites_transfer_start-kutsun lähettämästä kutsusähköpostista). Kutsujan on oltava kirjautunut tai käytettävä API-tunnistetta. Palauttaa site_id, site_domain, from_workspace (lähettävän työtilan nimi), to_workspace_id (null kunnes hyväksytty), to_email (kutsuttu osoite), status (pending, accepted tai canceled) ja expires_at. Kutsut vanhenevat 7 päivää lähettämisen jälkeen. Käytä site_transfers_accept-kutsua hyväksyäksesi sen.
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/transfers/:token.json
POST
/workspaces/:workspace_id/sites.json
Lisää sivusto
sites_create
Lisää verkkosivuston työtilaan ja palauttaa sen, mukaan lukien asennettavan seurantakoodin. Työtilan paketti rajoittaa sivustojen määrää (Free sallii 3) ja kutsu epäonnistuu pakettirajavirheeseen, kun raja saavutetaan. domain on pakollinen ja se normalisoidaan (esimerkiksi täysi URL tai www-etuliite typistetään isäntänimeen). name on oletuksena verkkotunnus, timezone on oletuksena työtilan aikavyöhyke (IANA-nimi, kuten Europe/Berlin) ja currency työtilan valuutta (3-kirjaiminen ISO 4217 -koodi, kuten USD). Sivuvaikutuksia ovat site.created-ilmoitus työtilan ilmoituskanaville, ensimmäisen SEO-sivustotarkastuksen ja verkkotunnuksen arvosanatarkistuksen jonottaminen sekä seurantakoodin sisältävä sähköposti sivuston luoneelle jäsenelle (muistutuksineen, kunnes dataa saapuu). Valittuihin sivustoihin rajatut jäsenet, jotka ovat valinneet tulevat sivustot, saavat siihen pääsyn. Vaatii sites.manage-oikeuden. Jatka tracking_snippet- tai sites_setup_get-kutsulla asennusta varten ja tracking_verify-kutsulla tarkistusta varten.
Oikeus: sites.manage
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
Poista sivusto (tyhjennetään 7 päivän kuluttua)
sites_delete
Poistaa sivuston. Se on pehmeä poisto, sivusto lakkaa keräämästä dataa ja katoaa listoista heti, ja sen data tyhjennetään pysyvästi 7 päivän kuluttua, joten pidä sitä peruuttamattomana ja ota nopeasti yhteyttä tukeen, jos se oli virhe. confirm on oltava sivuston verkkotunnus (kirjainkoolla ei ole väliä). Sivuston odottavat siirrot peruutetaan ja site.deleted-ilmoitus lähetetään työtilan ilmoituskanaville. Jos haluat tyhjentää vain osan liikenteestä ja säilyttää sivuston, käytä sites_reset_data-kutsua. Vaatii sites.manage-oikeuden. Palauttaa sivuston.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Listaa työtilan sivustot
sites_list
Listaa työtilan sivustot, joihin kutsujalla on pääsy, sivutettuna ja kutsujan tähdittämät sivustot ensin. Käytä query-arvoa hakeaksesi verkkotunnusta tai nimeä (osittainen, kirjainkoosta riippumaton), label-arvoa säilyttääksesi sivustot, joilla on tietty tunniste, ja sort-arvoa position (tallennettu järjestys, oletus), name tai visitors (kävijät viimeisen 30 päivän aikana, eniten ensin). Vastauksen meta sisältää sivukohtaisen sivutuksen sekä stats-objektin, joka on avainnettu sivuston tunnuksella ja sisältää visitors (viimeaikaiset yksilölliset kävijät), change (prosenttimuutos edelliseen jaksoon verrattuna), sparkline (lista päiväarvoja) ja live (nykyiset kävijät), sekä totals koko sivulle. Jokaisella kohteella on samat kentät kuin sites_get-kutsussa. Tämä on lähtökohta sivustojen tunnusten (pa_...) löytämiseen, joita jokainen muu sivustotyökalu käyttää. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/workspaces/:workspace_id/sites.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:id.json
Hae sivusto ja kaikki sen asetukset
sites_get
Palauttaa yhden sivuston asetukset ja tilan sen julkisella tunnuksella (pa_..., sites_list-kutsusta). Tärkeimmät kentät ovat id, workspace_id (ws_...), domain, name, extra_domains ja multi_domain_mode (combined tai separate), timezone (IANA-nimi), currency (ISO 4217), labels, yksityisyysasetukset (honor_dnt, honor_gpc, pii_scrubber, redaction_rules, allowed_params, path_masks), retention_months (null tarkoittaa kaiken datan säilyttämistä), bot_filtering, traffic_rule_modes (objekti, joka yhdistää sääntölistan arvoon block tai allow), vitals_sample_rate (prosentti), conversion_denominator (visits tai visitors), public_dashboard ja public_indexable, ingest_key_prefix (null, kun sivustolla ei ole indeksoijalokien avainta), verified_at, first_event_at ja last_event_at (null kunnes dataa saapuu), domain_rating (voi olla null), snippet (HTML-seurantatunniste), favorite (onko kutsuja tähdittänyt sen) ja created_at. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:id.json
Päivitä sivuston asetukset
sites_update
Päivittää sivuston asetuksia muuttaen vain lähettämäsi kentät. Nimi- ja tunnistekentät ovat name, domain (sen muuttaminen tarkistaa verkkotunnuksen arvosanan uudelleen), extra_domains (lista isäntänimiä) ja multi_domain_mode (combined laskee yhden kävijän verkkotunnusten yli, separate pitää ne erillään). timezone on IANA-nimi ja currency 3-kirjaiminen ISO 4217 -koodi. Yksityisyyskentät ovat honor_dnt, honor_gpc, pii_scrubber, redaction_rules (lista objekteja kentillä name ja pattern, pattern on säännöllinen lauseke), allowed_params (säilytettävät kyselyparametrit), path_masks (lista objekteja kentillä pattern ja replacement) ja bot_filtering. Listat korvaavat koko olemassa olevan listan. retention_months ei saa ylittää paketin säilytysaikaa (Free 6 kuukautta). traffic_rule_modes yhdistää sääntölistan (hostnames, paths, referrers, countries, ip_ranges, user_agents tai events) arvoon block tai allow. vitals_sample_rate on prosentti ja paketti rajaa sen (10 Free-paketissa, 100 maksullisissa paketeissa). conversion_denominator on visits tai visitors. public_dashboard tekee tilastot katsottaviksi kaikille linkin haltijoille ja public_indexable sallii hakukoneiden indeksoida sen sivun. Muutokset tulevat voimaan uusille tapahtumille hetkessä. Vaatii sites.manage-oikeuden. Palauttaa päivitetyn sivuston.
Oikeus: sites.manage
curl -X PATCH https://privatusanalytics.com/sites/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Sivustotarkastus
GET
/sites/:site_id/audit/issues.json
Listaa sivustotarkastuksen ongelmat, yksi rivi tarkistusta kohti
site_audit_issues_list
Listaa yhden tarkastuksen ongelmat, yksi rivi tarkistusta kohti, joka merkitsi jotakin, pahin ensin (virheet, sitten varoitukset, sitten huomautukset, kukin kohteena olevien URL-osoitteiden mukaan). Jokaisella rivillä on check_key (käytä sitä kutsujen site_audit_issues_get ja mykistystyökalujen kanssa), title, category, severity (error, warning tai notice), affected (merkityt URL-osoitteet, mykistetyt pois lukien), added ja fixed (muutokset edellisestä tarkastuksesta) sekä pageviews (käynnit kohteena oleville sivuille tarkastusta edeltäneiden 30 päivän aikana). Oletuksena uusin valmistunut tarkastus, tai anna audit_id. Suodata arvoilla severity, category ja new_only (vain tarkistukset, joiden URL-osoitteet ovat uusia edelliseen tarkastukseen verrattuna). Sivutettu page- ja per_page-arvoilla (enintään 100, oletus 50). Nähdäksesi, mitä URL-osoitteita tarkistus merkitsi, käytä site_audit_issues_get-kutsua. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/audit/issues.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/audit/issues/:check_key.json
Hae yksi sivustotarkastuksen tarkistus: miksi sillä on merkitystä, miten se korjataan ja mitkä URL-osoitteet se koskee
site_audit_issues_get
Yhden tarkastuksen tarkistuksen yksityiskohdat check_key-arvolla site_audit_issues_list-kutsusta (esimerkiksi title_missing). Palauttaa audit_id, issue (sama rivi kuin listassa), why (mitä ongelma tarkoittaa), fix (miten se korjataan), muted (true, jos koko tarkistus on mykistetty sivustolle) ja urls, merkityt URL-osoitteet kentillä page_id (käytä sitä site_audit_pages_get-kutsun kanssa), url, pageviews, detail (lisätietoja havainnosta, voi olla tyhjä), is_new ja muted. sort on pageviews (oletus, vilkkain ensin) tai url. Sivutettu page- ja per_page-arvoilla (enintään 100, oletus 25). Oletuksena uusin valmistunut tarkastus, tai anna audit_id. Mykistetyt URL-osoitteet lajitellaan viimeisiksi. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
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
Mykistä sivustotarkastuksen tarkistus usealta URL-osoitteelta tai useita kokonaisia tarkistuksia yhdellä kutsulla
site_audit_mutes_bulk
Mykistää monta havaintoa yhdellä pyynnöllä, kaikki tai ei mitään. Käytä jompaakumpaa kahdesta muodosta. Joko lähetä check_key sekä urls (enintään 100 URL-osoitetta) mykistääksesi yhden tarkistuksen usealta sivulta, tai lähetä check_keys (enintään 100) mykistääksesi kokonaisia tarkistuksia sivustolle. Älä sekoita urls-arvoa ja check_keys-arvoa. Tuntematon tarkistus tai virheellinen URL epäonnistuttaa koko pyynnön eikä mykistä mitään. Jo mykistetyt kohteet palautetaan sellaisinaan. Uusimman tarkastuksen luvut ja pistemäärä päivitetään kerran lopuksi. Palauttaa mykistysten listan. Kumoa kukin site_audit_mutes_delete-kutsulla. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Mykistä sivustotarkastuksen tarkistus koko sivustolta tai yhdeltä URL-osoitteelta
site_audit_mutes_create
Mykistää yhden tarkistuksen sivustolle tai vain yhdelle URL-osoitteelle. check_key tulee site_audit_issues_list-kutsusta. Jätä url pois mykistääksesi tarkistuksen kaikkialla tai anna täysi URL (kuten https://example.com/old) mykistääksesi sen vain kyseiselle sivulle, jolloin URL normalisoidaan samalla tavalla kuin indeksoija tekee. Uusimman tarkastuksen luvut ja pistemäärä päivittyvät heti. Saman asian mykistäminen kahdesti palauttaa olemassa olevan mykistyksen virheen sijaan. Jos haluat mykistää monta kerralla, käytä site_audit_mutes_bulk-kutsua ja kumoamiseen site_audit_mutes_delete-kutsua. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Poista sivustotarkastuksen tarkistuksen mykistys
site_audit_mutes_delete
Poistaa mykistyksen, löydettynä id:llä site_audit_mutes_list-kutsusta, jolloin tarkistus tai URL lasketaan taas tarkastuksen pistemäärään. Uusin tarkastus lasketaan heti uudelleen. Tämä poistaa vain mykistyksen eikä poista tarkastusdataa. Palauttaa poistetun mykistyksen. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Listaa tarkistukset, jotka sivusto on mykistänyt
site_audit_mutes_list
Listaa sivustolle mykistetyt tarkistukset uusin ensin. Mykistys piilottaa tarkistuksen joko koko sivustolta (url on null) tai yhdeltä URL-osoitteelta, jolloin kyseiset havainnot pysyvät poissa luvuista ja pistemäärästä, vaikka tarkastukset kirjaavat ne yhä. Jokaisella rivillä on id (mykistyksen tunnus, käytä sitä site_audit_mutes_delete-kutsun kanssa), site_id, check_key, title, url (null koko sivuston mykistykselle), muted_by (jäsenen nimi, null jos tuntematon) ja created_at. Suodata check_key-arvolla. Sivutettu page- ja per_page-arvoilla (enintään 100). Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/audit/mutes.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/audit/notifications.json
Ota sivuston tarkastusyhteenvetosähköposti käyttöön tai pois käytöstä
site_audit_notifications_update
Kytkee viikoittaisen tarkastusyhteenvedon sähköpostin päälle tai pois kutsuvalle jäsenelle yhdellä sivustolla. Se on henkilökohtainen asetus eikä vaikuta muihin jäseniin. enabled true lähettää jäsenelle yhteenvedon tämän sivuston tarkastusten jälkeen, false lopettaa sen. Palauttaa site_id, enabled ja all_sites_enabled (false, kun jäsen on kytkenyt pois tarkastussähköpostit kaikilta tilinsä sivustoilta tilin asetuksissa, mikä ohittaa tämän). Mikä tahansa jäsen, jolla on analytics.read, voi muuttaa omaa asetustaan.
Oikeus: analytics.read
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
Listaa ja suodata sivustotarkastuksen sivut
site_audit_pages_list
Sivuselain, joka listaa yhden tarkastuksen URL-osoitteet (oletuksena uusin valmistunut tai audit_id). kind on page (oletus, HTML-dokumentit), resource (kuvat, skriptit, tyylitiedostot) tai external (linkit muille sivustoille). Suodata arvoilla state (queued, fetched, skipped, blocked, failed), status_class (2xx, 3xx, 4xx tai 5xx), indexable, in_sitemap, has_issues (vain mykistämättömät ongelmat lasketaan), depth (klikkaukset aloitussivulta) ja query (teksti URL-osoitteessa tai otsikossa). sort on pageviews (oletus), inlinks, depth, response_ms (hitain ensin) tai word_count (vähiten ensin). Jokaisella rivillä on id (UUID site_audit_pages_get-kutsua varten), url, path, kind, state, status, depth, indexable, indexability_reason, title, word_count, response_ms, cache_status, inlinks, pageviews, in_sitemap ja issues (lukumäärä). Sivutettu page- ja per_page-arvoilla (enintään 100). Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/audit/pages.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/audit/pages/:id.json
Hae yksi tarkastettu sivu: sen metatiedot, ongelmat sekä sisään- ja ulosmenevät linkit
site_audit_pages_get
Kaikki, mitä tarkastus tallensi yhdestä URL-osoitteesta, id:n perusteella (UUID site_audit_pages_list-kutsusta tai site_audit_issues_get-kutsun urls-kentästä). Palauttaa id, audit_id, page (url, status, redirect_to, content_type, bytes, response_ms, title, meta_description, h1, canonical, robots_meta, indexable ja indexability_reason, word_count, lang, hreflang, schema_types, sosiaalisen median tunnisteet, images_count, images_missing_alt, linkkimäärät, link_score, in_sitemap, has_tracker, pageviews ja search_clicks, fetched_at ja muuta), redirect_target_id (sivu, jolle se ohjaa tarkastuksen sisällä, tai null), issues (check_key, title, category, severity, detail, is_new, muted) sekä inlinks ja outlinks (enintään 100 kumpaakin kentillä page_id, url, status, kind, anchor, nofollow, count). Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/audit/pages/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/audit/settings.json
Hae sivuston tarkastusasetukset
site_audit_settings_get
Palauttaa sivuston tarkastusasetukset. Kenttiä ovat site_id, enabled (ajastetut tarkastukset päällä tai pois, oletuksena päällä), include_subdomains, check_external_links, exclude_paths, ignored_params, extra_start_urls, next_run_at (milloin seuraava ajastettu tarkastus erääntyy, null jos ei ole), page_limit (sivuja tarkastusta kohti nykyisessä paketissa, null kun rajaton) ja interval_days (päivät ajastettujen tarkastusten välillä paketissa). Sivusto, joka ei ole koskaan muuttanut asetuksiaan, palauttaa oletukset. Muuta niitä site_audit_settings_update-kutsulla. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
curl https://privatusanalytics.com/sites/:site_id/audit/settings.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/audit/settings.json
Muuta sivuston tarkastusasetuksia
site_audit_settings_update
Muuttaa tapaa, jolla sivustoa tarkastetaan. Vain lähettämäsi syötteet muuttuvat. enabled kytkee ajastetut ja manuaaliset tarkastukset päälle tai pois (päälle kytkeminen ajastaa seuraavan tarkastuksen yhden paketin välin päähän). include_subdomains ja check_external_links ovat totuusarvoja. Kolme listaa korvaavat tallennetun listan, niitä ei yhdistetä, joten lähetä koko lista. exclude_paths ovat polkuetuliitteitä, jotka indeksoija ohittaa, ja jokaisen on alettava vinoviivalla (enintään 50). ignored_params ovat kyselyparametrien nimiä, jotka eivät koskaan tee eri sivua, kuten utm_source tai sessionid (enintään 50, kirjaimia, numeroita, pisteitä, tavuviivoja ja alaviivoja). extra_start_urls ovat täysiä http- tai https-URL-osoitteita, jotka indeksoidaan etusivun lisäksi (enintään 20). Listan voi lähettää myös tekstinä, yksi merkintä riviä kohti. Palauttaa päivitetyt asetukset. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
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
Peru sivustotarkastuksen yhteenvetosähköpostien tilaus sähköpostin tunnisteella
site_audit_unsubscribes_create
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/audit/unsubscribe/:token.json \
-H "Content-Type: application/json" -d '{…}'
POST
/sites/:site_id/audit/cancel.json
Peruuta käynnissä oleva sivustotarkastus
site_audit_cancel
Pysäyttää sivustolle käynnissä olevan tai jonossa olevan tarkastuksen. Tarkastus merkitään peruutetuksi eikä keskeneräisestä indeksoinnista raportoida mitään. Peruutettu tarkastus ei kuluta Free-paketin kuukausikiintiötä. Epäonnistuu validointivirheeseen, jos mikään tarkastus ei ole käynnissä. Palauttaa peruutetun tarkastuksen. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Vertaa kahta sivustotarkastusta: lisätyt ja korjatut URL-osoitteet tarkistuksittain
site_audit_compare
Vertaa sivuston kahta tarkastusta tarkistus tarkistukselta. audit_id on uudempi tarkastus ja base_id vanhempi. Molemmilla on järkevät oletukset (uusin valmistunut tarkastus verrattuna sitä edeltävään valmistuneeseen), ja työkalu vaihtaa ne, jos annat ne väärässä järjestyksessä. Palauttaa audit ja base (kumpikin tarkastuksen yhteenveto, base null jos aiempaa ei ole) sekä checks, yksi objekti tarkistusta kohti, jonka URL-osoitteet muuttuivat, kentillä check_key, title, category, severity, base_affected, affected, added ja fixed (URL-määrät), virheet ensin lajiteltuina. Tarkistukset ilman muutosta jätetään pois. Kahdelle peräkkäiselle tarkastukselle added ja fixed ovat tarkkoja, kauempana toisistaan oleville ne ovat nettomuutos. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/audit/compare.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/audit.json
Aloita sivustotarkastus nyt
site_audit_run
Aloittaa uuden indeksoinnin ja SEO-tarkastuksen sivustolle nyt. Se indeksoi sivuston julkiset sivut taustalla, joten tämä palaa heti uuden tarkastuksen kanssa tilassa queued. Kysele site_audit_get-kutsua (live-kenttä) tai site_audit_history-kutsua, kunnes status on complete. Hylätään validointivirheellä, kun tarkastus on kytketty pois site_audit_settings_update-kutsulla, kun toinen tarkastus on jo jonossa tai käynnissä, kun manuaalinen tarkastus on aloitettu viimeisen 24 tunnin aikana, ja Free-paketissa, kun mikä tahansa tarkastus on ajettu viimeisen 30 päivän aikana (epäonnistuneita ja peruutettuja ei lasketa). Vahvistamattomat sivustot ilman tapahtumia on myös rajattu yhteen tarkastukseen päivässä verkkotunnusta kohti. Indeksoitavat sivut on rajattu paketin mukaan (Free 100, Pro 1 000, Business 10 000). Tarkista ensin can_run site_audit_get-kutsusta. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Listaa sivuston tarkastukset, uusin ensin
site_audit_history
Listaa sivuston tarkastukset uusin ensin, kullakin kentät id (aud_...), status (queued, running, analyzing, complete, partial, failed tai canceled), trigger (first, scheduled tai manual), score (0 - 100, null kunnes valmis), score_band, page_limit, pages_crawled, urls_discovered, errors, warnings, notices, new_issues, fixed_issues, failure (syy epäonnistuessa, muuten null) ja aikaleimat. Suodata status-arvolla. Sivutettu page- ja per_page-arvoilla (enintään 100). Käytä tunnuksia kutsuissa site_audit_get, site_audit_compare sekä ongelma- ja sivutyökaluissa. Yhden tarkastuksen nykytilaan käytä site_audit_get-kutsua. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/audit/history.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/audit.json
Hae sivustotarkastuksen yhteenveto: pisteet, määrät, liikenteen mukaan tärkeimmät ongelmat ja parhaillaan käynnissä oleva tarkastus
site_audit_get
SEO-sivustotarkastuksen yleiskatsaus, paras ensimmäinen kutsu tarkastuskysymyksiin. Oletuksena se kuvaa uusimman valmistuneen tarkastuksen, tai anna audit_id (aud_..., site_audit_history-kutsusta) vanhemmalle. Tuloksessa on audit (valmistunut tarkastus kentillä score 0 - 100, score_band, score_delta, virheiden, varoitusten ja huomautusten määrät, pages_crawled, page_limit, capped, summary ja robots-tiedot, tai null jos mikään ei ole valmistunut), live (parhaillaan käynnissä oleva tarkastus tai null), enabled ja next_run_at (aikataulu), can_run kentillä run_blocked (live, disabled tai too_soon) ja run_allowed_at (milloin site_audit_run on taas sallittu), changes (lisättyjen ja korjattujen URL-osoitteiden määrät vakavuuden mukaan), trend (enintään 30 viimeisintä pistemäärää muodossa id, finished_at, score), top_issues (enintään 10 tarkistusta järjestettynä vakavuuden ja sitten kohteena olevien sivujen sivunäyttöjen mukaan) ja email_enabled (oma yhteenvetosähköpostiasetuksesi). Jatka kutsuilla site_audit_issues_list kaikille ongelmille ja site_audit_pages_list URL-osoitteille. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/audit.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Sponsoriraportit
POST
/sites/:site_id/experiments/ads/:ad_placement_id/reports.json
Luo sponsoriraporttilinkki mainospaikalle
ad_report_links_create
Vain luku -linkki mainospaikan lukuihin, kaikille sen mainoksille tai niille, jotka on lueteltu kentässä creative_ids, henkilölle, jolla ei ole tiliä. MCP:n kautta jäsenelle lähetetään sähköpostia linkin luomisesta. Pro ja ylemmät. Vaatii content.write. Palauttaa linkin ja sen url:n.
Oikeus: content.write
curl -X POST https://privatusanalytics.com/sites/:site_id/experiments/ads/:ad_placement_id/reports.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
DELETE
/sites/:site_id/experiments/ads/:ad_placement_id/reports/:id.json
Poista sponsoriraporttilinkki
ad_report_links_delete
Osoite lakkaa toimimasta heti. MCP-työkalu ei suorita tätä vaan vastaa human_only-vastauksella ja sivulla, jolla ihminen poistaa sen. Vaatii content.write.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
curl -X DELETE https://privatusanalytics.com/sites/:site_id/experiments/ads/:ad_placement_id/reports/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
GET
/sites/:site_id/experiments/ads/:ad_placement_id/reports.json
Listaa mainospaikan sponsoriraporttilinkit
ad_report_links_list
Linkit osoitteineen ja vanhenemisaikoineen. Vaatii analytics.read.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/experiments/ads/:ad_placement_id/reports.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Sponsoriraportti
GET
/sponsor/:token.json
Sponsoriraportti linkin tunnisteella
ad_reports_get
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/sponsor/:token.json
Suorituskyky
GET
/sites/:site_id/performance.json
Web Vitals: p75-tulokortti, päivittäinen trendi ja erittelyt sivun, laitteen, selaimen ja maan mukaan
performance_report
Web Vitals -raportti oikeilta kävijöiltä. Palauttaa period, metric, sample_rate, scorecard, trend ja breakdowns. scorecard sisältää yhden rivin kullekin mittarille LCP, INP, CLS, FCP ja TTFB kentillä p75 (75. persentiili, millisekunteina paitsi CLS, joka on yksikötön pistemäärä), samples, rating (good, needs_improvement tai poor, null ilman dataa), good, needs_improvement ja poor (prosenttia otoksista), previous_p75, change (prosenttia verrattuna aiempaan jaksoon, null kun tuntematon) ja thresholds [good-raja, poor-raja]. trend on valitun mittarin päivittäinen p75 muodossa {date, p75, samples}. breakdowns sisältää page, device, browser ja country, kukin enintään limit-arvon verran rivejä (oletus 10, enintään 100) valitusta mittarista muodossa {value, p75, samples, rating, slow_share, poor}, huonoin ja vilkkain ensin. Valitse metric täsmälleen yhdellä arvoista LCP, INP, CLS, FCP tai TTFB isoin kirjaimin (oletus LCP). sample_rate on niiden käyntien osuus, jotka raportoivat vitals-arvoja, joten luvut ovat otoksia eivätkä kaikkia käyntejä. Ottaa yhteiset period-, compare-, filters- ja segment-syötteet. Yhden sivun vitals-arvoihin käytä pages_detail-kutsua.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/performance.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Suositukset
GET
/sites/:site_id/testimonials/overview.json
Lue sivuston luvut, mikä vaatii huomiota ja mitä on viime aikoina tapahtunut
testimonials_overview
stats sisältää Yleiskatsaus-sivun viisi lukua: hyväksytyt suositukset, odottavat, uudet tässä kuussa, keskimääräinen arvosana ja käytössä olevat. attention listaa päätöstä vaativat lukumäärineen. activity on 10 viimeisintä tapahtumaa ja latest_approved kolme viimeksi hyväksyttyä suositusta.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/overview.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/testimonials/setup.json
Hae sivuston käyttöönoton tarkistuslista
testimonials_setup_get
Palauttaa kohdat import, testimonials, approve, ask, widget ja teammate, kukin kentillä done ja dismissed. Kohde on tehty sen perusteella, mitä sivustolla on, ei koskaan klikkauksella. hidden on true, kun jokainen kohde on tehty tai ohitettu, jolloin Saapuneet lopettaa kortin näyttämisen.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/setup.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/testimonials/setup.json
Ohita yksi käyttöönoton tarkistuslistan kohta tai koko kortti
testimonials_setup_update
dismiss on yhden kohdan avain (import, testimonials, approve, ask, widget tai teammate) tai all koko kortille. Ohittaminen piilottaa kohdan eikä koskaan merkitse sitä tehdyksi, eikä sitä voi palauttaa API:n kautta.
Oikeus: content.write
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
Hyväksy suositus, jotta se voidaan näyttää
testimonials_approve
Kiintiötä odottavaa suositusta ei voi hyväksyä: palvelin vastaa 422:lla ja koodilla waiting_for_allowance. Vastaus sisältää kohdan meta.undo_id.
Oikeus: content.write
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
Suorita yksi toiminto valitulle suosituksille tai kaikille suodattimen löytämille
testimonials_bulk
Lähetä ids (enintään 100, suoritetaan kerralla, kaikki tai ei mitään) tai filters kentän confirm_count kanssa (koko tulos). Yli 100 suoritetaan taustalla, ja vastauksessa on tila running. Toiminnot: approve, reject, mark_pending, pin, unpin, add_tags, remove_tags, add_to_collection, remove_from_collection, set_property, trash, restore. Jokainen vastaa kumoamistunnisteella, jonka testimonials_bulk_undo hyväksyy 7 päivän ajan. delete_permanently on ainoa toiminto, jota ei voi perua: se vaatii oikeuden sites.manage ja sen vastaus kertoo undoable false. MCP:n kautta kahta poistavaa toimintoa, trash ja delete_permanently, ei suoriteta: työkalu vastaa koodilla human_only ja sovelluksen sivulla, jossa henkilö tekee sen, ja kaikki muut toiminnot suoritetaan. API:n kautta toiminto export (kentillä ids tai filters ja valinnaisella format-arvolla csv, json, ndjson tai xlsx) ei muuta mitään: se vaatii oikeuden analytics.export ja vastaa 202:lla ja ladattavalla viennillä.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Peru joukkotoiminto 7 päivän kuluessa
testimonials_bulk_undo
Palauttaa aiemman arvon jokaiselle suositukselle, jota ajo muutti. Suositus, jota on sen jälkeen muutettu uudelleen, jätetään rauhaan ja lasketaan kenttään left. MCP:n kautta kumoamista, joka poistaisi tai siirtäisi roskakoriin, ei suoriteta (palautuksen, käännösajon ja kuvantekoajon kumoaminen): työkalu vastaa koodilla human_only ja sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: content.write
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
Lisää suositus käsin tai API:n kautta
testimonials_create
Tallennetaan sen yhden vastaanoton kautta, jota jokainen reitti käyttää. Se lasketaan paketin kuukausittaiseen uusien suositusten kiintiöön, ja kiintiössä palvelin vastaa 422:lla ja koodilla allowance_reached (vain asiakkaan lomakelähetys jää sen sijaan odottamaan). Sama henkilö, joka sanoo samat sanat uudelleen, hylätään koodilla duplicate, ellei allow_duplicate ole true. Sama external_id uudelleen palauttaa jo tallennetun.
Oikeus: content.write
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
Poista suositus pysyvästi historian, suostumustietueen ja tiedostojen kanssa
testimonials_delete
Tätä ei voi perua. Se toimii roskakorissa olevalle tai sen ulkopuolella olevalle suositukselle, vaatii kentän confirm ja oikeuden sites.manage. MCP:n kautta työkalu ei poista mitään ja vastaa sivulla, jossa henkilö tekee sen.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Siirrä suositus roskakoriin 30 päiväksi
testimonials_trash
Suositus säilyttää tilansa, tunnisteensa, kokoelmansa ja tiedostonsa, sitä ei näytetä missään ja se poistetaan pysyvästi 30 päivän kuluttua. testimonials_restore palauttaa sen täsmälleen entiselleen. Vastaus sisältää kohdan meta.undo_id. Jo roskakorissa olevan siirtäminen roskakoriin ei muuta mitään. MCP:n kautta työkalu ei muuta mitään ja vastaa sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Laske suositukset jokaisen suodatinarvon takana samoilla syötteillä kuin listassa
testimonials_facets
Kirjaston muoto lukematta yhtään suositusta. Jokainen facet laskee arvonsa niin, että sen oma valinta jätetään pois ja kaikki muut suodattimet otetaan huomioon. meta sisältää kokonaismäärän ja suodattimen sanoina.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/facets.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/testimonials/:id/highlight.json
Merkitse suosituksen paras lause tai tyhjennä se
testimonials_highlight
highlight on oltava tarkka osa suosituksen sanoista, tai palvelin vastaa 422:lla. Tyhjä highlight tyhjentää sen. Jokainen muutos on versio historiassa.
Oikeus: content.write
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
Listaa suosituksen sanojen, otsikon, arvosanan ja korostuksen kaikki versiot
testimonials_history
Uusin ensin. Versio 1 on suositus sellaisena kuin se vastaanotettiin, eikä sillä ole tekijää. Jokaisella myöhemmällä versiolla on sen tehnyt jäsen, aika, jättämä huomautus ja palautuksen tapauksessa versio, jonka se palautti. Sivutettu kentillä page ja per_page.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/:id/history.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/testimonials.json
Listaa sivuston suositukset suodatettuina ja lajiteltuina
testimonials_list
Kolme tapaa kertoa, mitkä, ja ne laskevat yhteen: facet-syötteet (status, tag_id, has_video ja muut), q (hakukenttä operaattoreineen, esimerkiksi rating:5 has:video tag:onboarding "saved us") ja conditions yhdessä match-kentän kanssa (rakenteiset rivit). Lähetä facets arvolla true saadaksesi jokaisen facet-arvon reaaliaikaisen lukumäärän kohtaan meta.facets. Roskakorissa olevia ei listata, ellei trashed ole true, jolloin listataan vain roskakori.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/testimonials/:id/pend.json
Palauta suositus odottavaksi
testimonials_pend
Palauttaa hyväksytyn tai hylätyn suosituksen odottavaksi, jolloin sitä ei näytetä missään ennen kuin siitä päätetään uudelleen. Vastaus sisältää kohdan meta.undo_id. Roskakorissa oleva suositus hylätään koodilla in_trash.
Oikeus: content.write
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
Kiinnitä suositus näytettäväksi ensimmäisenä tai poista kiinnitys
testimonials_pin
Kiinnitetty suositus näytetään ensimmäisenä kaikkialla, missä se esitetään. Lähetä pinned false poistaaksesi kiinnityksen. Vastaus sisältää kohdan meta.undo_id, kun jokin muuttui.
Oikeus: content.write
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
Hylkää suositus. Se säilytetään eikä sitä näytetä missään
testimonials_reject
Suositus säilyttää kaiken sisältönsä, eikä sitä näytetä missään. Jo hylätyn hylkääminen ei muuta mitään. Vastaus sisältää kohdan meta.undo_id, jonka testimonials_bulk_undo hyväksyy 7 päivän ajan. Roskakorissa oleva suositus hylätään koodilla in_trash.
Oikeus: content.write
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
Palauta suositus roskakorista täsmälleen entiselleen
testimonials_restore
Palauttaa roskakoriin siirretyn suosituksen tilaansa, tunnisteisiinsa, kokoelmiinsa ja paikkoihin, jotka sitä näyttivät. Sitä ei koskaan lasketa uudeksi suositukseksi. Suositus, joka ei ole roskakorissa, hylätään koodilla not_in_trash.
Oikeus: content.write
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
Palauta aiemman version sanat, otsikko, arvosana ja korostus
testimonials_restore_version
Historiasta ei poisteta mitään. Palautus on uusi versio, joka kertoo, mistä versiosta se tuli. version 1 palauttaa suosituksen vastaanotettuihin sanoihin. Tuntematon versionumero on 422.
Oikeus: content.write
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
Hae yksi suositus henkilöineen, tiedostoineen, suostumustietueineen, tunnisteineen ja käyttökohteineen
testimonials_get
Palauttaa sivuston yhden suosituksen sen tunnisteella (tm_...), roskakorissa tai ei. person.email on null, ellei kutsujalla ole oikeutta content.write, ja has_email kertoo, onko sellainen tallennettu. media listaa tiedostot niiden käsittelytiloineen. used_in listaa jokaisen widgetin, seinän ja kuvan, joka sitä näyttää.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/testimonials/showable.json
Listaa suositukset, jotka yleisö saa nähdä, sellaisina kuin yleisö ne saa nähdä
testimonials_showable
Sivuston uusimmat hyväksytyt suositukset, jotka saa näyttää julkisesti, omaa widgetien ja seinien ulkopuolista näyttöäsi varten. Jokainen sisältää vain sen, minkä sen suostumustietue sallii: henkilö, jonka nimeä ei saa näyttää, luetaan nimellä A customer, ja kuva tai tallenne jätetään pois, ellei sitä sallittu. Odottavaa, hylättyä tai roskakoriin siirrettyä suositusta tai kiintiötä odottavaa ei koskaan listata. Vastauksessa ei ole sähköpostia.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/showable.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/testimonials/triage.json
Hae seuraava suositus lajittelujonosta
testimonials_triage
Ilman suodatinta jono on Odottavat, ei kiintiötä odottavat, vanhimmin vastaanotettu ensin. Saapuneet-suodattimilla se on kyseinen tulos sen lajittelussa. Lähetä after juuri käsitellyn tunnisteella saadaksesi sen jälkeen tulevan. data on null, kun jono on tyhjä. meta sisältää kentät remaining ja total.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/triage.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/testimonials/:id.json
Muokkaa suositusta. Sanojen, otsikon, arvosanan ja korostuksen muutokset säilyvät sen historiassa
testimonials_update
Vain lähetetyt syötteet muuttuvat. Muutos kenttään body, title, rating tai highlight lisää historiaan version kentän edit_note kanssa, eikä se koskaan muuta vahvistettua merkintää. rating null tyhjentää sen. highlight on oltava tarkka osa sanoista, ja tyhjä arvo tyhjentää sen. properties muuttaa vain lähetetyt avaimet. add_tags ja remove_tags ottavat nimiä tai tunnisteita. Tilalla, kiinnityksellä ja roskakorilla on omat työkalunsa. Roskakorissa olevaa suositusta ei voi muokata.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Suositusten analytiikka
GET
/sites/:site_id/testimonials/analytics/breakdown.json
Jaa yksi suositusmittari lomakkeen, pyynnön, widgetin, seinän, suosituksen, kanavan, sivun, maan tai lähteen mukaan
testimonial_stats_breakdown
Palauttaa rivit suurin ensin, kullakin key, label, value ja share (prosentti kokonaismäärästä) tai numerator ja denominator osuudelle. Tietueen (lomake, pyyntö, widget, seinä, suositus) rivillä on sen tunniste. Kukin ulottuvuus hyväksyy vain joitakin mittareita: form ja channel lomakemittarit, request pyyntömittarit, widget ja wall omat katselunsa, klikkauksensa, klikkausosuutensa ja video_plays, testimonial hyväksyy testimonial_views ja video_plays, page ja country katselu- ja klikkausmittarit ja source hyväksyy new_testimonials. Pari, joka ei sovi, vastaa 422:lla ja nimeää mittarit, jotka sopivat.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/analytics/breakdown.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/testimonials/analytics/export.json
Jonota tiedosto yhdestä suositusanalytiikan osiosta
testimonial_stats_export
Luo viennin lajia testimonial_stats annetulle jaksolle ja palauttaa sen jonotettuna. Kysele exports_get kunnes tila on complete, sitten exports_download. section valitsee rivit: days (yksi rivi päivää, viikkoa tai kuukautta kohden kaikkine mittareineen), forms, channels, requests, widgets, walls, pages, testimonials, sources tai countries. Tiedostoa säilytetään 7 päivää. Vastaa 422 in_progress, kun liian monta vientiä on jo jonossa.
Oikeus: analytics.export
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
Lue sivuston suositusanalytiikka yhdellä kutsulla
testimonial_stats_overview
Palauttaa kaiken, mitä Suositukset-kohdan Analytiikka-välilehti näyttää jaksolta: kortit (form_views, submissions, completion_rate, answer_rate, widget_views, wall_views, kullakin previous ja change, kun compare on asetettu), kaavio (yksi mittari ajan yli), rivi jokaiselle lomakkeelle, pyynnölle, widgetille ja seinälle, channels (miten lomakkeet avattiin), pages (missä widgettejä ja seiniä nähtiin), top_testimonials, new_testimonials (lähteen ja nykyisen tilan mukaan) ja countries. Osuudet ovat prosentteja 0:sta 100:aan ja null, kun ei ole mitään, millä jakaa. blank on true, kun sivusto ei ole koskaan laskenut mitään, ja recorded listaa mittarit, jotka se on koskaan laskenut. Nämä ovat suositusominaisuuden päivittäisiä kokonaismääriä, eivät verkkoanalytiikkaa: käytä kutsua stats_overview kävijöille ja sivunäytöille.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/analytics.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/testimonials/analytics/timeseries.json
Lue yksi suositusmittari päivää, viikkoa tai kuukautta kohden
testimonial_stats_timeseries
Palauttaa pisteet kentillä date, to, value ja, kun compare on asetettu, previous ja previous_date sekä total, previous_total ja change. Osuus (completion_rate, answer_rate, widget_click_rate, wall_click_rate) lasketaan kunkin jakson kokonaismääristä ja on null jaksolle, jossa ei ole mitään, millä jakaa. new_testimonials lasketaan itse suosituksista sen päivän mukaan, jona kukin lisättiin.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/analytics/timeseries.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Suositusten brändipaketti
DELETE
/sites/:site_id/testimonials/settings/brand_kit.json
Palauta sivuston suositusten brändipaketti Privatus Analyticsin oletuksiin
testimonial_brand_kit_reset
Tyhjentää jokaisen värin, fontin, pyöristyksen, arvostelutyylin, logot ja oman CSS:n yhdellä kertaa, ja jokainen lomake, widget ja seinä muuttuu sen mukana. Sitä ei voi perua, joten avustaja ohjataan Brändipaketti-sivulle sen suorittamisen sijaan.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Hae sivuston suositusten brändipaketti jokaisen värin ratkaistuna vaaleaan ja tummaan tilaan
testimonial_brand_kit_get
Palauttaa värit, fontit, kulmien pyöristyksen, arvostelutyylin, logot, merkin kytkimen ja oman CSS:n, joilla sivuston jokainen lomake, widget ja seinä piirretään. Asetus, jota ei ole koskaan muutettu, palautuu Privatus Analyticsin oletuksella.
Oikeus: analytics.read
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
Muuta sivuston suositusten brändipakettia
testimonial_brand_kit_update
Vain lähettämäsi syötteet muuttuvat. Lähetä tyhjä merkkijono palauttaaksesi yhden asetuksen Privatus Analyticsin oletukseen. Oma CSS tarkistetaan tallennettaessa, ja kaikki kielletty hylätään sen rivin kanssa, jolla se on. Oma CSS vaatii Business-paketin ja merkin piilottaminen vaatii Business-paketin. Ilman sitä palvelin vastaa 402 plan_limit.
Oikeus: sites.manage
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 '{…}'
Suositusten henkilöt
POST
/sites/:site_id/testimonials/people/:id/ask_again.json
Aloita pyyntö, jossa tämä henkilö on ainoa vastaanottaja
testimonial_people_ask_again
Se käyttää lomaketta, jota hän viimeksi käytti, tai aloituslomaketta. Mitään ei lähetetä ennen kuin pyyntö lähetetään. Palvelin vastaa 422:lla ja koodilla no_email, bounced tai unsubscribed, kun henkilöltä ei voi kysyä, ja requests_unavailable, kun pyynnöt eivät ole käytettävissä.
Oikeus: content.write
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
Lisää henkilö sivustolle
testimonial_people_create
name on pakollinen (enintään 120 merkkiä). email ei näy koskaan julkisesti: se ryhmittelee myöhemmät suositukset tämän henkilön alle ja antaa sivuston kysyä häneltä uudelleen, ja osoite, joka sivuston toisella henkilöllä jo on, hylätään. avatar_media_id on sivustolle jo ladatun kuvan tunniste (med_...). Henkilön lisääminen ei lisää suositusta.
Oikeus: content.write
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
Poista henkilö pysyvästi kaikkine sanomisineen, tiedostoineen ja kysymyshistorioineen
testimonial_people_delete_permanently
Poistopyyntöä varten. Tätä ei voi perua. Se vaatii kentän confirm, henkilön nimen tai tunnisteen, ja jättää yhden auditointimerkinnän, jossa ei ole nimeä eikä sanoja.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Listaa sivuston henkilöt suodatettuina ja lajiteltuina
testimonial_people_list
Jokaisella henkilöllä on suositusten määrä, montako niistä on hyväksytty, keskimääräinen arvosana ja viimeisin pyyntö tuloksineen. Sähköposti on null, ellei kutsujalla ole oikeutta content.write, ja has_email kertoo silti, onko sellainen tallennettu.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/people.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/testimonials/people/:id/merge.json
Yhdistä saman henkilön muut tietueet tähän
testimonial_people_merge
Polussa oleva henkilö säilyy. Kaikki, mitä muut ovat sanoneet, ja jokainen heille lähetetty pyyntö siirtyy tälle, ja muut poistetaan. Tämän henkilön tyhjä kenttä täytetään muilta, vanhin ensin, ja use nimeää ne, joiden arvo voittaa kentässä. Vastaus sisältää kohdan meta.undo_id, jonka testimonial_undo_records_undo hyväksyy 7 päivän ajan.
Oikeus: content.write
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
Hae yksi henkilö, se mitä häneltä on kysytty, ja samalta henkilöltä näyttävät henkilöt
testimonial_people_get
Hänen suosituksensa ovat testimonials_list kentällä person_id. can_ask ja cannot_ask_reason kertovat, menisikö testimonial_people_ask_again läpi.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/people/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/testimonials/people/:id.json
Muokkaa henkilöä. Vain lähetetyt kentät muuttuvat
testimonial_people_update
Tyhjä arvo tyhjentää kentän, nimeä lukuun ottamatta. Sähköposti, joka sivuston toisella henkilöllä jo on, hylätään. Yrityssivu, jolla henkilö on listattuna, seuraa yrityksen nimeä ja verkkosivustoa.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/people/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Suositusten kaksoiskappaleet
POST
/sites/:site_id/testimonials/duplicates/dismiss.json
Kerro, että ryhmä ei ole kaksoiskappaleita. Se ei koskaan palaa jonoon
testimonial_duplicates_dismiss
testimonial_ids on oltava kaikki kopiot yhdestä avoimesta kaksoiskappalejonon ryhmästä, joka ei ole roskakorissa, sellaisina kuin testimonial_duplicates_list ne palauttaa. Mitään ei yhdistetä tai muuteta suosituksissa, eikä niitä koskaan ryhmitellä uudelleen yhteen. Jaa kolmen ryhmä yhdistämällä ensin kaksi samaa. Palvelin vastaa 422:lla, kun tunnisteet eivät ole täsmälleen yksi avoin ryhmä.
Oikeus: content.write
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
Listaa suositusryhmät, jotka ovat todennäköisesti sama suositus kahdesti
testimonial_duplicates_list
Tarkat osumat tulevat ensin. Jokainen ryhmä sisältää kopionsa kokonaisina ja keeper_id, säilytettävän kopion. meta.exact_groups on se, kuinka monta ryhmää testimonial_duplicates_merge_exact yhdistäisi.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/duplicates.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/testimonials/:id/merge.json
Yhdistä suosituksen kopiot polussa olevaan
testimonials_merge
Säilytettävä suositus pitää tilansa ja vahvistetun tilansa sekä sanansa, ellei body_from nimeä toista kopiota. Se saa puuttuvat tunnisteet, manuaaliset kokoelmat, sijoitukset ja mukautetut ominaisuudet. Kopiot siirtyvät roskakoriin yhdistetyiksi merkittyinä, ja yhden palauttaminen kumoaa yhdistämisen kyseiselle kopiolle. Tässä kuussa saapunut kopio lakkaa lasketuksi uudeksi suositukseksi. Vastaus sisältää kohdan meta.undo_id.
Oikeus: content.write
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
Yhdistä jonon jokainen tarkka osuma kerralla
testimonial_duplicates_merge_exact
Lähetä ensin dry_run lukumääriä varten, sitten confirm_count sen antamalla kokonaismäärällä. Enintään 100 ryhmää yhdistetään kutsua kohden. Vastaus sisältää kohdan meta.undo_id, ja yksi kumoaminen peruu koko ajon.
Oikeus: content.write
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 '{…}'
Suositusten kielet
GET
/sites/:site_id/testimonials/settings/languages.json
Hae sivuston suositusten kieliasetukset
testimonial_languages_get
Oletuskieli, tarjotut kielet, käännetäänkö vasta hyväksytyt suositukset automaattisesti, sisältääkö paketti käännöksen, onko käännös otettu käyttöön sekä kuukauden käytetyt ja jäljellä olevat merkit.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/settings/languages.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/testimonials/settings/languages.json
Aseta oletuskieli, tarjotut kielet ja automaattinen käännös
testimonial_languages_update
Lähetä vain se, mikä muuttuu. Oletus on aina tarjottujen kielten joukossa, eikä kieltä, jolla lomake on kirjoitettu, voi poistaa (in_use). auto_translate-asetuksen kytkeminen päälle vaatii Business-paketin tai ylemmän (402 plan_limit muualla): siitä lähtien jokaisen vasta hyväksytyn suosituksen sanat lähetetään Google Cloud Translationille, ja jäsenelle kerrotaan sähköpostilla, että avustaja muutti tämän.
Oikeus: sites.manage
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/settings/languages.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Suositusten kokoelmat
POST
/sites/:site_id/testimonials/collections/:id/items.json
Lisää suosituksia manuaaliseen kokoelmaan
testimonial_collections_add_items
Enintään 100 kerralla. Ne liittyvät loppuun tai alkuun position top -arvolla annetussa järjestyksessä. Vastaus sisältää kohdan meta.undo_id, jonka testimonials_bulk_undo hyväksyy 7 päivän ajan. Älykäs kokoelma ei ota mitään käsin.
Oikeus: content.write
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
Luo kokoelma, manuaalinen tai älykäs
testimonial_collections_create
kind manual kootaan käsin, ja testimonial_ids aloittaa sen täytettynä. kind smart pidetään ajan tasalla ehdoilla: kentän, operaattorin ja arvon rivit yhdistettynä kentällä match. Vastaus sisältää lukumäärän ja säännöt selkeällä kielellä, joten yksi kutsu muuttaa lauseen elävaksi kokoelmaksi. Kokeile sääntöjä ensin kutsulla testimonial_collections_preview. Laji ei koskaan muutu jälkeenpäin.
Oikeus: content.write
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
Siirrä kokoelma roskakoriin 30 päiväksi
testimonial_collections_destroy
Sen suosituksia ei kosketa. Sen syöttämä widget tai seinä ei näytä siitä mitään ennen kuin se palautetaan. Palauta se kutsulla testimonial_trash_restore. MCP:n kautta työkalu ei muuta mitään ja vastaa sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Listaa sivuston kokoelmat
testimonial_collections_list
Jokaisella kokoelmalla on sen sisältämien suositusten nykyinen määrä, montako niistä on hyväksytty, säännöt selkeällä kielellä, kun se on älykäs, sekä widgetit ja seinät, joita se syöttää. Roskakorissa olevat kokoelmat jätetään pois.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/collections.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/testimonials/collections/preview.json
Kokeile sääntöjoukkoa tallentamatta mitään
testimonial_collections_preview
Vastaa, kuinka monta suositusta vastaa juuri nyt, säännöt selkeällä kielellä ja viisi esimerkkiä. Käytä sitä ennen kutsua testimonial_collections_create tai testimonial_tags_update. Virheellinen rivi on 422, joka nimeää rivin.
Oikeus: analytics.read
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
Ota suosituksia pois manuaalisesta kokoelmasta
testimonial_collections_remove_items
Enintään 100 kerralla. Itse suosituksia ei muuteta. Vastaus sisältää kohdan meta.undo_id, ja kumoaminen palauttaa jokaisen paikalleen.
Oikeus: content.write
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
Siirrä yksi suositus toiseen paikkaan manuaalisessa kokoelmassa
testimonial_collections_reorder
Nimeä paikka täsmälleen yhdellä kentistä position (lasketaan 1:stä), before_id tai after_id. Järjestys on se, jossa kokoelman syöttämät widgetit ja seinät sen saavat.
Oikeus: content.write
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
Hae yksi kokoelma lukumäärineen, sääntöineen ja syötettävine kohteineen
testimonial_collections_get
Sen suositukset ovat testimonials_list kentällä collection_id.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/collections/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/testimonials/collections/:id.json
Muuta kokoelman nimeä, kuvausta, sääntöjä tai tarjoilujärjestystä
testimonial_collections_update
Vain lähetetty muuttuu. Kentän conditions lähettäminen korvaa älykkään kokoelman jokaisen säännön. Laji on kiinteä.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/collections/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Suositusten kumoamislista
GET
/sites/:site_id/testimonials/settings/undo.json
Listaa viimeisten 7 päivän muutokset, jotka voi perua
testimonial_undo_records_list
Uusin ensin. Jokainen tietue kertoo, mitä ajettiin, kuka sen ajoi, montako se muutti ja ohitti ja miksi sekä mihin asti sen voi perua.
Oikeus: analytics.read
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
Lue yksi kumoamistietue
testimonial_undo_records_get
Taustalla ajettavalle ajolle state on running ja processed kertoo, kuinka pitkällä se on.
Oikeus: analytics.read
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
Peru joukkotoiminto tai yksittäinen muutos 7 päivän kuluessa
testimonial_undo_records_undo
Palauttaa aiemman arvon kaikkeen, mitä ajo muutti. Se, mitä on sen jälkeen muutettu uudelleen, jätetään rauhaan ja lasketaan kenttään left. Henkilöiden tai kaksoiskappaleiden yhdistäminen perutaan samalla tavalla. MCP:n kautta kumoamista, joka poistaisi tai siirtäisi roskakoriin, ei suoriteta (palautuksen, käännösajon ja kuvantekoajon kumoaminen): työkalu vastaa koodilla human_only ja sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: content.write
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 '{…}'
Suositusten kuvat
POST
/sites/:site_id/testimonials/images/bulk.json
Tee kuvat kokoelman jokaisesta hyväksytystä suosituksesta
testimonial_images_bulk_create
Enintään 200 suositusta ajolla, yksi kuva kokoa kohden kustakin. Kuvaan liian pitkä teksti piirretään sen korostuksesta tai muuten sen alkulauseista (excerpted kertoo, kuinka monta). Vastaus listaa aloitetut kuvat, pois jätetyt suositukset syineen ja export_id: yksi PNG-tiedostojen zip ilmestyy Viennit-sivulle, kun ne on piirretty.
Oikeus: content.write
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
Tee kuvia yhdestä hyväksytystä suosituksesta, yksi kokoa kohden
testimonial_images_create
Vain hyväksytty suositus voidaan piirtää, koska PNG saa julkisen osoitteen: muu hylätään koodilla not_approved. Jokainen kuva alkaa tilassa rendering ja piirretään taustalla. Vastaus on lista aloitetuista kuvista. Kysele testimonial_images_get kentän file_url saamiseksi. 422 ja text_too_long tarkoittaa, että sanat eivät mahdu: käytä text_mode highlight tai excerpt tai korkeampaa kokoa.
Oikeus: content.write
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
Poista kuva ja sen tiedosto
testimonial_images_delete
PNG poistetaan mediapalvelimelta ja sen osoite lakkaa toimimasta. Kuvalla ei ole roskakoria. Se voidaan tehdä uudelleen suosituksestaan kutsulla testimonial_images_create. MCP:n kautta työkalu ei muuta mitään ja vastaa sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Listaa sivuston kuvat
testimonial_images_list
Hyväksytyistä suosituksista tehdyt kuvat uusin ensin, 25 sivulla. Suodata tilan, pohjan, koon tai kentän testimonial_id mukaan. Jokaisella on file_url, kun se on valmis.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/images.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/testimonials/images/:id.json
Hae yksi kuva tiloineen ja sen PNG:n osoite
testimonial_images_get
status on rendering, ready tai failed. file_url asetetaan, kun se on valmis. Kysele tätä kutsun testimonial_images_create jälkeen, kunnes status ei enää ole rendering.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/images/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/testimonials/images/:id.json
Muuta kuvan piirtotapaa ja renderöi se uudelleen
testimonial_images_update
Lähetä vain se, mikä muuttuu. Ilman mitään se renderöi saman kuvan uudelleen suosituksesta sellaisena kuin se nyt on, mikä on myös tapa yrittää epäonnistunutta uudelleen. Uudella renderöinnillä on uusi file_url, ja vanha tiedosto poistetaan.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/images/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Suositusten käännökset
POST
/sites/:site_id/testimonials/translations.json
Käännä suosituksia kielille, joita sivusto tarjoaa
testimonial_translations_create
Kutsu ensin testimonial_translations_estimate. Tämä lähettää valittujen suositusten rungon, otsikon ja korostuksen Google Cloud Translationille (ei koskaan nimeä, sähköpostia tai yritystä), ja jäsenelle kerrotaan sähköpostilla, että avustaja käynnisti sen. Kääntäminen tapahtuu taustalla, eikä jo tallennettua riviä koskaan haeta uudelleen. Kuukauden merkkikiintiössä loput tallennetaan odottamaan ja jatkuvat 1. päivänä. Vastaa 402 plan_limit Business-paketin alapuolella ja 422 not_configured, kun käännöstä ei ole otettu käyttöön.
Oikeus: content.write
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
Poista yksi tallennettu käännös
testimonial_translations_delete
Suositus näytetään taas omilla sanoillaan kaikkialla, missä kyseistä kieltä käytettiin. Siihen jo käytettyjä merkkejä ei palauteta. Toimii jokaisessa paketissa. MCP:n kautta työkalu ei muuta mitään ja vastaa sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Laske merkit, jotka käännösajo lähettäisi, ennen sen ajamista
testimonial_translations_estimate
Kerro suositukset yhdellä tavalla: testimonial_ids, collection_id tai all_approved. Vastaus antaa suositukset, lähetettävät merkit, jo tallennetut merkit ja sen, mitä kuukaudesta on jäljellä. Se ilmoittaa merkit, ei koskaan hintaa. Mitään ei haeta.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/translations/estimate.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/testimonials/translations.json
Listaa sivuston tallennetut käännökset
testimonial_translations_list
Yksi rivi suositusta ja kieltä kohden, viimeksi muutettu ensin, 25 sivulla. Suodata kielen, tilan, alkuperän tai kentän testimonial_id mukaan. Toimii jokaisessa paketissa, joten ennen paketin alennusta tehdyt käännökset voi edelleen lukea.
Oikeus: analytics.read
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
Kirjoita tai korjaa yksi käännös käsin
testimonial_translations_update
Rivi merkitään muokatuksi, eikä myöhempi ajo korvaa sitä, ellei overwrite_edited lähetetä. Mitään ei haeta eikä mitään lasketa kiintiöön. Alkuperäistä ei koskaan muuteta. Business-paketista ylöspäin (402 plan_limit muualla).
Oikeus: content.write
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 '{…}'
Suositusten maininnat
GET
/sites/:site_id/testimonials/mentions.json
Listaa sivuston suosituksissa toistuvat sanat ja ilmaukset
testimonial_mentions_list
Jokaisella termillä on sen sisältävien suositusten määrä, osuus, niiden keskimääräinen arvosana sekä viimeiset 90 päivää verrattuna edeltäviin 90 päivään. Lajittele rating_asc-arvolla lukeaksesi, mistä ihmiset valittavat, tai rising-arvolla nähdäksesi mikä on uutta. meta.refreshed_at kertoo, milloin termit rakennettiin viimeksi uudelleen. Anna termi kutsulle testimonials_list kentällä mention lukeaksesi suositukset.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/mentions.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/testimonials/mentions/tag.json
Lisää tunniste jokaiseen suositukseen, joka mainitsee sanan tai ilmauksen
testimonial_mentions_tag
Yksi joukkotoiminto koko tulokselle kumoamismahdollisuudella. Termi on mikä tahansa sana tai kahden sanan ilmaus, joka täsmätään sanavartaloilla samalla tavalla kuin maininnat lasketaan. Ensimmäistä kertaa nimetty tunniste luodaan. Vastaa kumoamistunnisteella, jonka testimonials_bulk_undo hyväksyy 7 päivän ajan. Yli 100 suoritetaan taustalla.
Oikeus: content.write
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
Piilota termi, joka on pelkkää kohinaa, tai näytä se uudelleen
testimonial_mentions_update
Piilotettu termi poistuu Maininnat-listalta ja Saapuneet-näkymän Maininnat-facetista, ja pysyy piilossa, kun termit rakennetaan uudelleen.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/mentions.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Suositusten media
POST
/sites/:site_id/testimonials/media/uploads.json
Aloita lataus tai lisää tiedosto verkko-osoitteesta
testimonial_media_uploads_create
Kaksi tapaa. Lataa lähettämällä filename, content_type ja byte_size: vastaus sisältää kentän upload, jossa on url, johon tiedosto PUT-lähetetään, mukana lähetettävät otsakkeet ja suurelle tiedostolle parts, jotka voi lähettää yksi kerrallaan. Kutsu sitten testimonial_media_uploads_finish. Tai lähetä source_url, jolloin tiedosto ladataan ja käsitellään puolestasi: kysele testimonial_media_get kunnes sen tila on ready. Rajat: video ja ääni enintään 500 Mt ja niin pitkä kuin paketti sallii (2 minuuttia Pro-paketissa, 10 minuuttia Business-paketissa, ei lainkaan Free-paketissa, jossa palvelin vastaa 402 plan_limit), kuvat enintään 10 Mt, logo enintään 2 Mt.
Oikeus: content.write
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
Poista tiedosto, jota mikään suositus ei säilytä
testimonial_media_delete
Suositukseen kuuluva tiedosto poistetaan suosituksen mukana roskakorin kautta. Tallennetut tiedostot poistetaan ja niiden osoitteet tyhjennetään välimuistista.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Kerro, että lataus on valmis, jotta tiedosto tarkistetaan ja käsitellään
testimonial_media_uploads_finish
Kutsu sitä, kun tiedosto on lähetetty. Tiedoston on oltava latausvarastossa ja täsmälleen luvatun kokoinen. Sen kutsuminen kahdesti on turvallista.
Oikeus: content.write
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
Yritä epäonnistunutta tiedostoa uudelleen
testimonial_media_retry
Käsittelee tiedoston uudelleen säilytetystä latauksesta. Lataus säilytetään 24 tuntia epäonnistumisen jälkeen. Sen jälkeen palvelin vastaa not_retryable ja tiedosto on ladattava uudelleen.
Oikeus: content.write
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
Hae yksi tiedosto tiloineen ja latausosoitteineen
testimonial_media_get
url on valmiin tiedoston pysyvä osoite mediapalvelimella, ja se on null kunnes tila on ready. Osoite on sama kaikille eikä ole allekirjoitettu, joten välitä vain sellaisen tiedoston osoite, jonka shareable-kenttä on true.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/media/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Suositusten mukautetut ominaisuudet
POST
/sites/:site_id/testimonials/settings/properties.json
Lisää mukautettu ominaisuus sivustolle
testimonial_properties_create
Sivustolla voi olla enintään 20 aktiivista ominaisuutta. Avain on kiinteä luomisen jälkeen, koska lomakelinkit, säännöt ja API käyttävät sitä. Jätä se pois, niin se ehdotetaan nimiön perusteella.
Oikeus: sites.manage
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
Poista mukautettu ominaisuus ja sen arvot pysyvästi
testimonial_properties_destroy
Tätä ei voi perua. Se poistaa ominaisuuden ja sen arvon jokaisesta suosituksesta. confirm on avain. Älykkään kokoelman tai automaattisen tunnisteen säännön käyttämää ominaisuutta ei voi poistaa, kun ne sitä käyttävät. Arkistointi on tavallinen tapa luopua yhdestä.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Listaa sivuston mukautetut ominaisuudet näyttöjärjestyksessä
testimonial_properties_list
Jokainen kertoo avaimensa, tyyppinsä ja vaihtoehtonsa, montako suositusta sisältää arvon (filled), voiko sen tyyppiä vielä muuttaa ja mitkä älykkäät kokoelmat ja automaattisen tunnisteen säännöt sitä käyttävät.
Oikeus: analytics.read
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
Muuta, järjestä uudelleen, arkistoi tai palauta mukautettu ominaisuus
testimonial_properties_update
Vain lähettämäsi syötteet muuttavat jotain. Vaihtoehdon uudelleennimeäminen nimeää sen uudelleen jokaisessa suosituksessa, jossa se on. Älykkään kokoelman tai automaattisen tunnisteen säännön käyttämää ominaisuutta ei voi arkistoida, kun ne sitä käyttävät.
Oikeus: sites.manage
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 '{…}'
Suositusten mukautetut verkkotunnuspyynnöt
POST
/sites/:site_id/testimonials/settings/custom_domain.json
Pyydä mukautettua verkkotunnusta seinälle tai lomakkeille
testimonial_custom_domain_requests_create
Suositusten mukautetut verkkotunnukset ottaa käyttöön Privatus Analyticsin tiimi käsin. Tämä tallentaa pyynnön ja kertoo tiimille, joka lähettää sähköpostilla lisättävän DNS-tietueen. Isäntänimi ei toimi ennen kuin pyynnön status on active. Business-paketista ylöspäin: muut paketit saavat 402 plan_limit.
Oikeus: sites.manage
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
Peru mukautetun verkkotunnuksen pyyntö sen isäntänimellä
testimonial_custom_domain_requests_delete
Vain pyynnön, jota tiimi ei ole aloittanut (status requested), voi perua. Käynnissä oleva vastaa wrong_state. MCP:n kautta työkalu ei muuta mitään ja vastaa sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Listaa sivuston mukautetut verkkotunnuspyynnöt
testimonial_custom_domain_requests_list
Jokainen seinän tai lomakkeiden isäntänimipyyntö uusin ensin tiloineen. Isäntänimi toimii vasta, kun status on active. Toimii jokaisessa paketissa, joten aiemmat pyynnöt voi edelleen lukea.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/settings/custom_domain.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Suositusten ostoyhteydet
DELETE
/sites/:site_id/testimonials/settings/purchase_connections/:id.json
Irrota maksutili
testimonial_purchase_connections_delete
Poistaa yhteyden ja sen avaimen. Ostajilta, jotka odottavat vielä ensimmäistä sähköpostiaan, ei kysytä. Pysyvä pyyntö säilyy lähetetyn tietueena.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Listaa sivuston ostoyhteydet
testimonial_purchase_connections_list
Kullakin sääntö, tila ja pysyvä pyyntö. Avainta ei koskaan palauteta. paused on true paketissa, jossa ei ole ostoksen jälkeisiä pyyntöjä: yhteys säilytetään, se ei lue maksuja eikä kysy keneltäkään.
Oikeus: sites.manage
curl https://privatusanalytics.com/sites/:site_id/testimonials/settings/purchase_connections.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Suositusten pyynnöt
POST
/requests/resubscribe/:token.json
Vahvista suosituspyyntöjen vastaanottaminen uudelleen
testimonial_request_resubscribes_confirm
Vahvistussivun painikkeen takana oleva POST. Se poistaa kieltäytymisen, joten osoitteelta voi taas kysyä.
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/requests/resubscribe/:token.json \
-H "Content-Type: application/json" -d '{…}'
POST
/requests/resubscribe.json
Pyydä sähköposti, jolla osoite saa taas vastaanottaa pyyntöjä
testimonial_request_resubscribes_create
Lähettää vahvistussähköpostin osoitteeseen itseensä, kun se oli perunut tilauksen. Vastaus on sama, oli se perunut tai ei.
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/requests/resubscribe.json \
-H "Content-Type: application/json" -d '{…}'
POST
/requests/unsubscribe/:token.json
Peru osoitteen tilaus suosituspyynnöistä
testimonial_request_unsubscribes_create
Peruutussivun painikkeen takana oleva POST ja se, mitä sähköpostisovelluksen oma peruutuspainike kutsuu. Tunniste tulee sähköpostin linkistä.
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/requests/unsubscribe/:token.json \
-H "Content-Type: application/json" -d '{…}'
POST
/sites/:site_id/testimonials/requests.json
Aloita pyyntö luonnoksena
testimonial_requests_create
Luo luonnoksen sähköposteineen ja vastaanottajineen. Mitään ei lähetetä ennen kutsua testimonial_requests_send. Pois jätetty alkaa oletuksesta: sähköposti, yksi seurantaviesti 5 päivän kuluttua, sivuston nimi lähettäjänä ja sinä vastausosoitteena. Jokainen vastaanottaja tallennetaan tilassa queued tai skipped syyn kanssa.
Oikeus: content.write
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
Poista luonnos
testimonial_requests_delete
Vain pyyntö, jota ei ole koskaan lähetetty, voidaan poistaa. Lähetetty pyyntö säilytetään lähetetyn postin tietueena. MCP:n kautta työkalu ei muuta mitään ja vastaa sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Kopioi pyyntö uudeksi luonnokseksi
testimonial_requests_duplicate
Kopiossa on sama lomake ja sähköposti, eikä vielä vastaanottajia.
Oikeus: content.write
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
Listaa sivuston pyynnöt
testimonial_requests_list
Uusin ensin, kullakin sähköposti ja suppilon lukumäärät. Suodata tilan, lomakkeen tai jakson mukaan.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/requests.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/testimonials/requests/:id/preview.json
Katso yksi pyynnön sähköposti sellaisena kuin sen ensimmäinen vastaanottaja sen saa
testimonial_requests_preview
Lähettäjä, aihe ja runko yhdistämiskenttineen täytettyinä. Mitään ei lähetetä. step 0 on ensimmäinen sähköposti, 1-3 seurantaviestit.
Oikeus: analytics.read
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
Jatka pysäytettyä pyyntöä
testimonial_requests_resume
Jatkaa siitä, mihin se pysähtyi. Seurantaviesti, joka erääntyi pysäytyksen aikana, ajoitetaan uudelleen tästä hetkestä, joten mitään ei lähde kerralla. Tämä lähettää sähköpostia työtilan ulkopuolisille, joten jäsenelle kerrotaan sähköpostilla, että avustaja jatkoi sitä.
Oikeus: content.write
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
Lähetä pyyntö nyt tai tiettynä aikana
testimonial_requests_send
Vaatii kentän confirm_relationship: true. Jonossa olevat vastaanottajat tarkistetaan vielä kerran, sitten ensimmäiset sähköpostit lähtevät (tai odottavat kenttää send_at). Seurantaviestit lähtevät ihmisille, jotka eivät ole vastanneet. Pyyntöviestit lähetetään sivuston oman sähköpostipalvelun kautta (Asetukset > Sähköpostilähetys, Business-paketista ylöspäin), joten sivusto, jolla ei ole toimivaa yhteyttä, saa 422 no_email_connection tai email_connection_paused, ja toinen paketti saa 402 plan_limit. Jokainen sähköposti lasketaan sivuston kuukausittaiseen pyyntöviestien rajaan (10 000, ellemme aseta toista). Rajalla mitään ei pudoteta: ihmiset pysyvät jonossa ja lähetys jatkuu 1. päivänä. Tämä lähettää sähköpostia työtilan ulkopuolisille, joten jäsenelle kerrotaan sähköpostilla, että avustaja lähetti sen.
Oikeus: content.write
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
Lähetä yksi pyynnön sähköposti omaan osoitteeseesi
testimonial_requests_send_test
Menee vain kutsujan omaan osoitteeseen, sivuston oman sähköpostipalvelun kautta kuten oikeat viestit (422 no_email_connection ilman sitä). Siinä ei ole henkilökohtaista linkkiä eikä avauslaskuria, eikä sitä lasketa sivuston kuukausittaiseen rajaan.
Oikeus: content.write
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
Hae yksi pyyntö sähköposteineen, seurantaviesteineen ja suppilon lukumäärineen
testimonial_requests_get
Palauttaa yhden pyynnön sähköpostin, seurantaviestit, tilan ja suppilon lukumäärät (sent, opened, clicked, submitted, bounced, unsubscribed).
Oikeus: analytics.read
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
Pysäytä pyyntö
testimonial_requests_stop
Peruu heti jokaisen vielä lähettämättömän sähköpostin. Jo lähetettyyn ei vaikuteta, ja testimonial_requests_resume jatkaa siitä, mihin se pysähtyi.
Oikeus: content.write
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
Muuta pyynnön nimeä, lomaketta tai sähköpostia
testimonial_requests_update
Sallittu milloin tahansa. Muutos koskee jokaista vielä lähettämätöntä sähköpostia. Seurantaviestin viiveen muuttaminen ajoittaa odottavat seurantaviestit uudelleen.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/requests/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Suositusten pyyntöjen vastaanottajat
POST
/sites/:site_id/testimonials/requests/:request_id/recipients.json
Lisää ihmisiä pyyntöön
testimonial_request_recipients_create
Enintään 500 yhdellä kutsulla. Luonnokseen lisätyt odottavat kutsua testimonial_requests_send. Käynnissä olevaan pyyntöön lisätyt saavat ensimmäisen sähköpostinsa heti. Vastaus kertoo, kuinka monta jonotettiin ja kuinka monta ohitettiin syyn mukaan. Käynnissä olevaan pyyntöön lisääminen lähettää sähköpostia työtilan ulkopuolisille, joten jäsenelle kerrotaan sähköpostilla.
Oikeus: content.write
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
Poista valitut henkilöt pyynnöstä
testimonial_request_recipients_delete
Vain ihmiset, joille ei ole lähetetty mitään (queued tai skipped). Ottaa rungossa enintään 100 osoitetta. MCP:n kautta työkalu ei muuta mitään ja vastaa sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Lisää ihmisiä pyyntöön CSV-tiedostosta
testimonial_request_recipients_import
Kaksi kutsua. Lähetä tiedosto (tai sen teksti kentässä csv) saadaksesi sarakkeet, niiden ensimmäiset rivit ja upload_token. Lähetä sitten yhdistäminen sarakenumerosta kenttään. Enintään 5 Mt ja 10 000 riviä. Käynnissä olevaan pyyntöön lisääminen lähettää sähköpostia työtilan ulkopuolisille, joten jäsenelle kerrotaan sähköpostilla.
Oikeus: content.write
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
Listaa pyynnön henkilöt
testimonial_request_recipients_list
Suodata sen mukaan, missä henkilö nyt on: tila opened on "avasi eikä klikannut tai vastannut". Sähköpostiosoite on null, ellei kutsuja saa muokata sisältöä.
Oikeus: analytics.read
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
Jatka valittuja pyynnön henkilöitä
testimonial_request_recipients_resume
He jatkavat siitä, mihin pysähtyivät. Ottaa rungossa enintään 100 osoitetta. Tämä lähettää sähköpostia työtilan ulkopuolisille, joten jäsenelle kerrotaan sähköpostilla.
Oikeus: content.write
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
Pysäytä valitut pyynnön henkilöt
testimonial_request_recipients_stop
He eivät saa enää sähköposteja. Jokainen säilyttää tilansa ja saa lisäksi tilan "stopped". Ottaa rungossa enintään 100 osoitetta.
Oikeus: content.write
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 '{…}'
Suositusten roskakori
DELETE
/sites/:site_id/testimonials/trash/permanent.json
Poista enintään 100 roskakorissa olevaa kohdetta pysyvästi
testimonial_trash_delete_permanently
Tätä ei voi perua. confirm on kohteen nimi (suosituksen kohdalla henkilön nimi) tai sen tunniste yhdelle kohteelle ja sivuston nimi usealle. Vain roskakorissa olevat kohteet hyväksytään.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Poista kaikki roskakorissa oleva pysyvästi
testimonial_trash_empty
Tätä ei voi perua. confirm on sivuston nimi. Enintään 100 kohdetta poistetaan kerralla. Suurempi roskakori tyhjennetään taustalla, ja vastauksessa on tila running.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Listaa roskakorissa oleva, yksi laji kerrallaan
testimonial_trash_list
Vastaa yhden lajin kohteilla (oletuksena suositus) ja kohdassa meta.counts kertoo, montako jokaista lajia on roskakorissa. Jokainen kohde kertoo, mihin se palaa, mikä sitä näytti, kuka sen siirsi roskakoriin ja milloin se poistuu.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/trash.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/testimonials/trash/restore.json
Palauta enintään 100 kohdetta roskakorista täsmälleen entiselleen
testimonial_trash_restore
Tunnisteiden on oltava yhtä lajia. Suositusten palauttaminen vastaa kumoamistunnisteella (data.id ja meta.undo_id), jonka testimonial_undo_records_undo hyväksyy 7 päivän ajan. Palautusta ei koskaan lasketa uudeksi suositukseksi.
Oikeus: content.write
curl -X POST https://privatusanalytics.com/sites/:site_id/testimonials/trash/restore.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Suositusten siirrot
POST
/sites/:site_id/testimonials/imports/migrations/:id/discard.json
Hylkää siirron lukema
testimonial_migrations_discard
Anna item_ids (tunnisteet kohdasta testimonial_migrations_review) tai all true kaikelle edelleen odottavalle, ei koskaan molempia. Hylätty kohde poistuu tarkistusvaiheesta ja henkilöstä luettu poistetaan. Yhtään suositusta ei poisteta. Muuten palvelin vastaa 422:lla ja koodilla selection tai unknown_ids.
Oikeus: content.write
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
Listaa sivuston siirrot
testimonial_migrations_list
Uusin ensin. Siirto on yksi toisen suosituskäyttökohteen vientitiedosto. Jokaisella on työkalu, josta se tuli, tila ja montako suositusta löytyi, säilytettiin, oli kaksoiskappaleita ja epäonnistui.
Oikeus: analytics.read
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
Säilytä siirron lukema suosituksina
testimonial_migrations_keep
Anna item_ids (enintään 100 kutsua kohden, kohdasta testimonial_migrations_review) tai all true, ei koskaan molempia. Jokaisesta säilytetystä kohteesta tulee suositus tilalla pending tai approved, ja keep_approval true säilyttää hyväksynnän, joka sillä oli toisessa työkalussa. Kentän all kanssa todennäköiset kaksoiskappaleet jätetään pois, ellei include_likely_duplicates ole true. Mikään säilytetty ei lasketa kuukauden suosituksiin. Se, mitä ei säilytetä, pysyy tarkistusvaiheessa 30 päivää.
Oikeus: content.write
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
Listaa se, minkä siirto luki ja mistä ei ole vielä päätetty
testimonial_migrations_review
Listaa kohteet, jotka odottavat edelleen päätöstä, uusin ajo ensin. show on new, duplicates tai all (oletus), ja rating säilyttää vain listatut tähtiarvosanat. Anna kohteiden tunnisteet kutsulle testimonial_migrations_keep tai testimonial_migrations_discard.
Oikeus: analytics.read
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
Hae siirron eteneminen ja lukumäärät
testimonial_migrations_get
Palauttaa työkalun, josta tiedosto tuli, tilan, montako suositusta löytyi, säilytettiin, oli kaksoiskappaleita ja epäonnistui, montako mediatiedostoa se tuo sekä milloin se alkoi ja päättyi. Kysele sitä, kun tila kertoo, että tiedostoa vielä luetaan.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/imports/migrations/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Suositusten tallennetut näkymät
POST
/sites/:site_id/testimonials/views.json
Tallenna Saapuneet-näkymän suodatin, hakuteksti, lajittelu ja asettelu nimellä
testimonial_saved_views_create
Henkilökohtainen näkymä vaatii vain oikeuden analytics.read. Jaettu vaatii oikeuden content.write ja hylätään muuten koodilla not_allowed. Kiinnitetty näkymä on sivupalkissa lukumäärän kanssa. Avaa se kutsulla testimonials_list ja view_id.
Oikeus: analytics.read
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
Poista tallennettu näkymä. Yhtään suositusta ei kosketa
testimonial_saved_views_destroy
Tallennettu näkymä on tallennettu suodatin, joten vain näkymä poistuu. Näkymän syöttämä widget tai seinä säilyttää asetuksensa eikä sillä ole mitään näytettävää ennen kuin sille annetaan toinen syöte. Henkilökohtaisen näkymän poistaa sen omistaja, ja jaettu vaatii oikeuden content.write. Muuten kutsu hylätään koodilla not_allowed. MCP:n kautta työkalu ei muuta mitään ja vastaa sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: analytics.read
· Vain HTTP (ei MCP-työkalu)
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
Listaa sivuston tallennetut näkymät, jotka kutsuja voi avata
testimonial_saved_views_list
Palauttaa kutsujan omat näkymät ja jokaisen jaetun, kiinnitetyt ensin järjestyksessään ja sitten nimen mukaan. scope on all (oletus), mine tai shared. Anna näkymän tunniste kenttänä view_id kutsulle testimonials_list lukeaksesi sen sisältämät suositukset.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/views.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/testimonials/views/:id.json
Nimeä tallennettu näkymä uudelleen, muuta sen sisältöä, kiinnitä se tai jaa se
testimonial_saved_views_update
Vain lähetetyt syötteet muuttuvat: name, tallennettu haku (q), filters, sort, layout, columns, position, pinned ja shared. Henkilökohtaisen näkymän muuttaa sen omistaja. Jaetun näkymän muuttaminen sekä minkä tahansa näkymän jakaminen tai jaon lopettaminen vaatii oikeuden content.write.
Oikeus: analytics.read
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/views/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Suositusten taulukkotuonnit
POST
/sites/:site_id/testimonials/imports/spreadsheet.json
Lataa taulukko (tai lähetä CSV-teksti) ja lue sen sarakkeet
testimonial_spreadsheet_imports_create
Taulukkotuonnin vaihe 1. Lähetä file (CSV, TSV tai XLSX, enintään 10 Mt ja 5 000 riviä, otsikot ensimmäisellä rivillä) tai content (CSV-teksti enintään 1 Mt). Vastaus sisältää sarakkeet, kolme esimerkkiarvoa kustakin ja ensimmäisen arvauksen siitä, minne kukin sarake menee. Mitään ei vielä tuoda: jatka kutsuilla testimonial_spreadsheet_imports_update ja testimonial_spreadsheet_imports_run. Taulukkoa ei koskaan lasketa kuukauden suosituksiin eikä haettuihin tuontiin.
Oikeus: content.write
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
Lue yhdistetty tiedosto tarkistusvaiheeseen
testimonial_spreadsheet_imports_run
Käyttökelpoiset rivit odottavat valintaruudun kanssa. Käyttökelvottomat rivit listataan rivinumeroineen ja syineen. Säilytä ne kutsulla testimonial_import_sources_keep käyttäen taulukon tunnistetta lähteen tunnisteena.
Oikeus: content.write
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
Hae taulukon sarakkeet, näytteet, yhdistäminen, asetukset ja lukumäärät
testimonial_spreadsheet_imports_get
Palauttaa tiedoston sarakkeet esimerkkiarvoineen, kenttä jolle kukin sarake menee, asetukset (oletustila, tunnisteet, kokoelma, päivämäärämuoto, mitä kaksoiskappaleille tapahtuu) ja ajon jälkeen montako riviä odottaa tarkistusvaiheessa ja montako säilytettiin.
Oikeus: analytics.read
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
Tallenna, mikä sarake menee minnekin, ja tiedoston asetukset
testimonial_spreadsheet_imports_update
Taulukkotuonnin vaiheet 2 ja 3. mapping on objekti, jossa sarakkeen nimi yhdistetään kenttään, ja tyhjä arvo jättää sarakkeen pois, eikä kaksi saraketta voi mennä samaan kenttään. Asetukset ovat default_status (pending tai approved), tags, collection_id (manuaalinen kokoelma), default_source_name, date_format (auto, ymd, dmy tai mdy) ja duplicates (skip tai queue). Vain lähetetty muuttuu, eikä mitään tuoda ennen kuin testimonial_spreadsheet_imports_run.
Oikeus: content.write
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 '{…}'
Suositusten tunnisteet
POST
/sites/:site_id/testimonials/tags/:id/apply_rules.json
Aja tunnisteen säännöt jo tallennettujen suositusten yli
testimonial_tags_apply_rules
dry_run true (oletus) ei muuta mitään ja vastaa lukumäärillä: montako tunnistettaisiin, kuinka monesta ja montako jo on tunnisteella. dry_run false tunnistaa ne yhtenä joukkotoimintona ja vastaa kentällä undo_id, jonka testimonials_bulk_undo hyväksyy 7 päivän ajan. Yli 100 suoritetaan taustalla, ja vastauksessa on tila running.
Oikeus: content.write
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
Luo tunniste automaattisen tunnisteen sääntöineen, jos lähetät niitä
testimonial_tags_create
Sääntö on { match, conditions }. Suositus, joka täyttää minkä tahansa yhden säännön, saa tunnisteen saapuessaan. Säännöt vain lisäävät tunnisteen. Tunnistaaksesi jo tallennetut kutsu seuraavaksi testimonial_tags_apply_rules.
Oikeus: content.write
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
Siirrä tunniste roskakoriin 30 päiväksi
testimonial_tags_destroy
Se poistuu jokaisesta suosituksesta, suodattimesta ja valitsimesta. Sen palauttaminen kutsulla testimonial_trash_restore asettaa sen takaisin jokaiseen suositukseen, jolla se oli. Älykäs kokoelma, jonka säännöt nimeävät sen, ei vastaa mihinkään siihen asti. MCP:n kautta työkalu ei muuta mitään ja vastaa sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Listaa sivuston tunnisteet sääntöineen
testimonial_tags_list
Jokaisella tunnisteella on sen sisältävien suositusten määrä, sen automaattisen tunnisteen säännöt rakenteisina ehtoina ja selkeällä kielellä sekä milloin sääntö viimeksi lisäsi sen. Roskakorissa olevat tunnisteet jätetään pois.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/tags.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/testimonials/tags/:id/merge.json
Yhdistä tunniste toiseen
testimonial_tags_merge
Jokainen suositus, jolla oli tämä tunniste, saa toisen, jokainen sääntö siirtyy toiselle, jokainen älykäs kokoelma, tallennettu näkymä, widget ja seinä, joka nimesi tämän tunnisteen, nimeää toisen, ja tämä tunniste siirtyy roskakoriin tyhjänä. Vastaa säilytettävällä tunnisteella.
Oikeus: content.write
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
Muuta tunnisteen nimeä, väriä tai sääntöjä
testimonial_tags_update
Vain lähetetty muuttuu. Sääntöjen lähettäminen korvaa tunnisteen jokaisen säännön, ja tyhjä lista poistaa ne kaikki.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/tags/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Suositusten tuontiajot
GET
/sites/:site_id/testimonials/imports/sources/:import_source_id/runs.json
Listaa lähteen ajot uusin ensin
testimonial_import_runs_list
Jokaisella ajolla on numero, sen käynnistänyt tekijä, tila, luetut sivut ja montako suositusta se löysi, montako oli uusia, kaksoiskappaleita, epäonnistuneita ja säilytettyjä sekä aloitus- ja päättymisajat.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/imports/sources/:import_source_id/runs.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Suositusten tuontilähteet
POST
/sites/:site_id/testimonials/imports/sources.json
Lisää tuontilähde linkistä ja käynnistä sen ensimmäinen ajo
testimonial_import_sources_create
Alusta tunnistetaan linkistä. Ajon löytämä odottaa tarkistusvaiheessa (testimonial_import_sources_review), eikä mitään tallenneta ennen kuin testimonial_import_sources_keep. Mikään tuotu ei lasketa kuukauden suosituksiin. Free-paketti hakee 1 tuonnin kuukaudessa arvostelusivustolta tai sivulta. Sen jälkeen vastaus on 402 plan_limit.
Oikeus: content.write
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
Poista lähde. Sen tuomat suositukset säilyvät
testimonial_import_sources_delete
Poistaa lähteen ajohistorioineen, tarkistusvaiheessa odottavine kohteineen ja ladattuine tiedostoineen. Siitä jo säilytetyt suositukset jäävät sivustoon. Henkilö tekee tämän lähteen sivulla, joten työkalu ei suorita mitään ja palauttaa sen sivun.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Hylkää löydetyt kohteet
testimonial_import_sources_discard
Anna item_ids (tunnisteet kohdasta testimonial_import_sources_review) tai all true kaikelle edelleen odottavalle, ei koskaan molempia. Hylätty kohde poistuu tarkistusvaiheesta ja henkilöstä luettu poistetaan. Yhtään suositusta ei poisteta. Muuten palvelin vastaa 422:lla ja koodilla selection tai unknown_ids.
Oikeus: content.write
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
Etsi suosituksia sivuston omalta verkkosivustolta
testimonial_import_sources_find
Lukee sivuston verkkotunnuksen ja sivut, joihin se linkittää ja jotka näyttävät sisältävän suosituksia, kerran sivustoa kohden. Se on ilmaista: se ei ole yksi Free-paketin haetuista tuonneista. Löydetty odottaa palauttamansa lähteen tarkistusvaiheessa.
Oikeus: content.write
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
Listaa sivuston tuontilähteet
testimonial_import_sources_list
meta sisältää kohdat fetched_imports (used, limit ja resets_on kuukaudelle, limit null tarkoittaa rajoittamatonta) ja sync (paketin sallima tahti).
Oikeus: analytics.read
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
Säilytä löydetyt kohteet suosituksina
testimonial_import_sources_keep
Anna item_ids (enintään 100) tai all. Jokainen säilytetty kohde tallennetaan saman reitin kautta kuin mikä tahansa muu suositus, joten kaksoiskappaleita ei koskaan tallenneta kahdesti. Mikään säilytetty ei lasketa kuukauden suosituksiin. meta kertoo, kuinka monta säilytettiin.
Oikeus: content.write
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
Listaa alustat, joita tuonti voi lukea
testimonial_import_platforms_list
Testattujen lähteiden rekisteri. Alusta listataan vasta, kun sen tuonti on todistettu oikealla sivulla. Jokainen merkintä kertoo, mikä linkki liitetään.
Oikeus: analytics.read
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
Listaa se, minkä lähde löysi ja mistä ei ole vielä päätetty
testimonial_import_sources_review
meta sisältää lukumäärät merkin mukaan (new, already_here, likely_duplicate).
Oikeus: analytics.read
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
Lue lähde uudelleen nyt
testimonial_import_sources_run
Käsin tehty ajo on haettu tuonti ja se lasketaan yhdeksi kuukauden tuonneista Free-paketissa (402 plan_limit sen jälkeen). Hylätään, kun ajo on käynnissä (422 in_progress) ja lähteen 3 ajon jälkeen 24 tunnissa missä tahansa paketissa (422 too_many_runs). Virheelliselle lähteelle se nollaa epäonnistumisten määrän.
Oikeus: content.write
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
Hae yksi tuontilähde tiloineen ja lukumäärineen
testimonial_import_sources_get
Palauttaa alustan, nimen, luetun osoitteen, kuinka usein se luetaan uudelleen, tilan, montako kohdetta odottaa tarkistusvaiheessa, montako säilytettiin, peräkkäiset epäonnistumiset sekä milloin se viimeksi ajettiin ja ajetaan seuraavaksi.
Oikeus: analytics.read
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
Muuta lähteen linkkiä, nimeä, synkronointia tai automaattista hyväksyntää tai keskeytä se
testimonial_import_sources_update
Paketin ylittävä synkronointi (mikä tahansa Free-paketissa, viikoittainen Pro-paketissa) hylätään vastauksella 402 plan_limit.
Oikeus: content.write
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 '{…}'
Suositusten yritykset
GET
/sites/:site_id/testimonials/companies.json
Listaa sivuston yritykset henkilöineen, suosituksineen ja keskimääräisine arvosanoineen
testimonial_companies_list
Yksi rivi yritystä kohden, ryhmiteltynä sivuston henkilöiden yrityksen nimestä ja verkkosivustosta. Henkilö, jolla ei ole yritystä, ei kuulu mihinkään. query vastaa osaa yrityksen nimestä tai sen verkkosivuston isäntänimestä. sort on name (oletus), people_desc, testimonials_desc tai received_desc.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/companies.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/testimonials/companies/:id/merge.json
Yhdistä yritys toiseen, saman yrityksen kahden kirjoitustavan vuoksi
testimonial_companies_merge
Jokainen polussa olevan yrityksen henkilö saa kentän into nimeämän yrityksen nimen ja URL-osoitteen.
Oikeus: content.write
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
Hae yksi yritys henkilöineen
testimonial_companies_get
Tunniste on yrityksen avain, verkkosivuston isäntänimi tai normalisoitu nimi, sellaisena kuin testimonial_companies_list sen palauttaa. Sen suositukset ovat testimonials_list kentällä company.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/companies/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/testimonials/companies/:id.json
Korjaa yrityksen nimi ja URL kaikille sen henkilöille kerralla
testimonial_companies_update
Yrityksen tunniste tulee sen URL-osoitteesta tai nimestä, joten vastauksessa voi olla uusi tunniste.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/companies/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Suppilot
POST
/sites/:site_id/funnels.json
Luo suppilo
funnels_create
Luo suppilon, jonka vaiheiden läpi käynnit etenevät ja jota mitataan käyntikohtaisesti. Anna name ja steps, järjestetty lista muodossa {type, value, match, name}. type on page, event tai goal. value on polku sivuvaiheille (esimerkiksi /pricing), oman tapahtuman nimi tapahtumavaiheille tai tavoitteen id (goal_..., goals_list-kutsusta) tavoitevaiheille. match koskee vain sivuvaiheita ja on exact, prefix, glob (* jokerimerkki) tai regex, oletuksena glob, kun arvossa on *, ja muuten exact. name on valinnainen nimike. Vaiheet, joilla on tyhjä value, pudotetaan. order_mode on strict (jokaisen vaiheen on tultava edellisen jälkeen, oletus) tai any (vaiheet missä järjestyksessä tahansa). window on visit (oletus) tai day, ja molemmat mittaavat yhden käynnin sisällä, koska kävijätunnusta ei tallenneta. Paketin rajat pätevät. Free sallii 3 suppiloa sivustoa kohti ja 5 vaihetta, Pro sallii 10 vaihetta ja Business 20, ja suppilossa on oltava vähintään 2 vaihetta. Palauttaa suppilon kentällä id (fun_...). Lue tulokset funnels_get-kutsulla. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Poista suppilo
funnels_delete
Poistaa suppilon määrityksen pysyvästi. Analytiikkadataan ei kosketa, mutta suppiloa ja sen asetuksia ei voi palauttaa eikä kumoamista ole. Palauttaa poistetun suppilon. Tunnukset (fun_...) tulevat funnels_list-kutsusta. Käytä funnels_update-kutsua suppilon muuttamiseen sen sijaan. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Listaa suppilot sisääntuloineen, suorituksineen ja asteineen
funnels_list
Listaa sivuston suppilot jakson pääraportteineen nimen mukaan järjestettyinä. Jokaisella suppilolla on id (fun_...), name, steps, order_mode, window ja stats {entered, completed, conversion_rate}, jossa entered on käynnit, jotka saavuttivat vaiheen 1, completed on käynnit, jotka saavuttivat viimeisen vaiheen, ja conversion_rate on prosentti (0 - 100). Sivutettu page- ja per_page-arvoilla (enintään 100, oletus 25). Ottaa yhteiset period- ja filters-syötteet. Vaihe vaiheelta -yksityiskohtiin käytä funnels_get-kutsua ja uuden lisäämiseen funnels_create-kutsua.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/funnels.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/funnels/:id.json
Suppiloraportti: vaiheiden määrät, konversio, pudotus, vaiheiden välinen aika ja minne käynnit menivät sen sijaan
funnels_get
Yhden suppilon konversioraportti jaksolle. Palauttaa period, funnel_id, name, order_mode, window, steps, overall_conversion_rate, breakdown ja compare-parametrin kanssa comparison. Jokaisella vaiheella on index (alkaen 1:stä), name, type, value, match, count (sen saavuttaneet käynnit), step_conversion_rate (prosentti edellisestä vaiheesta), overall_conversion_rate (prosentti vaiheesta 1), dropoff ja dropoff_rate (tämän vaiheen jälkeen poistuneet käynnit), median_seconds_from_previous (null vaiheelle 1) ja next_pages (5 suosituinta sivua, joilla pudonneet käynnit kävivät seuraavaksi, ja (exit) poistuneille). Asteet ovat prosentteja väliltä 0 - 100. Aseta breakdown arvoon channel, device, country, utm_campaign, utm_source, browser tai os saadaksesi kokonaiskonversion arvoa kohti (20 suosituinta). comparison sisältää toisen jakson lukumäärät, overall_conversion_rate ja change (prosentti, null kun aiempi aste oli 0). Sivusuodattimia ei huomioida täällä, koska ne katkaisisivat käyntejä, käytä sen sijaan sivuvaihetta. Ottaa yhteiset period-, compare-, filters- ja segment-syötteet. Tunnukset tulevat funnels_list-kutsusta.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/funnels/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/funnels/:id.json
Päivitä suppilo
funnels_update
Muuttaa suppiloa. Vain lähettämäsi syötteet muuttuvat. steps-arvon lähettäminen korvaa koko vaihelistan, joten lähetä jokainen vaihe järjestyksessä (muoto ja vaiherajat ovat samat kuin funnels_create-kutsussa, Free sallii 5 vaihetta, Pro 10 ja Business 20, ja tavoitevaiheiden on nimettävä tämän sivuston tavoitteita). Voit muuttaa myös name, order_mode (strict tai any) ja window (visit tai day). Tulokset lasketaan määrityksestä luettaessa, joten suppilon muuttaminen koskee koko historiaa heti ja aiemmin näytetyt luvut poikkeavat. Palauttaa suppilon. Tunnukset tulevat funnels_list-kutsusta. Vaatii content.write-oikeuden.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/funnels/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Sähköpostiasetukset
POST
/email/preferences/:token/unsubscribe.json
Lopeta kaikki osoitteeseen lähetettävät sähköpostit, jotka voi laittaa pois päältä, sähköpostiasetusten linkin tunnisteella
email_preferences_unsubscribe_all
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/email/preferences/:token/unsubscribe.json \
-H "Content-Type: application/json" -d '{…}'
POST
/email/preferences/:token.json
Laita osoitteeseen lähetettävät sähköpostit pois päältä tai päälle sähköpostiasetusten linkin tunnisteella
email_preferences_update
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/email/preferences/:token.json \
-H "Content-Type: application/json" -d '{…}'
Sähköpostiraportit
DELETE
/recipients/:id.json
Poista vastaanottaja sähköpostiraportista
email_report_recipients_delete
Poistaa yhden osoitteen sähköpostiraportilta (vastaanottajan id, email_report_recipients_list-kutsusta). Osoite lakkaa saamasta raportteja ja sen rivi poistetaan. Jos osoite oli peruuttanut tilauksen itse, kieltäytyminen säilyy kirjattuna, joten sen poistaminen ei salli kenenkään kutsua sitä uudelleen. Jos haluat muuttaa montaa osoitetta kerralla, lähetä koko lista email_reports_update-kutsun kautta. Palauttaa poistetun vastaanottajan.
Oikeus: content.write
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
Listaa sähköpostiraportin vastaanottajat tiloineen
email_report_recipients_list
Tilat: active (saa raportit), pending (kutsuttu, ei vielä hyväksynyt), declined tai unsubscribed. Lisää tai poista osoitteita raportin vastaanottajalistan kautta.
Oikeus: analytics.read
curl https://privatusanalytics.com/reports/:report_id/recipients.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/recipients/:id/resend.json
Lähetä odottava raporttikutsu uudelleen
email_report_recipients_resend
Lähettää kutsun uudelleen uusilla linkeillä. Sallittu kerran 7 päivässä osoitetta ja raporttia kohden.
Oikeus: content.write
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
Luo sähköpostiraportti
email_reports_create
Luo ajastetun analytiikkasähköpostiraportin, joka kattaa yhden tai useamman sivuston (polku ottaa workspace_id-arvon). Pakollisia ovat name ja site_ids (pa_...-tunnukset). frequency on daily, weekly (oletus, lähetetään arkipäivänä) tai monthly (kuun 1. päivä), hour on vuorokaudentunti 0 - 23 työtilan aikavyöhykkeellä (oletus 8) ja weekday on 0 sunnuntaille ja 6 lauantaille (oletus 1, käytössä vain viikoittaisissa raporteissa). blocks valitsee sisällön arvoista kpis, chart, pages, sources, goals, campaigns, vitals, uptime, testimonials ja subscriptions (oletus kpis, chart, pages, sources, goals, testimonials, subscriptions). subscriptions näyttää MRR:n ja sen, mikä sitä liikutti jaksolla, sivustolle, jolla on maksupalveluntarjoaja yhdistettynä. recipients on lista sähköpostiosoitteita (enintään 50). Työtilan jäsenet ovat heti aktiivisia, mikä tahansa muu osoite on odottava ja saa kutsusähköpostin, ja vastaanottaa raportteja vasta hyväksyttyään sen. Osoitteet, jotka ovat kieltäytyneet, hylätään. Jos recipients jätetään pois, kutsuva käyttäjä lisätään. Käytössä olevalla raportilla on oltava vähintään yksi vastaanottaja. Free-paketti sallii 3 raporttia, maksulliset paketit ovat rajattomia. Palauttaa raportin kentällä next_run_at. Käytä email_reports_send_test-kutsua sen esikatseluun.
Oikeus: content.write
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
Sähköpostiraportin toimituslokit
email_reports_deliveries
Listaa yhden sähköpostiraportin lähetyslokin uusin ensin ja sivutettuna. Jokaisella merkinnällä on status (sent ajastetulle lähetykselle, test, failed tai skipped), recipients_count, error (epäonnistumisen syy, muuten null) ja sent_at. Suodata status-arvolla. Käytä sitä varmistaaksesi, että ajastettu raportti lähti, tai nähdäksesi, miksi se epäonnistui. Käytä email_reports_send_test-kutsua testisähköpostin laukaisemiseen.
Oikeus: analytics.read
curl https://privatusanalytics.com/reports/:id/deliveries.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
DELETE
/reports/:id.json
Poista sähköpostiraportti
email_reports_delete
Poistaa sähköpostiraportin pysyvästi yhdessä sen vastaanottajien ja lähetyslokin kanssa. Tätä ei voi perua, eikä sähköposteja lähetetä enää. Jos haluat lopettaa lähettämisen mutta säilyttää raportin, käytä email_reports_update-kutsua arvolla enabled false. id (rep_...) tulee email_reports_list-kutsusta. Palauttaa poistetun raportin.
Oikeus: content.write
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
Listaa sähköpostiraportit
email_reports_list
Listaa työtilan ajastetut sähköpostiraportit (polku ottaa workspace_id-arvon) nimen mukaan lajiteltuina ja sivutettuina. Jokaisella raportilla on id (rep_...), name, site_ids, frequency, hour, weekday, recipients (raportin jokainen osoite), recipient_details (kullekin id, email, status, invited_at, expires_at, confirmed_at), blocks, attach_pdf, intro, enabled, last_sent_at, next_run_at ja created_at. Suodata frequency-arvolla (daily, weekly tai monthly). Vain joihinkin sivustoihin rajattu kutsuja näkee vain raportit, joiden kaikki sivustot ovat sen omia. Vain vastaanottajat, joiden status on active, saavat raportteja. Käytä email_reports_deliveries-kutsua lähetyslokiin.
Oikeus: analytics.read
curl https://privatusanalytics.com/workspaces/:workspace_id/reports.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/reports/:id/send_test.json
Lähetä sähköpostiraportti nyt testinä
email_reports_send_test
Lähettää raportin yhteen osoitteeseen heti testinä muuttamatta sen aikataulua tai last_sent_at-arvoa. Lähettää oikean sähköpostin, joten käytä sitä vain, kun käyttäjä haluaa sen. recipient on oletuksena kutsuva käyttäjä, ja se voi olla vain kutsuja, toinen työtilan jäsen tai raportin aktiivinen vastaanottaja. Mille tahansa muulle osoitteelle testi lähetetään kutsujalle. Testilähetykset on nopeusrajoitettu työtilaa ja ulkopuolista osoitetta kohti, ja hylätty lähetys palauttaa nopeusrajavirheen. Palauttaa lähetyksen kentillä status (test tai failed, jolloin syy on kentässä error), recipients_count ja sent_at. Käytä email_reports_deliveries-kutsua koko lokiin.
Oikeus: content.write
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
Hae sähköpostiraportti
email_reports_get
Palauttaa yhden sähköpostiraportin id:n perusteella (rep_..., email_reports_list-kutsusta). Vastauksessa on name, site_ids, frequency, hour, weekday, recipients, recipient_details jokaisen osoitteen ja sen vahvistustilan kanssa, blocks, attach_pdf, intro, enabled, last_sent_at ja next_run_at (UTC-aikaleimat). recipients listaa jokaisen osoitteen odottavat mukaan lukien, vain recipient_details-kentässä statuksella active olevat osoitteet saavat raportteja. Käytä email_reports_deliveries-kutsua nähdäksesi, mitä lähetettiin.
Oikeus: analytics.read
curl https://privatusanalytics.com/reports/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/reports/:id.json
Päivitä sähköpostiraportti
email_reports_update
Muuttaa sähköpostiraporttia (id email_reports_list-kutsusta). Vain lähettämäsi syötteet muuttuvat. recipients-arvon lähettäminen korvaa koko listan. Pudottamasi osoitteet poistetaan, uusiin sovelletaan samoja vahvistussääntöjä kuin email_reports_create-kutsussa (jäsenet ovat heti aktiivisia, muut saavat kutsusähköpostin) ja jo raportilla olevat osoitteet säilyttävät tilansa. frequency-, hour-, weekday- tai enabled-arvon muuttaminen laskee next_run_at-arvon uudelleen. Aseta enabled false keskeyttääksesi. Käytä email_report_recipients_list-kutsua nähdäksesi vahvistustilan ja email_report_recipients_resend- tai email_report_recipients_delete-kutsua yksittäisten osoitteiden hallintaan.
Oikeus: content.write
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
Hyväksy raporttikutsu
report_invites_accept
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/reports/invites/:token/accept.json \
-H "Content-Type: application/json" -d '{…}'
POST
/reports/invites/:token/decline.json
Hylkää raporttikutsu
report_invites_decline
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/reports/invites/:token/decline.json \
-H "Content-Type: application/json" -d '{…}'
POST
/reports/resubscribe/:token.json
Vastaanota raportteja uudelleen tilauksen peruuttamisen jälkeen
report_resubscribes_confirm
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/reports/resubscribe/:token.json \
-H "Content-Type: application/json" -d '{…}'
POST
/reports/unsubscribe/:token/resubscribe.json
Lähetä osoitteeseen linkki raporttien vastaanottamiseen uudelleen
report_resubscribes_create
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/reports/unsubscribe/:token/resubscribe.json \
-H "Content-Type: application/json" -d '{…}'
POST
/reports/unsubscribe/:token.json
Peruuta osoitteen sähköpostiraportin tilaus
report_unsubscribes_create
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/reports/unsubscribe/:token.json \
-H "Content-Type: application/json" -d '{…}'
Tapahtumat
GET
/sites/:site_id/events/properties.json
Listaa viimeisen 30 päivän aikana nähdyt tapahtuman ominaisuusavaimet
event_properties_list
Listaa ominaisuusavaimet, joita omat tapahtumat kantoivat viimeisen 30 päivän aikana, näyttöasetuksineen. Palauttaa listan muodossa {key, events, display_name, hidden, export_safe}. events kertoo, kuinka moni oma tapahtuma kantoi avaimen (0 avaimelle, jolla on asetuksia mutta jota ei nähty äskettäin), display_name on uudelleennimeäminen (null, kun ei ole), hidden kertoo, että avain on piilotettu raporteista, ja export_safe kertoo, että se on merkitty sisältämättömäksi henkilötietoja. Enintään 200 avainta palautetaan, eniten käytetty ensin. Anna event nähdäksesi vain avaimet, jotka on nähty yhdellä raa'alla tapahtumanimellä. Ominaisuuksien arvoja ei koskaan palauteta tässä, käytä stats_breakdown-kutsua dimensiolla prop:<key> tai events_get-kutsua arvoille. Muuta asetuksia event_properties_update-kutsulla.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/events/properties.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/events/properties.json
Nimeä tapahtuman ominaisuusavain uudelleen tai piilota se
event_properties_update
Nimeää uudelleen, piilottaa tai merkitsee vientiturvalliseksi yhden tapahtuman ominaisuusavaimen koko sivustolle. Vain lähettämäsi syötteet muuttuvat. key on oltava avain tallennetussa muodossa (pieniä kirjaimia, numeroita ja alaviivoja, enintään 64 merkkiä, esimerkiksi plan). display_name on enintään 64 merkin nimike (lähetä se tyhjänä poistaaksesi uudelleennimeämisen). hidden poistaa avaimen raporteista ja tapahtuman yksityiskohtien pivot-näkymästä data säilyttäen. export_safe ilmoittaa, ettei avain koskaan sisällä henkilötietoja, mikä sisällyttää sen arvot raakavienteihin ja tietovarastosynkronointeihin, joten aseta se vain, kun se pitää paikkansa. Uudelleennimeäminen ja piilottaminen tulevat voimaan raportteja luettaessa eivätkä kirjoita tallennettua dataa uudelleen. Palauttaa {key, display_name, hidden, export_safe}. Vaatii sites.manage-oikeuden. Listaa avaimet event_properties_list-kutsulla.
Oikeus: sites.manage
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
Poista tapahtuma ja sen historia (ajetaan taustalla, vahvista kirjoittamalla nimi)
events_delete
Poistaa oman tapahtuman ja sen koko historian pysyvästi. Tätä ei voi perua. Raaka tapahtumanimi on lähetettävä kahdesti, kentissä name ja confirm, turvatarkistuksena. Palauttaa {name, status: queued} HTTP 202 -vastauksella, koska rivit poistetaan taustalla erissä, joten luvut muuttuvat, kunnes se valmistuu. Tapahtuma myös piilotetaan heti, ja poisto kirjataan tarkastuslokiin. Sivunäyttöihin ei vaikuteta. Jos haluat vain lopettaa tapahtuman näyttämisen, käytä events_update-kutsua arvolla hidden true, joka säilyttää datan. Vaatii sites.manage-oikeuden. Nimet tulevat events_list-kutsusta (käytä raw_names-kenttää, jos tapahtuma on nimetty uudelleen tai yhdistetty).
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Listaa tapahtumat suorituksineen, käynteineen, konversioasteineen sekä ensimmäisenä ja viimeisenä nähtynä
events_list
Tapahtumaselain: jokainen oma tapahtuma jaksolla. Palauttaa period, events ja hidden. Jokaisella tapahtumalla on name (näyttönimi uudelleennimeämisten ja yhdistämisten jälkeen), raw_names (seurantakoodin lähettämät nimet), completions, visits, conversion_rate (prosentti käynneistä, 0 - 100), revenue (pienimmissä yksiköissä, sentteinä), first_seen ja last_seen (ISO 8601 -aikaleimat jakson sisällä) ja currency (tuoton valuutta, null kun ei ole asetettu). hidden listaa piilottamasi tapahtumat muodossa {name, display_name}. Käytä search-arvoa säilyttääksesi tapahtumat, joiden nimi sisältää tekstiä. Sivunäytöt eivät ole tapahtumia täällä. Käytä events_get-kutsua yhteen tapahtumaan syvällisesti ja stats_breakdown-kutsua dimensiolla event järjestettyyn, sivutettuun listaan. Ottaa yhteiset period-, compare-, filters- ja segment-syötteet.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/events.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/events/merge.json
Yhdistä useita tapahtumia yhdeksi näyttönimeksi
events_merge
Yhdistää useita raakoja tapahtumanimiä yhdeksi näyttönimeksi, esimerkiksi signup_click ja signup_button nimeksi Signup. Raportit näyttävät sitten yhden tapahtuman yhdistetyillä luvuilla. Se toimii raportteja luettaessa, eikä tallennettuja tapahtumia muuteta tai poisteta. Anna names (raa'at nimet, vähintään yksi) ja into (näyttönimi). Palauttaa yhden asetusobjektin yhdistettyä nimeä kohti, kukin {name, display_name, hidden, currency, updated_at}. Kumoa kutsumalla events_update-kutsua nimelle tyhjällä display_name-arvolla. Vaatii sites.manage-oikeuden. Nimet tulevat events_list-kutsusta (raw_names).
Oikeus: sites.manage
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
Yksi tapahtuma: kaavio, ominaisuuksien pivot, numeeristen ominaisuuksien koosteet, sivut ja lähteet
events_get
Yhden oman tapahtuman yksityiskohdat. Anna name täsmälleen kuten events_list-kutsussa (näyttönimi uudelleennimeämisten ja yhdistämisten jälkeen). Palauttaa period, name, raw_names (sen takana olevat tallennetut nimet), interval, totals, setting, series, property_keys, pivot, numeric, pages, channels ja referrers. totals sisältää completions, visits (käynnit, jotka laukaisivat sen), revenue (pienimmissä yksiköissä, sentteinä) ja conversion_rate (prosentti jakson kaikista käynneistä). series on suoritukset aikajaksoa kohti. setting sisältää display_name, hidden ja currency. property_keys listaa nähdyt ominaisuusavaimet. Lähetä properties (enintään 3 avainta) saadaksesi pivotin, rivit muodossa {values, completions, visits} jokaiselle arvoyhdistelmälle, 100 suosituinta. numeric antaa summan, keskiarvon ja muita lukuja ominaisuuksille, jotka sisältävät lukuja. pages, channels ja referrers ovat 10 suosituinta paikkaa, joissa tapahtuma laukesi, muodossa {value, completions, visits}. Käytä events_list-kutsua kaikille tapahtumille, stats_breakdown-kutsua dimensiolla prop:<key> yhdelle ominaisuudelle koko sivustolla ja events_update-kutsua sen uudelleennimeämiseen.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/events/detail.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/events/settings.json
Nimeä tapahtuma uudelleen, piilota tai palauta se tai aseta sen valuutta
events_update
Muuttaa sitä, miten yksi oma tapahtuma näytetään: nimeä se uudelleen display_name-arvolla, piilota tai palauta hidden-arvolla tai aseta tuoton valuutta. name on raaka tapahtumanimi sellaisena kuin seurantakoodi sen lähetti (katso raw_names events_list-kutsussa). Vain lähettämäsi syötteet muuttuvat. Tyhjä display_name poistaa uudelleennimeämisen. hidden poistaa tapahtuman listoista ja raporteista datan säilyessä. currency on kolmikirjaiminen ISO 4217 -koodi, kuten USD, tallennettuna isoilla kirjaimilla. Tämä toimii raportteja luettaessa, eikä tallennettuja tapahtumia kirjoiteta uudelleen. Palauttaa {name, display_name, hidden, currency, updated_at}. Useiden tapahtumien yhdistämiseen käytä events_merge-kutsua ja datan poistamiseen events_delete-kutsua. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
curl -X PATCH https://privatusanalytics.com/sites/:site_id/events/settings.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Tarkastusloki
GET
/workspaces/:workspace_id/audit_log.json
Listaa tarkastuslokin merkinnät (lisää .csv viedäksesi)
audit_logs_get
Palauttaa työtilan tarkastusloki, uusin ensin ja sivutettu kirjaus siitä, kuka muutti mitä (asetukset, jäsenet, sivustot, tavoitteet, tunnisteet ja niin edelleen). Se vaatii workspace.manage-oikeuden ja paketin, jossa on tarkastushistoria. Free-paketissa sitä ei ole ja kutsu epäonnistuu pakettirajavirheeseen, Pro säilyttää 30 päivää, Business 365 päivää ja Enterprisessa ei ole rajaa. Säilytysajan ylittäviä merkintöjä ei koskaan palauteta. Suodata arvoilla actor (jäsenen sähköposti, täsmällinen vastaavuus), item_type (tietueen laji, kuten Site, Goal tai Membership), event (create, update tai destroy) sekä from ja to (YYYY-MM-DD, sisältäen, UTC-aikana). Jokaisella merkinnällä on id, created_at, event, item_type, item_id, target (luettava nimi, kuten Site: example.com), actor_email (null, kun muutoksen teki järjestelmä tai poistettu käyttäjä), actor_name, token_name (käytetty API-tunniste, null selainistunnossa), changes (objekti, joka yhdistää kunkin muuttuneen kentän [ennen, jälkeen] -pariin, salaisuudet poistettuina) ja ip (osoite, jota jäsen tai API-asiakas käytti, null kun tuntematon). Saman lokin CSV-vienti on saatavilla vain sovelluksessa.
Oikeus: workspace.manage
curl https://privatusanalytics.com/workspaces/:workspace_id/audit_log.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Tavoitteet
POST
/sites/:site_id/goals/:id/archive.json
Arkistoi tavoite (piilotetaan raporteista)
goals_archive
Arkistoi tavoitteen. Arkistoitu tavoite piilotetaan raporteista, se ei lasketa paketin tavoiterajaan ja se säilyttää määrityksensä, joten se voidaan palauttaa myöhemmin goals_unarchive-kutsulla. Mitään dataa ei poisteta. Palauttaa tavoitteen, jossa archived on true ja archived_at asetettu. Jo arkistoidun tavoitteen arkistointi ei tee mitään. Käytä goals_delete-kutsua poistaaksesi sen lopullisesti. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Luo tavoite
goals_create
Luo konversiotavoitteen. Tavoitteet ovat määrityksiä, joita sovelletaan raportteja luettaessa, joten uusi tavoite laskee heti täsmäävät tapahtumat koko olemassa olevasta historiasta. Pakollisia ovat name ja kind. kind ratkaisee, mitkä muut syötteet pätevät. page vaatii pattern-arvon (polku, esimerkiksi /thank-you, ja match_type exact, prefix, glob tai regex) ja voi käyttää hostname-arvoa. event vaatii event_name-arvon ja voi käyttää conditions-arvoa (ominaisuustestit kuten {key: plan, operator: is, value: pro}, kaikkien on täsmättävä, operaattorit is, is_not, contains, gt, lt). engagement vaatii pattern-arvon sekä scroll_threshold (prosentti 1 - 100) ja/tai time_threshold_seconds (saavutetaan, kun jompikumpi täyttyy). outbound vertaa linkin verkkotunnusta pattern-arvoon (esimerkiksi stripe.com) ja download vertaa tiedostoa pattern-arvoon (esimerkiksi *.pdf). value_mode on none (oletus), fixed (käyttää fixed_value-arvoa, desimaalisummaa sivuston valuutassa, kuten 49.5, tallennettuna fixed_value_minor-kenttään sentteinä) tai revenue (tapahtuman oma tuotto). count_mode on once_per_visit (oletus) tai every. Free-työtilat sallivat 10 aktiivista tavoitetta sivustoa kohti, maksulliset paketit ovat rajattomia. Palauttaa tavoitteen kentällä id (goal_...). Vaatii content.write-oikeuden.
Oikeus: content.write
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
Poista tavoite (tiedot säilyvät)
goals_delete
Poistaa tavoitteen määrityksen pysyvästi. Tapahtumadataa ei poisteta, mutta tavoite katoaa raporteista, ja siihen viittaavat suppilovaiheet, polut ja kokeilut lakkaavat toimimasta. Kumoamista ei ole. Jos haluat piilottaa tavoitteen ja säilyttää sen, käytä goals_archive-kutsua. Palauttaa poistetun tavoitteen. Tunnukset (goal_...) tulevat goals_list-kutsusta. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Kopioi tavoite
goals_duplicate
Kopioi tavoitteen määrityksen uudeksi aktiiviseksi tavoitteeksi. Kopion nimi on name, jos lähetät sen, muuten alkuperäinen nimi ja perässä (copy). Se lasketaan paketin tavoiterajaan (10 aktiivista tavoitetta sivustoa kohti Free-paketissa). Palauttaa uuden tavoitteen uudella id:llä. Käytä sitä aloittaaksesi tavoitteen muunnelman ja muuta sitä sitten goals_update-kutsulla. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Listaa tavoitteet suorituksineen, konversioineen, asteineen ja arvoineen jaksolle
goals_list
Listaa sivuston tavoitteet jakson tuloksineen. Jokainen tavoite on määritys (id goal_..., name, kind, match_type, pattern, hostname, event_name, conditions, scroll_threshold, time_threshold_seconds, value_mode, fixed_value_minor sentteinä, count_mode, archived, archived_at) sekä stats {completions, conversions, conversion_rate, value, change}. conversion_rate on prosentti (0 - 100), value on pienimmissä yksiköissä (sentteinä) ja change on konversioiden prosenttimuutos edelliseen jaksoon verrattuna (null, kun aiempi lukumäärä oli 0). status suodattaa arvoon active (oletus), archived tai all. Sivutettu page- ja per_page-arvoilla (enintään 100, oletus 25). Käytä goals_get-kutsua yhden tavoitteen täyteen raporttiin. Ottaa yhteiset period-, compare- ja filters-syötteet.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/goals.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/goals/:id.json
Tavoiteraportti: mittarit, kaavio, erittelyt ja konversioon johtava polku
goals_get
Yksi tavoite syvällisesti jaksolle. Palauttaa period, goal_id, goal (määritys), metrics, interval, series, breakdowns, journey ja compare-parametrin kanssa comparison_period, comparison ja change. metrics sisältää completions (jokainen täsmäävä tapahtuma), conversions (käynnit, joilla on vähintään yksi suoritus), conversion_rate (prosentti väliltä 0 - 100) ja value (pienimmissä yksiköissä, sentteinä). conversion_rate jaetaan käynneillä tai kävijöillä, kun sivusto on asetettu niin. series on lista muodossa {date, completions, conversions, conversion_rate} aikajaksoa kohti (muuta sitä interval-arvolla). breakdowns sisältää 10 suosituinta konversioiden mukaan dimensioille channel, utm_campaign, entry_page, country ja device, kukin muodossa {value, completions, conversions, conversion_rate}. journey näyttää converting_visits, median_seconds_to_convert, median_pages_before ja pages_before (10 suosituinta ennen konvertoitumista nähtyä sivua käynteineen ja osuuksineen). Käytä goals_list-kutsua kaikille tavoitteille kerralla ja funnels_get-kutsua monivaiheisille poluille. Ottaa yhteiset period-, compare-, filters- ja segment-syötteet.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/goals/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/goals/:id/unarchive.json
Palauta arkistoitu tavoite
goals_unarchive
Palauttaa arkistoidun tavoitteen, jolloin se näkyy taas raporteissa. Se lasketaan taas paketin tavoiterajaan (10 aktiivista tavoitetta sivustoa kohti Free-paketissa), joten kutsu epäonnistuu pakettirajavirheeseen, kun sivusto on jo täynnä. Sellaisen tavoitteen palauttaminen, jota ei ole arkistoitu, ei tee mitään. Palauttaa tavoitteen, jossa archived on false. Tunnukset tulevat goals_list-kutsusta statuksella archived. Vaatii content.write-oikeuden.
Oikeus: content.write
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
Päivitä tavoite
goals_update
Muuttaa tavoitteen määritystä. Vain lähettämäsi syötteet muuttuvat. Uusi määritys koskee koko historiaa heti, joten aiemmat konversioluvut muuttuvat. Syötteet ovat samat kuin goals_create-kutsussa ja samat yhdistelmät pätevät, esimerkiksi event_name ja conditions ovat merkityksellisiä vain tapahtumatavoitteille ja scroll_threshold ja time_threshold_seconds vain sitoutumistavoitteille. fixed_value on desimaalisumma sivuston valuutassa (tallennetaan sentteinä). conditions-arvon lähettäminen korvaa kaikki olemassa olevat ehdot. Palauttaa tavoitteen. Tunnukset tulevat goals_list-kutsusta. Vaatii content.write-oikeuden.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/goals/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Tietovarastosynkronointi
POST
/workspaces/:workspace_id/warehouses.json
Lisää tietovarastokohde
warehouse_destinations_create
Lisää tietovarastokohteen, joka vastaanottaa jokaisen päivän raakatapahtumat (vain Business-paketti). Päivittäin klo 02:00 UTC edellinen UTC-päivä ladataan, ensimmäinen ajo on seuraavana klo 02:00 UTC ja epäonnistunut ajo yritetään uudelleen tunnin kuluttua. kind on annettava ja se ratkaisee pakolliset asetukset. s3 (myös GCS, R2 ja MinIO endpointin kautta) vaatii arvot bucket, access_key_id ja secret_access_key, sekä valinnaiset region, prefix ja endpoint (vain https, vain julkiset isännät). bigquery vaatii arvot service_account_json, dataset ja table, sekä valinnaisen project_id. snowflake vaatii arvot account, user, private_key (PEM RSA), database, schema ja table, sekä valinnaiset warehouse ja role. azure vaatii sas_url-arvon (https-blob-säiliön SAS-linkki kirjoitusoikeudella) ja valinnaisesti prefix. Salaisuudet (secret_access_key, service_account_json, private_key, sas_url) ovat vain kirjoitettavia eikä niitä palauteta koskaan. site_ids rajaa sivustot (pa_...-tunnukset), tyhjä tarkoittaa jokaista sivustoa, ja vain joihinkin sivustoihin rajatun jäsenen tai tunnisteen on nimettävä ne. Tapahtumaominaisuudet lähetetään vain, kun ne on merkitty vientiturvallisiksi (katso event_properties_list). Vaatii workspace.manage-oikeuden. Palauttaa kohteen kentillä id (whd_...), maskattu target ja configured (täytettyjen asetusten nimet).
Oikeus: workspace.manage
· Vain HTTP (ei MCP-työkalu)
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
Poista tietovarastokohde
warehouse_destinations_delete
Poistaa tietovarastokohteen, jolloin mitään ei lähetetä enää. Jo ladattu data pysyy säilytyspaikassasi tai tietovarastossasi, eikä tätä voi perua, vaikka voit lisätä kohteen uudelleen (historiaa ei lähetetä automaattisesti uudelleen). Vielä jonossa olevaa manuaalista synkronointia ei kutsuta takaisin. id tulee warehouse_destinations_list-kutsusta. Vaatii workspace.manage-oikeuden. Palauttaa poistetun kohteen.
Oikeus: workspace.manage
· Vain HTTP (ei MCP-työkalu)
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
Listaa tietovarastokohteet
warehouse_destinations_list
Listaa työtilan tietovarastokohteet nimen mukaan lajiteltuina, halutessasi vain yhden lajin (s3, bigquery, snowflake tai azure). Vain joihinkin sivustoihin rajattu jäsen tai tunniste näkee vain kohteet, joiden kaikki sivustot ovat sen omia, ja kohteet, jotka lähettävät jokaisen sivuston, piilotetaan heiltä. Sivutettu page- ja per_page-arvoilla (enintään 100). Jokaisella kohteella on warehouse_destinations_get-kutsussa kuvatut kentät. Tarvitsee workspace_id-arvon workspaces_list-kutsusta ja workspace.manage-oikeuden.
Oikeus: workspace.manage
curl https://privatusanalytics.com/workspaces/:workspace_id/warehouses.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/warehouses/:id.json
Hae tietovarastokohde (ilman salaisuuksia)
warehouse_destinations_get
Palauttaa yhden tietovarastokohteen ilman tunnistetietoja. Kenttiä ovat id (whd_...), kind (s3, bigquery, snowflake tai azure), name, target (maskattu yhteenveto, kuten s3://bucket/prefix), configured (täytettyjen asetusten nimet, salaisuudet näkyvät vain nimeltä), site_ids (tyhjä tarkoittaa jokaista sivustoa), schedule (daily), schema_version (lähetetty rivirakenne), last_run_at, next_run_at, last_error (null kun viimeisin ajo onnistui) ja created_at. id tulee warehouse_destinations_list-kutsusta. Tarkista last_error warehouse_destinations_sync-kutsun jälkeen nähdäksesi, miten synkronointi meni.
Oikeus: workspace.manage
curl https://privatusanalytics.com/warehouses/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/warehouses/:id/sync.json
Lisää yhden päivän synkronointi jonoon nyt
warehouse_destinations_sync
Jonottaa välittömän yhden UTC-päivän raakatapahtumien latauksen kohteeseen päivittäisen aikataulun ulkopuolella. Vain Business-paketti. date (YYYY-MM-DD) on oltava ennen tätä päivää UTC-aikana ja oletus on eilinen. Se lataa kyseisen päivän kohteen jokaiselle sivustolle, joten vältä jo lähetetyn päivän synkronointia, ja manuaaliset synkronoinnit on rajattu 30 tuntia kohti työtilaa kohti. Kutsu palauttaa 202 ja kohteen heti, ja lataus suoritetaan taustalla. Kysele warehouse_destinations_get-kutsua ja lue last_run_at ja last_error nähdäksesi tuloksen. id tulee warehouse_destinations_list-kutsusta. Vaatii workspace.manage-oikeuden.
Oikeus: workspace.manage
· Vain HTTP (ei MCP-työkalu)
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
Päivitä tietovarastokohde (tyhjät salaisuudet säilytetään)
warehouse_destinations_update
Muuttaa tietovarastokohdetta (vain Business-paketti). Vain lähettämäsi syötteet muuttuvat, eikä kind-arvoa voi muuttaa. Tyhjä salaisuus säilyttää tallennetun arvon, joten voit muokata muita asetuksia lähettämättä tunnistetietoja uudelleen. Asetukset validoidaan kohteen lajille kuten warehouse_destinations_create-kutsussa. site_ids-arvon lähettäminen korvaa sivustolistan. Kun kohde muuttuu (toinen bucket, dataset, taulu, tietokanta tai vastaava), keskeneräisten päivien eteneminen alkaa alusta, joten kyseiset päivät lähetetään uudelleen uuteen paikkaan. id tulee warehouse_destinations_list-kutsusta. Vaatii workspace.manage-oikeuden. Palauttaa päivitetyn kohteen.
Oikeus: workspace.manage
· Vain HTTP (ei MCP-työkalu)
curl -X PATCH https://privatusanalytics.com/warehouses/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Tilasivut
GET
/status/:slug/confirm/:token.json
Vahvista tilaus sähköpostitse lähetetystä linkistä
public_status_pages_confirm
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/status/:slug/confirm/:token.json
GET
/status/:slug.json
Julkinen tilasivu: nykyinen tila, 90 päivän käytettävyyspalkit, häiriöt ja viestit
public_status_pages_get
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl https://privatusanalytics.com/status/:slug.json
POST
/status/:slug/subscribers.json
Tilaa sähköpostiosoite (kaksoisvahvistus)
public_status_pages_subscribe
Selainasiakkaat lähettävät Cloudflare Turnstile -tunnisteen kentässä `cf-turnstile-response`. API-tunnisteella tehtävät pyynnöt eivät tarvitse sitä.
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/status/:slug/subscribers.json \
-H "Content-Type: application/json" -d '{…}'
POST
/status/:slug/unsubscribe/:token.json
Peruuta tilaus sähköpostitse lähetetyllä tunnisteella
public_status_pages_unsubscribe
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
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
Julkaise häiriöpäivitys (lähettää sähköpostin tilaajille)
status_page_posts_create
Julkaisee häiriöpäivityksen tilasivulle ja lähettää oletuksena sähköpostin sen vahvistetuille tilaajille. Valitse se ilmoittaaksesi häiriöstä tai päivittääksesi sitä, ja käytä status_page_posts_update-kutsua olemassa olevan häiriön etenemiseen (esimerkiksi tilaan resolved) uuden viestin luomisen sijaan. Pakollinen on title (enintään 200 merkkiä). status on yksi arvoista investigating (oletus), identified, monitoring tai resolved. body on pelkkää tekstiä (enintään 10 000 merkkiä), posted_at on ISO 8601 -aika, joka on oletuksena nyt, ja notify (oletus true) ohjaa sähköpostia. Sähköposteja lähetetään vain julkaistulle sivulle ja ne on nopeusrajoitettu sivua kohti, rajan ylittyessä viesti julkaistaan silti mutta kenellekään ei lähetetä sähköpostia. status_page_id tulee status_pages_list-kutsusta. Vaatii uptime.manage-oikeuden. Palauttaa viestin kentillä id (spp_...), title, body, status, posted_at ja updated_at.
Oikeus: uptime.manage
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
Poista tilasivun viesti
status_page_posts_delete
Poistaa häiriöviestin tilasivulta pysyvästi. Se katoaa julkiselta sivulta heti, eikä tätä voi perua. Sähköpostia ei lähetetä. id tulee status_page_posts_list-kutsusta. Vaatii uptime.manage-oikeuden. Palauttaa poistetun viestin.
Oikeus: uptime.manage
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
Listaa tilasivun viestit
status_page_posts_list
Listaa tilasivun häiriöviestit, uusin ensin posted_at-arvon mukaan. Käytä sitä löytääksesi viestin id:n tai nähdäksesi häiriöhistorian. Suodata halutessasi status-arvolla (investigating, identified, monitoring tai resolved). Sivutettu page- ja per_page-arvoilla (enintään 100). Jokaisella viestillä on id (spp_...), title, body (null kun tyhjä), status, posted_at ja updated_at. status_page_id tulee status_pages_list-kutsusta.
Oikeus: analytics.read
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
Muokkaa tilasivun viestiä
status_page_posts_update
Muokkaa häiriöviestiä. Vain lähettämäsi syötteet muuttuvat, joten lähetä pelkkä status ratkaistaksesi häiriön. Tilaajille lähetetään sähköposti vain, kun tila todella muuttuu ja notify ei ole false (oletus true). Pelkän otsikon tai tekstin muokkaaminen ei lähetä sähköpostia. Sähköpostit menevät julkaistun sivun vahvistetuille tilaajille ja ne on nopeusrajoitettu sivua kohti. Kelvolliset status-arvot ovat investigating, identified, monitoring ja resolved. id tulee status_page_posts_list-kutsusta. Vaatii uptime.manage-oikeuden. Palauttaa päivitetyn viestin.
Oikeus: uptime.manage
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
Poista tilaaja
status_page_subscribers_delete
Poistaa sähköpostitilaajan tilasivulta, jolloin hän lakkaa saamasta häiriö- ja käytettävyyssähköposteja. Tätä ei voi perua, mutta henkilö voi tilata uudelleen julkisella sivulla. id on tilaajan tunnus status_page_subscribers_list-kutsusta (pelkkä UUID, ei etuliitteellinen tunnus). Vaatii uptime.manage-oikeuden. Palauttaa poistetun tilaajan.
Oikeus: uptime.manage
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
Listaa tilasivun tilaajat
status_page_subscribers_list
Listaa tilasivun sähköpostitilaajat sähköpostin mukaan lajiteltuina. Käytä confirmed true nähdäksesi vain henkilöt, jotka vahvistivat osoitteensa (vain he saavat sähköposteja), tai confirmed false odottaville. Sivutettu page- ja per_page-arvoilla (enintään 100). Jokaisella kohteella on id (UUID, jota status_page_subscribers_delete käyttää), email, confirmed_at (null odottaessa) ja created_at. status_page_id tulee status_pages_list-kutsusta. Vaatii uptime.manage-oikeuden ja palauttaa henkilötietoja (sähköpostiosoitteita). Vaatii Business- tai Enterprise-paketin (muuten 402 plan_limit).
Oikeus: uptime.manage
curl https://privatusanalytics.com/status_pages/:status_page_id/subscribers.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/workspaces/:workspace_id/status_pages.json
Luo tilasivu
status_pages_create
Luo työtilalle julkisen tilasivun, joka näyttää valitut käytettävyystarkistukset, häiriöviestit ja sähköpostitilauslomakkeen. Pakollinen on name (enintään 100 merkkiä). slug (pieniä kirjaimia, numeroita ja tavuviivoja, yksilöllinen kaikkien työtilojen kesken) johdetaan oletuksena nimestä ja sivu tarjoillaan osoitteessa /status/<slug>. check_ids listaa näytettävät käytettävyystarkistukset (upc_...-tunnukset uptime_checks_list-kutsusta) ja vain tarkistukset, jotka on luotu arvolla public true, hyväksytään. published on oletuksena true, joten sivu on heti kaikkien nähtävissä. Valinnainen brändäys on description (enintään 2 000 merkkiä), logo_url (on oltava https), brand_color (heksa, kuten #06755b) ja custom_domain (isäntänimi, jonka CNAME osoittaa sovellukseen, yksilöllinen). Käytä status_page_posts_create-kutsua häiriöiden julkaisuun jälkeenpäin. Vaatii uptime.manage-oikeuden. Palauttaa sivun kentillä id (sp_...), slug, check_ids ja subscribers (vahvistettujen tilaajien määrä). Paketti määrää, kuinka monta sivua työtilalla on: ei yhtään Free-paketissa (402 plan_limit), 1 Pro-paketissa ja 10 Business-paketissa. custom_domain ja sähköpostitilaajat vaativat Business- tai Enterprise-paketin. Paketin määrän ylittävät sivut säilytetään ja ne ovat offline-tilassa.
Oikeus: uptime.manage
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
Poista tilasivu
status_pages_delete
Poistaa tilasivun pysyvästi yhdessä kaikkien sen häiriöviestien ja tilaajien kanssa. Julkinen sivu ja sen oma verkkotunnus lakkaavat toimimasta heti, eikä tätä voi perua. Itse käytettävyystarkistuksia ei poisteta. id tulee status_pages_list-kutsusta. Vaatii uptime.manage-oikeuden. Palauttaa poistetun sivun.
Oikeus: uptime.manage
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
Listaa tilasivut
status_pages_list
Listaa työtilan tilasivut nimen mukaan lajiteltuina. Käytä query-arvoa täsmätäksesi nimen tai slug-arvon osaan. Kun kutsuja on rajattu joihinkin sivustoihin, palautetaan vain sivut, joiden kaikki tarkistukset kuuluvat näille sivustoille. Sivutettu page- ja per_page-arvoilla (enintään 100). Jokaisella kohteella on status_pages_get-kutsussa kuvatut kentät. Tarvitsee workspace_id-arvon workspaces_list-kutsusta.
Oikeus: analytics.read
curl https://privatusanalytics.com/workspaces/:workspace_id/status_pages.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/status_pages/:id.json
Hae tilasivu
status_pages_get
Palauttaa yhden tilasivun asetuksineen. Kenttiä ovat id (sp_...), workspace_id, name, slug, custom_domain (null kun ei ole), description, logo_url, brand_color, published, check_ids (sivulla näytettävien käytettävyystarkistusten tunnukset), subscribers (vahvistettujen sähköpostitilaajien määrä) ja created_at. Käytä status_page_posts_list-kutsua sen häiriöihin ja status_page_subscribers_list-kutsua ihmisiin. id tulee status_pages_list-kutsusta.
Oikeus: analytics.read
curl https://privatusanalytics.com/status_pages/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/status_pages/:id.json
Muuta tilasivua
status_pages_update
Muuttaa tilasivua. Vain lähettämäsi syötteet muuttuvat, joten lähetä pelkkä published false ottaaksesi sivun pois käytöstä tai check_ids korvataksesi näytetyt tarkistukset (koko lista korvataan, ei yhdistetä). Syötteet ja niiden rajat ovat samat kuin status_pages_create-kutsussa. Lähetä custom_domain tyhjänä merkkijonona poistaaksesi oman verkkotunnuksen. Vain tarkistukset arvolla public true voidaan näyttää, ja vain joihinkin sivustoihin rajattu kutsuja voi lisätä sivulle vain näiden sivustojen tarkistuksia. id tulee status_pages_list-kutsusta. Vaatii uptime.manage-oikeuden. Palauttaa päivitetyn sivun.
Oikeus: uptime.manage
curl -X PATCH https://privatusanalytics.com/status_pages/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Tilaukset
DELETE
/sites/:site_id/subscriptions/connections/:provider.json
Katkaise yhteys maksupalveluun ja poista sen avain ja tilaustiedot
subscriptions_disconnect
Katkaisee maksupalveluntarjoajan (stripe, paddle, lemon_squeezy, chargebee tai polar) yhteyden sivustoon ja poistaa pysyvästi tallennetun API-avaimen ja jokaisen siitä luetun tilausrivin. Tätä ei voi perua, ja MRR-, churn- ja kohorttiluvuista poistuvat heti kyseisen palveluntarjoajan tilaukset. Epäonnistuu, jos kyseistä palveluntarjoajaa ei ole yhdistetty. Palauttaa poistetun yhteyden. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Lue tilaukset maksupalvelusta nyt
subscriptions_sync
Jonottaa välittömän tilausten synkronoinnin yhdeltä yhdistetyltä palveluntarjoajalta (stripe, paddle, lemon_squeezy, chargebee tai polar) säännöllistä aikataulua odottamatta. Palaa heti (HTTP 202) yhteyden kanssa ja synkronointi suoritetaan taustalla. Kysele subscriptions_report-kutsua tai tarkista yhteyden last_synced_at ja last_error. Raportit välimuistitetaan enintään 15 minuutiksi. Epäonnistuu, jos palveluntarjoajaa ei ole yhdistetty. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
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
Kohorttiruudukko: poistuma tai pysyvyys ensimmäisen maksun kuukauden mukaan
subscriptions_cohorts
Sivuston tilausten poistumakohorttiruudukko, yksi rivi ensimmäisen maksun kuukautta kohti. months on 6, 12 (oletus) tai 24 kohorttia. plan säilyttää vain yhden paketin tilaukset (katso plans kohdassa subscriptions_report). metric on subscriptions (lukumäärä) tai mrr (raha). view on churn (osuus, joka oli päättynyt kyseiseen kohtaan mennessä, oletus) tai retention (osuus, joka on yhä käynnissä). Palauttaa metric, view, months, plan (suodatin tai null), currency ja cohorts, kussakin month (YYYY-MM), size (tilaukset tai MRR sivuston valuutan pienimmissä yksiköissä) ja cells, joissa jokaisella solulla on offset (kuukautta kohorttikuukaudesta, 0 on ensimmäinen), retained (sama yksikkö kuin size) ja percent (0 - 100, null tyhjälle kohortille). Kokeilut, jotka eivät koskaan maksaneet, eivät ole missään kohortissa. Pääluvuille MRR, ARR ja churn käytä subscriptions_report-kutsua. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/subscriptions/cohorts.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/subscriptions.json
Tilausmittarit: MRR, ARR, MRR-liikkeet, poistuma, tuoton säilyvyys, kokeilujaksot, paketit ja ennuste
subscriptions_report
Sivuston tilausmittarit luettuna sen yhdistetystä Stripe-, Paddle-, Lemon Squeezy -, Chargebee- tai Polar-tilistä. months on 6, 12 (oletus) tai 24. plan säilyttää vain yhden paketin tilaukset, nimettynä kuten plans ne listaa. Rahakentät ovat kokonaislukuja sivuston valuutan pienimmissä yksiköissä (vastauksen currency), ja muut valuutat muunnetaan tämän päivän kurssilla. Tuloksessa on currency, connected (false, kun palveluntarjoajaa ei ole yhdistetty), plan (pakettisuodatin tai null), connections (yksi yhdistettyä palveluntarjoajaa kohti kentillä provider, account_name, sandbox, status, last_error, last_synced_at ja created_at, ei koskaan avainta), skipped_currencies (valuutat ilman kurssia, joiden rahaa ei lasketa), totals, series, forecast ja plans. totals sisältää mrr_minor, arr_minor, previous_mrr_minor (MRR 30 päivää sitten), active_subscriptions, arpa_minor (null ilman tilauksia), trialing, trial_conversion_rate (prosentti kokeiluista, jotka päättyivät viimeisen 90 päivän aikana ja maksoivat, null kun mikään ei päättynyt) ja viimeiselle 30 päivälle new_subscriptions, new_mrr_minor, expansion_mrr_minor, contraction_mrr_minor, churned_subscriptions, churned_mrr_minor, net_new_mrr_minor, quick_ratio (uusi ja laajentuva MRR jokaista menetetyn ja supistuvan MRR:n yksikköä kohti, null kun mitään ei menetetty), subscription_churn_rate ja mrr_churn_rate (prosentti, null ilman pohjaa). Mukana ovat myös net_revenue_retention ja gross_revenue_retention (prosentti siitä, minkä 12 kuukautta sitten maksaneet tilaukset maksoivat silloin ja maksavat nyt, päivitysten kanssa ja ilman, null ilman pohjaa) sekä forecast_mrr_minor (MRR 12 kuukauden päästä, null ilman ennustetta). series sisältää yhden rivin kuukautta kohti (month muodossa YYYY-MM) kentillä mrr_minor, active_subscriptions, samat liikekentät ja churn_rate. forecast sisältää yhden rivin kuukautta kohti seuraavalle 12 kuukaudelle (month, mrr_minor), ennustettuna kolmen viimeisen täyden kuukauden pohjalta, ja on tyhjä, jos kolmea täyttä kuukautta, jotka alkoivat MRR:llä, ei ole. plans listaa enintään 50 pakettia MRR:n mukaan kentillä plan (null tilauksille, joille palveluntarjoaja ei antanut paketin nimeä), mrr_minor, active_subscriptions, churned_subscriptions ja subscription_churn_rate (viimeiset 30 päivää), aina jokaiselle paketille. Tilaus lasketaan ensimmäisestä maksusta alkaen. Päivitykset ja alennukset tasolta toiselle tiedetään ensimmäisestä synkronoinnista alkaen, ja sitä ennen menneet kuukaudet käyttävät hintaa, joka tilauksella oli, kun se luettiin ensimmäisen kerran. Säilyvyyteen ensimmäisen maksun kuukauden mukaan käytä subscriptions_cohorts-kutsua. Vaatii analytics.read-oikeuden.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/subscriptions.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Tili
GET
/account.json
Hae profiilisi ja asetuksesi
account_get
Palauttaa kirjautuneen jäsenen oman profiilin ja asetukset. Käytä sitä asetusten lukemiseen ennen niiden muuttamista account_update-kutsulla. Tämä koskee henkilöä, ei työtilaa. Työtilan paketti ja laskut löytyvät billing_get-kutsusta. Kentät ovat email, unconfirmed_email (asetettu, kun sähköpostin vaihto odottaa vahvistusta, muuten null), name (voi olla null), theme (system, light tai dark), default_landing (sites tai last_site), locale (kirjautuneen sovelluksen kielikoodi), timezone (IANA-nimi, voi olla null), shortcuts_enabled, reduce_motion, product_emails, site_audit_emails, marketing_emails, newsletter (kaikki totuusarvoja, joissa true tarkoittaa tilausta), two_factor (totuusarvo), passkeys (rekisteröityjen pääsyavainten määrä) ja created_at (ISO 8601). Pelkästään työtilan identiteetintarjoajan kautta avattu istunto näkee vain email-kentän ja näyttöasetukset.
Oikeus: member
curl https://privatusanalytics.com/account.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/account.json
Päivitä profiilisi ja asetuksesi
account_update
Päivittää kirjautuneen jäsenen oman profiilin, näyttöasetukset ja sähköpostitilaukset. Vain lähettämäsi syötteet muuttuvat, kaikki muu pysyy ennallaan. Sähköpostiosoitteen vaihto ei tule voimaan heti. Uuteen osoitteeseen lähetetään vahvistusviesti (nopeusrajoitettu), ja unconfirmed_email näyttää odottavan osoitteen, kunnes se vahvistetaan. API-tunnisteilla ei voi vaihtaa sähköpostiosoitetta eikä kytkeä marketing_emails-asetusta takaisin päälle peruutuksen jälkeen, molemmat vaativat kirjautuneen selaimen. marketing_emails-asetuksen kytkeminen pois on sallittua. Työtilan identiteetintarjoajan avaamat istunnot saavat muuttaa vain näyttöasetuksia (theme, default_landing, locale, timezone, shortcuts_enabled, reduce_motion). Palauttaa päivitetyn tilin samassa muodossa kuin account_get. Tämä ei poista tiliä eikä voi muuttaa työtilan asetuksia.
Oikeus: member
curl -X PATCH https://privatusanalytics.com/account.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Tuonnit
DELETE
/sites/:site_id/imports/google/connection.json
Katkaise Google Analytics -tilisi yhteys ja poista tallennetut käyttöoikeustunnisteet
imports_google_disconnect
Poistaa kutsuvan jäsenen tallennetun Google Analytics -yhteyden tämän sivuston työtilalle, joten GA4-tuonnit eivät voi enää lukea Googlesta, ennen kuin yhteys luodaan uudelleen sovelluksessa. Jo tuotu data säilyy ja poistetaan vain poistamalla sen tuonti imports_delete-kutsulla. Valtuutusta ei peruuteta Googlen puolella. Se epäonnistuu validointivirheeseen, kun yhteyttä ei ole tai kun jokin jäsenen GA4-tuonneista on jonossa tai käynnissä. Palauttaa objektin, jossa disconnected on true. Yhdistäminen tehdään sovelluksessa (Googlen kirjautumisnäkymä), siihen ei ole työkalua.
Oikeus: sites.manage
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
Listaa tuotavat Google Analytics 4 -ominaisuudet
imports_google_properties
Listaa Google Analytics 4 -ominaisuudet, joita kutsuvan jäsenen yhdistetty Google-tili voi lukea. Kutsu sitä ennen imports_create-kutsua lähteellä ga4 saadaksesi käytettävän property_id-arvon. Palauttaa listan objekteja kentillä id (kuten properties/123456789, anna se property_id-arvona), name ja account. Se epäonnistuu validointivirheeseen, kun jäsen ei ole yhdistänyt Googlea tälle työtilalle (tehdään sovelluksessa, siihen ei ole työkalua) tai kun Google hylkää pyynnön. Se tekee live-kutsun Googleen eikä muuta mitään.
Oikeus: sites.manage
curl https://privatusanalytics.com/sites/:site_id/imports/google/properties.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/imports.json
Aloita tuonti (GA4-ominaisuus tai CSV-lataus)
imports_create
Aloittaa historiadatan tuonnin toisesta analytiikkatyökalusta sivustolle, käsiteltynä taustalla, ja palauttaa tuonnin tilassa queued. Valitse lähde ga4 hakeaksesi Google Analytics 4 -API:sta, mikä vaatii sovelluksessa tehdyn Google-yhteyden, property_id-arvon (imports_google_properties-kutsusta) ja date_from-arvon. date_to on oletuksena päivä ennen sivuston ensimmäistä seurattua tapahtumaa tai eilinen. Muut lähteet (universal_analytics, fathom, simple_analytics, plausible, matomo, umami, clicky) ottavat vastaan CSV-viennin, joka ladataan file-syötteenä (multipart-lomakelataus, enintään 50 Mt), mikä tekee niiden aloittamisesta MCP:n kautta epäkäytännöllistä ja ne on parasta tehdä sovelluksessa. dimension tarvitaan vain ohittamaan sen tunnistus, mitä CSV-rivit erittelevät, esimerkiksi Matomon Label-viennit. Tuodut rivit eivät koskaan lasketa tapahtumakiintiöön ja näkyvät tilastoissa vain, kun annat include_imported true. Työtilalla voi olla enintään 5 tuontia jonossa tai käynnissä kerrallaan. Kysele imports_get-kutsua, kunnes status on complete tai failed. Vaatii sites.manage-oikeuden.
Oikeus: sites.manage
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
Poista tuonti ja kaikki sen tuodut tiedot
imports_delete
Poistaa tuonnin pysyvästi yhdessä jokaisen sen tuoman rivin ja ladatun tiedoston kanssa. Tilastot, jotka sisälsivät tuodun datan, muuttuvat heti, kun include_imported on päällä, eikä tätä voi perua, vaikka voit tuoda uudelleen. id tulee imports_list-kutsusta ja tarvitsee site_id-arvon. Palauttaa poistetun tuonnin. Vaatii sites.manage-oikeuden. Seurantakoodin keräämään dataan ei kosketa.
Oikeus: sites.manage
· Vain HTTP (ei MCP-työkalu)
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
Listaa sivuston tuonnit
imports_list
Listaa sivuston tuonnit uusin ensin. Käytä sitä löytääksesi tuonnin id:n tai tarkistaaksesi, onko jokin vielä käynnissä. Suodata halutessasi status-arvolla (queued, running, complete tai failed). Sivutettu page- ja per_page-arvoilla (enintään 100). Jokaisella kohteella on id, site_id, source, status, date_from, date_to, rows_imported, error, completed_at ja created_at. Katso lisätietoja imports_get-kutsusta ja aloita tuonti imports_create-kutsulla.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/imports.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/imports/:id.json
Hae tuonti ja sen tila
imports_get
Palauttaa yhden sivuston tuonnin, käytetään imports_create-kutsulla aloitetun tuonnin kyselyyn. Kenttiä ovat id (imp_...), site_id, source, status (queued, running, complete tai failed), date_from ja date_to (YYYY-MM-DD, null kun tuntematon), rows_imported (tuotujen päiväkohtaisten rivien määrä), error (asetettu epäonnistuessa), completed_at ja created_at. id tulee imports_create- tai imports_list-kutsusta. Tuodut rivit näkyvät tilastoissa vain, kun tilastokutsu asettaa include_imported arvoon true.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/imports/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Työtilat
GET
/workspaces/:workspace_id/white_label.json
Hae white label -brändi
white_label_get
Palauttaa työtilan white label -brändäyksen. Kenttiä ovat workspace_id (ws_...), brand_name, brand_logo_url ja brand_color (heksaväri, kuten #06755b), kukin null kun ei ole asetettu, hide_branding, available (true, kun paketti sisältää white labelin, eli Business ja sitä ylemmät) ja active (true, kun brändäys on asetettu ja voimassa). Brändäys korvaa Privatus Analytics -nimen jaetuissa koontinäkymissä, upotuksissa, tilasivuilla ja sähköpostiraporteissa. Vaatii workspace.manage-oikeuden.
Oikeus: workspace.manage
curl https://privatusanalytics.com/workspaces/:workspace_id/white_label.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/workspaces/:workspace_id/white_label.json
Aseta white label -brändi jaetuille koontinäkymille ja sähköpostiraporteille (Business)
white_label_update
Asettaa työtilan white label -brändäyksen. Vain Business-paketti, muuten se epäonnistuu pakettivirheeseen. Vain lähettämäsi syötteet muuttuvat, ja tyhjä merkkijono tyhjentää arvon brand_name, brand_logo_url tai brand_color. brand_logo_url on oltava https-URL kuvaan ja brand_color heksaväri, kuten #06755b. hide_branding true poistaa Privatus Analytics -linkin jaetuista koontinäkymistä, upotuksista ja tilasivuilta sekä logon sähköpostiraporteista. Muutos koskee heti olemassa olevia jakolinkkejä. Vaatii workspace.manage-oikeuden. Palauttaa brändäyksen (katso white_label_get).
Oikeus: workspace.manage
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
Hae työtilan tietoturva-asetukset
workspace_security_get
Palauttaa työtilan tietoturvakäytännön. Kenttiä ovat workspace_id (ws_...), enforce_2fa (jäsenten on käytettävä kaksivaiheista tunnistautumista), login_methods (sallitut arvoista password, magic_link, passkey, google, github ja sso), session_ttl_hours (uloskirjautuminen näin monen tunnin kuluttua, null ei rajaa), app_ip_allowlist (IP-osoitteet tai CIDR-alueet, joilta sovellusta ja API:a saa käyttää, tyhjä tarkoittaa mistä tahansa) ja support_access_until (ISO 8601 -aika, johon asti Privatus Analytics -tuki saa nähdä työtilan, null kun pääsyä ei ole myönnetty). Vaatii workspace.manage-oikeuden.
Oikeus: workspace.manage
curl https://privatusanalytics.com/workspaces/:workspace_id/security.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/workspaces/:workspace_id/security.json
Päivitä työtilan tietoturva-asetukset (2FA, kirjautumistavat, istunnon kesto, IP-sallintalista, tukipääsy)
workspace_security_update
Muuttaa työtilan tietoturvakäytäntöä, vain lähettämäsi syötteet. enforce_2fa true vaatii jokaista jäsentä käyttämään kaksivaiheista tunnistautumista ja vaatii Business-paketin. login_methods korvaa sallittujen listan arvoilla password, magic_link, passkey, google, github ja sso, ja menetelmän poistaminen kirjaa ulos jäsenten muistetut kirjautumiset, joten heidän on kirjauduttava uudelleen. session_ttl_hours kirjaa jäsenet ulos näin monen tunnin kuluttua (0 poistaa rajan). app_ip_allowlist korvaa listan IP-osoitteista tai CIDR-alueista, joilta sovellukseen ja API:in saa päästä (Business-paketti, tyhjä lista tarkoittaa mistä tahansa), ja se hylätään, jos se sulkisi pois kutsujan IP-osoitteen, joten et voi lukita itseäsi ulos. support_access true sallii Privatus Analytics -tuen nähdä työtilan 7 päivän ajan ja false peruu pääsyn. Vaatii workspace.manage-oikeuden. Palauttaa käytännön (katso workspace_security_get).
Oikeus: workspace.manage
· Vain HTTP (ei MCP-työkalu)
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
Luo työtila (sinusta tulee omistaja)
workspaces_create
Oikeus: member
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/workspaces.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
DELETE
/workspaces/:id.json
Poista työtila ja kaikki sen sivustot (vain omistaja, peruu tilauksen)
workspaces_delete
Poistaa työtilan kaikkine sivustoineen. Se on pehmeä poisto, kaikki katoaa heti ja tyhjennetään pysyvästi 7 päivän kuluttua, joten pidä sitä peruuttamattomana. Vain omistaja voi tehdä sen, ja confirm on oltava työtilan täsmällinen nimi (kirjainkoolla on merkitystä). Voimassa oleva maksullinen tilaus peruutetaan ensin heti, ja jos peruutus epäonnistuu, mitään ei poisteta. Työtilan odottavat sivustosiirrot peruutetaan. Jäsenet menettävät pääsynsä. Käytä workspaces_get-kutsua nimen lukemiseen. Vaatii workspace.manage-oikeuden ja owner-roolin. Palauttaa työtilan.
Oikeus: workspace.manage
· Vain HTTP (ei MCP-työkalu)
curl -X DELETE https://privatusanalytics.com/workspaces/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
GET
/workspaces.json
Listaa työtilasi
workspaces_list
Listaa työtilat, joihin kutsuja kuuluu, nimen mukaan järjestettyinä. API-tunniste tai MCP-yhteys näkee vain sen yhden työtilan, jolle se on myönnetty. Jokaisella kohteella on id (ws_..., jota useimmat työkalut käyttävät workspace_id-arvona), name, timezone, currency, plan, plan_events, subscription_status ja role (kutsujan rooli). Kutsu seuraavaksi sites_list-kutsua työtilan tunnuksella löytääksesi sivustojen tunnukset. Työtilan luominen on mahdollista vain sovelluksessa.
Oikeus: member
curl https://privatusanalytics.com/workspaces.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/workspaces/:id.json
Hae työtila
workspaces_get
Palauttaa yhden työtilan sen julkisella tunnuksella (ws_..., workspaces_list-kutsusta). Kenttiä ovat id, name, timezone (IANA-nimi), currency (ISO 4217), plan (free, pro, business tai enterprise), plan_events (paketin kuukausittainen tapahtumakiintiö), subscription_status (none, trialing, active, past_due, paused tai canceled), role (kutsujan rooli siinä) ja created_at. Käytä billing_get-kutsua täysiin laskutustietoihin ja billing_usage-kutsua tämän kuukauden käyttöön. Mikä tahansa jäsen voi lukea sen.
Oikeus: member
curl https://privatusanalytics.com/workspaces/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/workspaces/:id.json
Päivitä työtilan asetukset
workspaces_update
Muuttaa työtilan nimeä, oletusaikavyöhykettä tai oletusvaluuttaa, vain lähettämäsi syötteet. timezone on IANA-nimi, kuten Europe/Berlin, ja currency on 3-kirjaiminen ISO 4217 -koodi. Nämä ovat oletuksia uusille sivustoille, ne eivät muuta olemassa olevia sivustoja (käytä niihin sites_update-kutsua). Vaatii workspace.manage-oikeuden. Palauttaa työtilan (katso workspaces_get).
Oikeus: workspace.manage
curl -X PATCH https://privatusanalytics.com/workspaces/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Verkkosivusto
GET
/blog.json
Listaa blogikirjoitukset
blog_list
Listaa Privatus Analyticsin blogin kirjoitukset uusin ensin kentin slug, title, kicker, rubric (yhden lauseen tiivistelmä), description, path ja päivämäärät, ilman runkoa. Lue yksi kutsulla blog_get sen slug-arvolla. Sivutettu kentillä page ja per_page (enintään 100). Julkinen, ei vaadi tunnistautumista.
Oikeus: public
curl https://privatusanalytics.com/blog.json
GET
/blog/:slug.json
Lue blogikirjoitus (Markdown ja HTML)
blog_get
Palauttaa yhden blogikirjoituksen sen slug-arvolla (kutsusta blog_list, polun /blog/<slug> viimeinen osa) otsikkoineen, Markdown-runkoineen ja renderöityine HTML:ineen. Kirjoitukset on kirjoitettu englanniksi. Julkinen, ei vaadi tunnistautumista.
Oikeus: public
curl https://privatusanalytics.com/blog/:slug.json
GET
/changelog.json
Listaa muutoslokin merkinnät
changelog_list
Julkaistut tuotepäivitykset, uusin ensin. Saatavilla myös RSS-syötteenä osoitteessa /changelog.rss.
Oikeus: public
curl https://privatusanalytics.com/changelog.json
POST
/contact.json
Lähetä viesti Privatus Analytics -tiimille
contact_create
Selainasiakkaat lähettävät Cloudflare Turnstile -tunnisteen kentässä `cf-turnstile-response`. API-tunnisteella tehtävät pyynnöt eivät tarvitse sitä.
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/contact.json \
-H "Content-Type: application/json" -d '{…}'
POST
/newsletter/confirm.json
Vahvista uutiskirjeen tilaus (allekirjoitettu tunniste)
newsletter_confirm
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/newsletter/confirm.json \
-H "Content-Type: application/json" -d '{…}'
POST
/newsletter.json
Tilaa uutiskirje sähköpostiosoitteella
newsletter_subscribe
Selainasiakkaat lähettävät Cloudflare Turnstile -tunnisteen kentässä `cf-turnstile-response`. API-tunnisteella tehtävät pyynnöt eivät tarvitse sitä.
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/newsletter.json \
-H "Content-Type: application/json" -d '{…}'
POST
/newsletter/unsubscribe.json
Peruuta tilaus allekirjoitetulla linkkitunnisteella
newsletter_unsubscribe
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/newsletter/unsubscribe.json \
-H "Content-Type: application/json" -d '{…}'
GET
/pricing.json
Hae paketit, hinnat ja pakettien rajat
pricing_get
Samat tiedot kuin hinnoittelusivulla: tapahtumaportaat, jokainen pakettiraja ja se, mikä lasketaan tapahtumaksi. Anna events saadaksesi vastaavan tason.
Oikeus: public
curl https://privatusanalytics.com/pricing.json
GET
/status.json
Hae järjestelmän nykyinen tila
status_get
Tietokannan, Redisin ja taustatöiden kunto, tarkistetaan enintään 15 sekunnin välein.
Oikeus: public
curl https://privatusanalytics.com/status.json
GET
/tools/consent-gap.json
Arvioi suostumukseen perustuvan analytiikan ohittama liikenne
tools_consent_gap
Ilmainen laskuri, joka arvioi, kuinka paljon liikennettä evästesuostumusta käyttävä analytiikkatyökalu jättää huomaamatta verrattuna evästeettömään seurantaan. Se on yksinkertainen malli, ei mittaus. Syötteet ovat monthly_visitors (kokonaisluku yli 0), consent_rate (prosentti kävijöistä, jotka hyväksyvät bannerin, 0 - 100) ja adblock_share (prosentti, joiden estäjät pysäyttävät skriptin, 0 - 100, oletus 25). Palauttaa syötteet sekä measured_with_consent (kävijät, jotka suostumustyökalu näkee), missed (kävijät, joita se ei näe), missed_percent (yksi desimaali), measured_cookieless (kävijät, jotka tavoitetaan ilman banneria) ja recovered_by_cookieless (kävijät, jotka saadaan lisää suostumusseurantaan verrattuna). Kaikki kävijämäärät ovat kokonaislukuja. Se ei tee pyyntöjä eikä käytä tilin dataa. Julkinen, ei vaadi tunnistautumista.
Oikeus: public
curl https://privatusanalytics.com/tools/consent-gap.json
GET
/tools/header-checker.json
Tarkista sivun Referrer-Policy ja CSP analytiikkaa varten
tools_header_check
Hakee yhden julkisen sivun ja tarkistaa vastausotsikot, jotka vaikuttavat analytiikkaan. Käytä sitä, kun seurantadataa puuttuu tai viittaajat näyttävät väärin. Se tarkastelee Referrer-Policy-otsikkoa, Content-Security-Policy-säännön script-src- ja connect-src-direktiivejä (saako Privatus Analytics ladata ja lähettää dataa), Permissions-Policy-otsikkoa ja Set-Cookie-otsikoiden määrää. Palauttaa url (lopullinen URL enintään 3 uudelleenohjauksen jälkeen), status (HTTP-tila) ja findings, kussakin check, value (voi olla null), level (ok, warn tai info) ja selkokielinen huomautus. URL:n on oltava http tai https ja julkinen, yksityiset ja sisäiset osoitteet hylätään, vain ensimmäinen 1 Mt luetaan ja haku aikakatkaistaan 5 sekunnin kuluttua. Nopeusrajoitettu 10 kutsuun minuutissa asiakasta kohti. Julkinen, ei vaadi tunnistautumista.
Oikeus: public
curl https://privatusanalytics.com/tools/header-checker.json
GET
/tools/privacy-policy-generator.json
Luonnostele tietosuojakäytännön kappale Privatus Analyticsille
tools_privacy_policy
Luonnostelee tietosuojaselosteen kappaleen, joka kuvaa, miten Privatus Analytics kerää dataa asiakkaan sivustolla (evästeetön, henkilötietoja ei tallenneta, sijainti vain maan tarkkuudella). Se on lähtökohta, ei oikeudellista neuvontaa. Syötteet ovat site_name (enintään 120 merkkiä), contact_email (valinnainen, lisää yhteystietolauseen) ja honors_gpc (oletus true, lisää lauseen, jonka mukaan Do Not Track ja Global Privacy Control otetaan huomioon). Palauttaa site_name, paragraphs (merkkijonojen taulukko), text (kappaleet yhdistettynä tyhjillä riveillä, ja Privatus Analyticsin osoite sulkeissa nimen perässä) ja html (kappaleet <p>-elementteinä, ja nimi tavallisena linkkinä). Teksti kirjoitetaan pyynnön kielellä, oletuksena englanniksi. Se ei muuta mitään tiliä. Julkinen, ei vaadi tunnistautumista.
Oikeus: public
curl https://privatusanalytics.com/tools/privacy-policy-generator.json
GET
/tools/qr-code.json
Luo QR-koodi SVG-muodossa
tools_qr_code
Luo QR-koodin SVG-kuvana painoon tai julisteisiin. Yhdistä se linkkiin, jossa on UTM-parametrit tools_utm_builder-kutsusta. Syötteet ovat text (URL tai teksti, enintään 1 000 merkkiä) ja level (virheenkorjaus l, m, q tai h, oletus m, korkeampi kestää enemmän vaurioita mutta tarvitsee tiheämmän koodin). Palauttaa text, level, size (moduuleja sivua kohti) ja svg (itsenäinen SVG-dokumentti, musta valkoisella). Valitulle tasolle liian pitkä teksti hylätään. Seurattujen lyhytlinkkien QR-koodeihin käytä sen sijaan links_qr-kutsua. Julkinen, ei vaadi tunnistautumista.
Oikeus: public
curl https://privatusanalytics.com/tools/qr-code.json
GET
/tools/tracker-scanner.json
Listaa sivun evästeet ja tunnetut seurantatyökalut
tools_tracker_scan
Hakee yhden julkisen sivun ja listaa evästeet, joita se asettaa, ja tunnetut kolmannen osapuolen seurantakoodit, joihin se viittaa. Käytä sitä nopeaan tarkistukseen siitä, mitä sivu lataa, ennen suostumustavan valintaa. Se on vain HTML:n ja vastausotsikoiden staattinen skannaus, se ei suorita JavaScriptiä, joten skriptien asettamat evästeet ja myöhemmin tunnisteenhallinnan lataamat tunnisteet jäävät huomaamatta. Palauttaa url (lopullinen URL enintään 3 uudelleenohjauksen jälkeen), status, truncated (true, kun vain ensimmäinen 1 Mt luettiin), cookies (name, domain, path, expires, secure, http_only ja same_site, arvoja ei koskaan palauteta), trackers (name, category, match ja evidence, jossa category on advertising, analytics, session_recording, tag_manager, marketing tai privacy_analytics) ja third_party_hosts (muiden sivustojen isäntänimet lajiteltuina). URL:n on oltava julkinen http tai https, haun aikakatkaisu on 5 sekuntia ja kutsut on rajattu 10 minuutissa asiakasta kohti. Julkinen, ei vaadi tunnistautumista.
Oikeus: public
curl https://privatusanalytics.com/tools/tracker-scanner.json
GET
/tools/utm-builder.json
Rakenna kampanja-URL UTM-parametreilla
tools_utm_builder
Rakentaa kampanja-URL-osoitteen UTM-parametreilla ja merkitsee yleiset virheet. Syötteet ovat url (on oltava http tai https), source, medium ja campaign (kaikki pakollisia) sekä valinnaiset term ja content. URL-osoitteessa jo olevat utm_-parametrit korvataan ja muut kyselyparametrit säilytetään. Palauttaa url (valmis linkki), params (lisätyt utm_-arvot, tyhjät jätetty pois) ja warnings (merkkijonoja arvoille, joissa on isoja kirjaimia, välilyöntejä tai tekstiä, joka näyttää sähköpostiosoitteelta tai pitkältä numerolta, joita ei koskaan pitäisi olla URL-osoitteessa). Käytä pieniä kirjaimia ilman välilyöntejä, jotta sama kampanja ei jakaudu raporteissa useille riveille. Se ei tallenna mitään. Julkinen, ei vaadi tunnistautumista.
Oikeus: public
curl https://privatusanalytics.com/tools/utm-builder.json
POST
/waitlist.json
Liity odotuslistalle (EU-palvelinsijainti)
waitlist_join
Selainasiakkaat lähettävät Cloudflare Turnstile -tunnisteen kentässä `cf-turnstile-response`. API-tunnisteella tehtävät pyynnöt eivät tarvitse sitä.
Oikeus: public
· Vain HTTP (ei MCP-työkalu)
curl -X POST https://privatusanalytics.com/waitlist.json \
-H "Content-Type: application/json" -d '{…}'
Viennit
POST
/workspaces/:workspace_id/exports.json
Lisää vienti jonoon (luodaan taustalla)
exports_create
Jonottaa taustalla rakennettavan dataviennin ja palauttaa sen heti tilassa queued. Valitse se, kun tarvitset tiedoston (CSV, JSON, XLSX, NDJSON tai ZIP koontinäkymän paneeleista), ja käytä ensin exports_preview-kutsua tarkistaaksesi sarakkeet ja koon luomatta mitään. Kevyisiin lukuihin käytä sen sijaan tilastotyökaluja. Pakolliset syötteet ovat workspace_id (polku), site_id, from ja to (YYYY-MM-DD, mukaan lukien, viennin aikavyöhykkeellä). kind ratkaisee, mitä viedään ja mitkä asetukset pätevät. aggregated (oletus) antaa käyntimittarit aikajaksoa kohti ja käyttää arvoja grouping, dimensions (enintään 6), metrics, filters ja segment_id. pageviews, events ja raw antavat yhden rivin osumaa kohti ja käyttävät arvoja fields, filters ja segment_id, vaativat Pro-paketin tai sitä ylemmän ja on rajattu 400 päivään (raw 93 päivään). imported antaa tuodut päivätilastot ja käyttää vain dimensions-arvoa. dashboard antaa ZIP-paketin yleisnäkymän paneeleista (vain format zip). Sallitut file_format-arvot lajeittain ovat csv, json tai xlsx lajeille aggregated, pageviews, events ja imported, csv tai ndjson lajille raw ja zip lajille dashboard. Valittuun lajiin soveltumattomat asetukset ohitetaan. Työtilalla voi olla enintään 5 vientiä jonossa tai käynnissä kerrallaan. Vastaus on vienti kentillä id (exp_...), status, row_count ja expires_at (null kunnes rakennettu). Kysele exports_get-kutsua, kunnes status on complete, ja kutsu sitten exports_download-kutsua. Pyynnön tehnyt käyttäjä saa sähköpostin, kun se on valmis, export.ready-webhook lähetetään ja toimenpide kirjataan tarkastuslokiin. props-sarakkeen tapahtumaominaisuudet sisältävät vain ominaisuudet, jotka on merkitty vientiturvallisiksi (katso event_properties_list).
Oikeus: analytics.export
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
Poista vienti ja sen tiedosto
exports_delete
Poistaa viennin ja sen luodun tiedoston pysyvästi. Latauslinkki lakkaa toimimasta heti, eikä tätä voi perua, mutta voit luoda viennin uudelleen. Käytä sitä poistaaksesi valmiin tai epäonnistuneen viennin, jota et enää tarvitse, koska tiedostot poistetaan myös automaattisesti 7 päivää rakentamisen jälkeen. id tulee exports_list-kutsusta. Palauttaa poistetun vientiobjektin sellaisena kuin se oli ennen poistoa.
Oikeus: analytics.export
· Vain HTTP (ei MCP-työkalu)
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
Hae allekirjoitettu linkki tiedostoon (voimassa 10 minuuttia)
exports_download
Palauttaa lyhytikäisen latauslinkin valmiiseen vientiin. Valitse se, kun exports_get näyttää tilan complete. Vastauksessa on url (allekirjoitettu linkki, joka on voimassa 10 minuuttia, hae se heti), expires_at (milloin linkki lakkaa toimimasta, ISO 8601), filename ja byte_size (tavuina). Se epäonnistuu not found -virhekoodilla expired, kun vienti on yli 7 päivää vanha, ja validointivirheellä, kun vienti on yhä jonossa tai käynnissä tai kun se epäonnistui (virheviesti kertoo syyn). Kutsu sitä uudelleen saadaksesi tuoreen linkin niin kauan kuin itse vienti ei ole vanhentunut. id tulee exports_list-kutsusta.
Oikeus: analytics.export
curl https://privatusanalytics.com/exports/:id/download.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/workspaces/:workspace_id/exports.json
Listaa viennit (työjono)
exports_list
Listaa työtilan viennit sivustoille, joihin pääset, uusin ensin. Käytä sitä löytääksesi viennin id:n, tarkistaaksesi, mitkä viennit ovat vielä käynnissä, tai nähdäksesi, mitkä ovat vanhentuneet. Suodata arvoilla site_id, status (queued, running, complete, failed tai expired) ja kind (aggregated, pageviews, events, imported, raw tai dashboard). Sivutettu page- ja per_page-arvoilla (enintään 100), ja palauttaa data-listan vienneistä (kentät ovat exports_get-kutsussa) sekä sivutuksen meta-tiedot. Tarvitsee workspace_id-arvon workspaces_list-kutsusta.
Oikeus: analytics.export
curl https://privatusanalytics.com/workspaces/:workspace_id/exports.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/workspaces/:workspace_id/exports/preview.json
Esikatsele vientiä: 20 ensimmäistä riviä ja arvioitu rivimäärä
exports_preview
Viennin kuivaharjoitus, joka ei luo mitään. Se ottaa samat syötteet kuin exports_create ja palauttaa kind, file_format, columns (sarakkeiden nimet järjestyksessä), rows (enintään 20 esimerkkiriviä sarakkeella avainnettuina objekteina) ja estimated_rows (koko tiedoston likimääräinen rivimäärä). dashboard-lajille esimerkkirivit listaavat jokaisen tiedostonimen rivimäärineen. Käytä sitä validoidaksesi dimensiot, kentät, suodattimet ja päivämääräalueen sekä nähdäksesi, kuinka suuri vienti olisi, ennen exports_create-kutsua. Se suoritetaan synkronisesti, joten pidä päivämääräalue kohtuullisena. Validointivirheet ovat samat kuin exports_create-kutsussa, mukaan lukien Pro-paketin vaatimus rivitason lajeille. Mitään ei tallenneta eikä sähköpostia lähetetä.
Oikeus: analytics.export
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
Hae vienti ja sen tila
exports_get
Palauttaa yhden viennin edistymisineen. Käytä sitä exports_create-kutsulla aloitetun viennin kyselyyn, kunnes status on complete tai failed. Tilat ovat queued, running, complete, failed ja expired. Kenttiä ovat id (exp_...), site_id (pa_...), kind, format, status, params (viennin tallennettu määritys), row_count (null kunnes valmis), error (asetettu epäonnistuessa), completed_at, expires_at (tiedostot säilytetään 7 päivää valmistumisen jälkeen), download_url (asetettu vain niin kauan kuin tiedoston voi ladata, käytä exports_download-kutsua allekirjoitetun linkin hakemiseen) ja created_at. id tulee exports_create- tai exports_list-kutsusta.
Oikeus: analytics.export
curl https://privatusanalytics.com/exports/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
Wall of Love -seinät
POST
/sites/:site_id/testimonials/walls.json
Luo Wall of Love
testimonial_walls_create
Isännöity sivu osoitteessa https://privatus.page/w/<slug>. Pois jätetty alkaa oletuksesta: otsikko Wall of Love, masonry-asettelu ja slug nimestä.
Oikeus: content.write
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
Siirrä seinä roskakoriin
testimonial_walls_trash
Sen sivu vastaa, että se on poistettu näkyvistä, kunnes se palautetaan, ja upotettu kopio ei renderöi mitään. Palauttaminen tuo sen takaisin samaan osoitteeseen. Se poistetaan pysyvästi 30 päivän kuluttua. MCP:n kautta työkalu ei muuta mitään ja vastaa sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Kopioi seinä uudella nimellä ja osoitteella
testimonial_walls_duplicate
Tekee kopion uudella tunnisteella, nimellä, joka päättyy sanaan "copy", ja omalla slugilla, joten sillä on oma osoitteensa. Alkuperäistä ja sen osoitetta ei muuteta.
Oikeus: content.write
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
Hae seinän linkki ja koodi sen sijoittamiseksi toiselle sivulle
testimonial_walls_embed
Seinän julkinen osoite sekä skripti-, kehys- ja pelkkä linkkikoodi, jotka sijoittavat sen toiselle sivulle. Koodit eivät koskaan muutu, kun seinää muokataan.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/walls/:id/embed.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/testimonials/walls.json
Listaa sivuston Wall of Love -seinät
testimonial_walls_list
Sivuston jokainen Wall of Love, joka ei ole roskakorissa, osoitteineen, syötteineen ja näyttämiensä suositusten määrineen. Käytä q:ta hakuun nimen tai slugin mukaan ja sort-kenttää järjestämään nimen tai uusimman mukaan.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/walls.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/sites/:site_id/testimonials/walls/:id/restore.json
Palauta seinä roskakorista
testimonial_walls_restore
Ottaa seinän pois roskakorista. Sen sivu vastaa taas samassa osoitteessa, ja jokainen upotettu kopio näyttää sen taas ilman muutosta liitettyyn koodiin.
Oikeus: content.write
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
Hae yksi seinä kaikkine asetuksineen
testimonial_walls_get
Kaikki, mitä rakentaja tallentaa: osoite (/w/<slug>), otsikko ja painike, asettelu, mikä seinää syöttää, mitä kukin kortti näyttää, tyyli ja hakukoneasetukset. Roskakorissa oleva seinä vastaa 404.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/walls/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/testimonials/walls/:id.json
Muuta seinää
testimonial_walls_update
Vain lähetetyt syötteet muuttuvat. Muutettu slug jättää vanhan osoitteen uudelleenohjaamaan.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/walls/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Webhookit
GET
/workspaces/:workspace_id/webhooks/:webhook_id/deliveries.json
Listaa webhookin toimitukset
webhook_deliveries_list
Listaa yhdelle webhookille lähetetyt toimitukset (polku ottaa webhook_id-arvon) uusin ensin ja sivutettuna. Jokaisella on id (whd_...), event, status (pending, succeeded mille tahansa 2xx-vastaukselle tai failed), status_code (null kun vastausta ei tullut), error (lyhyt syy, kuten aikakatkaisu, muuten null), attempt (kuinka monta yritystä toistaiseksi), duration_ms, payload (lähetetty JSON-data), response_body (vastauksen ensimmäiset 2000 merkkiä) sekä delivered_at ja created_at. Suodata status-arvolla succeeded tai failed. Käytä sitä päätepisteen virheenjäljitykseen ja webhook_deliveries_redeliver-kutsua yhden lähettämiseen uudelleen.
Oikeus: workspace.manage
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
Lähetä toimitus uudelleen
webhook_deliveries_redeliver
Lähettää aiemman toimituksen sisällön uudelleen uutena toimituksena samaan päätepisteeseen (id whd_..., webhook_deliveries_list-kutsusta). Tämä tekee HTTP-pyynnön asiakkaan URL-osoitteeseen, joten vastaanottaja voi käsitellä saman tapahtuman kahdesti. Se on nopeusrajoitettu työtilaa kohti (jaettu webhooks_test-kutsun kanssa). Se jonotetaan, joten vastaus on uusi toimitus tilalla pending, lue webhook_deliveries_list-kutsu nähdäksesi lopputuloksen.
Oikeus: workspace.manage
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
Lisää webhook-päätepiste
webhooks_create
Lisää päätepisteen, joka vastaanottaa POST-lähetettyä JSON-dataa työtilan tapahtumista (polku ottaa workspace_id-arvon). url on oltava julkinen https-osoite, yksityiset ja sisäiset osoitteet hylätään. events on pakollinen lista, joka valitaan arvoista 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 ja site_audit.completed. enabled on oletuksena true. Allekirjoitussalaisuus (whsec_...) generoidaan ja palautetaan vastauksessa, ja jokaisessa toimituksessa on Privatus-Signature-otsikko, jossa on aikaleima ja sillä tehty rungon HMAC-SHA256. Epäonnistuneet toimitukset yritetään uudelleen viiveellä ja päätepiste poistetaan käytöstä 20 peräkkäisen epäonnistumisen jälkeen. Käytä webhooks_test-kutsua esimerkin lähettämiseen.
Oikeus: workspace.manage
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
Poista webhook
webhooks_delete
Poistaa webhook-päätepisteen ja sen koko toimituslokin. Tätä ei voi perua ja odottavat uudelleenyritykset lakkaavat. Jos haluat keskeyttää sen sen sijaan, käytä webhooks_update-kutsua arvolla enabled false. id (wh_...) tulee webhooks_list-kutsusta. Palauttaa poistetun webhookin.
Oikeus: workspace.manage
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
Listaa webhookit
webhooks_list
Listaa työtilan lähtevät webhook-päätepisteet (polku ottaa workspace_id-arvon) vanhin ensin. Jokaisella on id (wh_...), url, events (vastaanottamiensa tapahtumien nimet), enabled, status (active, failing viimeaikaisten epäonnistumisten jälkeen tai disabled), secret (allekirjoitussalaisuus, käsittele arkaluonteisena), consecutive_failures, last_success_at, last_failure_at ja created_at. Vaatii workspace.manage-oikeuden. Tämä on raakojen tapahtumien lähettämiseen omalle palvelimellesi. Ihmisten ilmoittamiseen käytä notification_channels_list-kutsua. Käytä webhook_deliveries_list-kutsua nähdäksesi, mitä lähetettiin.
Oikeus: workspace.manage
curl https://privatusanalytics.com/workspaces/:workspace_id/webhooks.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/workspaces/:workspace_id/webhooks/:id.json
Hae webhook
webhooks_get
Palauttaa yhden webhook-päätepisteen id:n perusteella (wh_..., webhooks_list-kutsusta), mukaan lukien sen allekirjoitussalaisuuden (whsec_...), jolla vahvistetaan Privatus-Signature-otsikko jokaisessa toimituksessa. Kenttiä ovat url, events, enabled, status (active, failing tai disabled), secret, consecutive_failures, last_success_at, last_failure_at ja created_at. Vaatii workspace.manage-oikeuden.
Oikeus: workspace.manage
curl https://privatusanalytics.com/workspaces/:workspace_id/webhooks/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
POST
/workspaces/:workspace_id/webhooks/:id/test.json
Lähetä testitoimitus
webhooks_test
Jonottaa webhook.test-toimituksen esimerkkiviestillä yhteen päätepisteeseen, vaikka se olisi poistettu käytöstä, mikä tekee HTTP-pyynnön asiakkaan URL-osoitteeseen. Se on nopeusrajoitettu työtilaa kohti (jaettu webhook_deliveries_redeliver-kutsun kanssa), eikä testiä yritetä uudelleen. Toimitus lähetetään taustalla, joten vastaus palauttaa jonotetun toimituksen tilalla pending. Lue webhook_deliveries_list-kutsu hetken kuluttua nähdäksesi status_code, error, duration_ms ja response_body.
Oikeus: workspace.manage
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
Päivitä webhook (tapahtumat, URL, käytössä, vaihda salaisuus)
webhooks_update
Muuttaa webhookia (id webhooks_list-kutsusta). Vain lähettämäsi syötteet muuttuvat. events-arvon lähettäminen korvaa koko listan. enabled true asettaminen käytöstä poistetulle päätepisteelle nollaa sen epäonnistumislaskurin, ja näin kytket takaisin päälle päätepisteen, joka poistettiin käytöstä toistuvien epäonnistumisten jälkeen. Aseta rotate_secret true generoidaksesi uuden allekirjoitussalaisuuden, joka näytetään vastauksessa, ja vanha lakkaa toimimasta heti, joten vastaanottaja on päivitettävä. url-säännöt ovat samat kuin webhooks_create-kutsussa. Palauttaa webhookin.
Oikeus: workspace.manage
curl -X PATCH https://privatusanalytics.com/workspaces/:workspace_id/webhooks/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Widgetit
POST
/sites/:site_id/testimonials/widgets/:id/copied.json
Merkitse, että widgetin liitetty HTML-upotus kopioitiin
testimonial_widgets_mark_copied
Liitetty HTML ei päivity itsestään. Tämän kutsun jälkeen testimonial_widgets_embed kertoo, kuinka monta kertaa widget on sen jälkeen muuttunut.
Oikeus: content.write
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
Luo widget
testimonial_widgets_create
Yksi kutsu sisältää koko widgetin: asettelun ja sen asetukset, mikä sitä syöttää, mitä kukin kortti näyttää ja miltä se näyttää. Pois jätetty alkaa oletuksesta, ja tyhjä tyyliasetus perii brändipaketin. Hae perään liitettävä koodi kutsulla testimonial_widgets_embed.
Oikeus: content.write
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
Siirrä widget roskakoriin
testimonial_widgets_trash
Sen upotukset eivät renderöi mitään eivätkä vie tilaa, kunnes se palautetaan. Se poistetaan pysyvästi 30 päivän kuluttua. MCP:n kautta työkalu ei muuta mitään ja vastaa sovelluksen sivulla, jossa henkilö tekee sen.
Oikeus: content.write
· Vain HTTP (ei MCP-työkalu)
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
Kopioi widget kaikkine asetuksineen
testimonial_widgets_duplicate
Tekee kopion uudella tunnisteella ja nimellä, joka päättyy sanaan "copy". Kopiolla on oma upotuskoodinsa, eikä sitä ole nähty livenä missään. Alkuperäistä ei muuteta.
Oikeus: content.write
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
Hae widgetin upotuskoodi ja sen paino
testimonial_widgets_embed
Palauttaa skriptikoodin (suositeltu), liitetyn HTML:n, kehyskoodin ja julkisen datan osoitteen sekä latausskriptin ja tämän widgetin mitatun koon. Liitetty HTML ja kehys ovat null kulman ponnahdusikkunalle.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/widgets/:id/embed.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/testimonials/widgets.json
Listaa sivuston widgetit
testimonial_widgets_list
Roskakorissa olevia widgetejä ei listata. Jokaisella widgetillä on asetukset, nyt näyttämiensä suositusten määrä, katselut ja klikkaukset viimeiseltä 30 päivältä sekä ensimmäinen sivu, jolla se nähtiin livenä.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/widgets.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
GET
/sites/:site_id/testimonials/widgets/:id/installs.json
Listaa sivut, joilla widget nähtiin livenä
testimonial_widgets_installs
Enintään 50 sivua, uusin ensin. Vain skripti ja kehys voidaan havaita.
Oikeus: analytics.read
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
Palauta widget roskakorista
testimonial_widgets_restore
Se palaa kaikkialle, minne se liitettiin.
Oikeus: content.write
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
Hae yksi widget kaikkine asetuksineen, sisältöineen ja käyttöpaikkoineen
testimonial_widgets_get
Kaikki, mitä rakentaja tallentaa: asettelu ja sen asetukset, mikä widgetiä syöttää (kokoelma, tallennettu näkymä, tunnisteet tai käsin valittu lista), mitä kukin kortti näyttää, tyyli, kieli ja arvostelumerkintä, sekä missä se nähtiin livenä ja montako suositusta se nyt näyttää. Roskakorissa oleva widget vastaa 404.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/widgets/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"
PATCH
/sites/:site_id/testimonials/widgets/:id.json
Muuta widgetiä
testimonial_widgets_update
Vain lähetetyt syötteet muuttuvat. Tallennettu muutos saavuttaa jokaisen sivuston, jolla widget on, koskematta niiden koodiin, koska sen välimuistikopiot tyhjennetään.
Oikeus: content.write
curl -X PATCH https://privatusanalytics.com/sites/:site_id/testimonials/widgets/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN" \
-H "Content-Type: application/json" -d '{…}'
Yksityinen palaute
GET
/sites/:site_id/testimonials/forms/:form_id/feedback.json
Listaa lomakkeen yksityinen palaute uusin ensin
testimonial_feedback_list
Yksityinen palaute on vastaus, jonka arvosana on 1-3, lomakkeella, jolla matalan arvosanan ohjaus on käytössä (Business-paketista ylöspäin). Se ei ole koskaan suositus, ei koskaan julkinen eikä koskaan lasketa.
Oikeus: analytics.read
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
Merkitse yksityinen palaute luetuksi tai lukemattomaksi uudelleen
testimonial_feedback_mark_read
Asettaa read_at yhdelle yksityiselle palautteelle tai tyhjentää sen arvolla read false. Jo luetun merkitseminen säilyttää ajan, jolloin se luettiin ensimmäisen kerran. Kirjoittajalle ei lähetetä mitään.
Oikeus: analytics.read
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
Hae yksi yksityinen palaute
testimonial_feedback_get
Palauttaa arvosanan, tekstin, henkilön antaman nimen ja milloin se luettiin. Yksityinen palaute on vastaus matalalla arvosanalla lomakkeella, jolla matalan arvosanan ohjaus on käytössä. Se ei ole koskaan suositus eikä koskaan julkinen.
Oikeus: analytics.read
curl https://privatusanalytics.com/sites/:site_id/testimonials/forms/:form_id/feedback/:id.json \
-H "Authorization: Bearer $PRIVATUS_TOKEN"