Analytics e session replay
Aggiungi 13 provider di analytics, session replay e identità al sito di documentazione con un blocco docs.json.
Jamdesk carica gli script di 13 provider aggiuntivi di analytics, session replay e identità direttamente da docs.json. Aggiungi il blocco del provider sotto integrations e Jamdesk inietta lo script in ogni pagina del sito di documentazione pubblicato.
Ogni valore viene verificato rispetto a un formato rigoroso prima che Jamdesk carichi lo script. Un valore con formato errato (caratteri aggiuntivi, prefisso errato o lunghezza errata) viene ignorato silenziosamente e non viene mai visualizzato: nessuna pagina di errore e nessun tag script non funzionante. Se un provider non viene caricato, copia nuovamente il valore dal relativo dashboard e confrontalo con il formato riportato di seguito.
Configurazione dal dashboard
Il modo più rapido per configurare uno di questi provider: Dashboard → Integrations. Seleziona la scheda di un provider, incolla la relativa chiave e Jamdesk esegue il commit del blocco docs.json per te, quindi avvia una nuova build (solo per i progetti connessi a GitHub). Le sezioni seguenti servono per modificare direttamente docs.json o per i progetti che usano solo la CLI.
PostHog
Analytics del prodotto, session replay e flag delle funzionalità.
Formato: la chiave API del progetto inizia con phc_, seguita da 8-64 lettere o numeri. L'host API opzionale deve essere un URL https://.
Trova la chiave in Settings → Project → Project API key in PostHog.
{
"integrations": {
"posthog": {
"apiKey": "phc_Kj8fPqZx92RmNbTeYcWs",
"apiHost": "https://us.i.posthog.com"
}
}
}apiHost è facoltativo e il valore predefinito è https://us.i.posthog.com. Impostalo sull'host cloud UE o sull'URL del reverse proxy, se ne utilizzi uno.
Mixpanel
Analytics degli eventi e funnel.
Formato: il token del progetto è composto esattamente da 32 caratteri esadecimali minuscoli (0-9, a-f).
Trova il token in Project Settings → Access Keys → Project Token in Mixpanel.
{
"integrations": {
"mixpanel": {
"projectToken": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
}
}Amplitude
Analytics del prodotto e coorti comportamentali.
Formato: la chiave API è composta esattamente da 32 caratteri esadecimali minuscoli (0-9, a-f).
Trova la chiave in Settings → Projects → your project → API Key in Amplitude.
{
"integrations": {
"amplitude": {
"apiKey": "f6e5d4c3b2a1908877665544332211ff"
}
}
}Hotjar
Mappe di calore e registrazioni delle sessioni.
Formato: l'ID del sito è composto da 1-12 cifre. La versione dello snippet è composta da 1-4 cifre (in genere 6).
Trova entrambi in Sites & Organizations → your site in Hotjar.
{
"integrations": {
"hotjar": {
"hjid": "3482910",
"hjsv": "6"
}
}
}Hotjar registra le sessioni dei visitatori. Se ai tuoi lettori si applicano il GDPR, il CCPA o normative simili, attivalo solo dopo il Cookie Consent.
Microsoft Clarity
Mappe di calore e registrazioni delle sessioni gratuite.
Formato: l'ID del progetto è composto da 4-32 lettere o numeri.
Trova l'ID del progetto in Settings → Overview → Project ID in Clarity.
{
"integrations": {
"clarity": {
"projectId": "qbxk2paw9m"
}
}
}Clarity registra le sessioni dei visitatori. Se ai tuoi lettori si applicano il GDPR, il CCPA o normative simili, attivalo solo dopo il Cookie Consent.
Fathom
Analytics senza cookie e con la privacy al primo posto.
Formato: l'ID del sito è composto da 4-16 lettere o numeri.
Trova l'ID del sito in Settings → Sites → your site in Fathom.
{
"integrations": {
"fathom": {
"siteId": "ABCD1234"
}
}
}Pirsch
Analytics senza cookie e rispettose della privacy.
Formato: il codice identificativo è composto da 4-64 lettere o numeri.
Trova il codice in Settings → Developer → Identification Code in Pirsch.
{
"integrations": {
"pirsch": {
"id": "Jd8fK2pQmZx9AeRt"
}
}
}Heap
Acquisizione automatica degli eventi, senza strumentazione manuale.
Formato: l'ID dell'app è composto da 6-20 cifre.
Trova l'ID dell'app in Account → Manage → Projects in Heap.
{
"integrations": {
"heap": {
"appId": "1234567890"
}
}
}LogRocket
Session replay con log della console e della rete.
Formato: l'ID dell'app è composto da due segmenti slug separati da una barra — org-slug/app-slug — ciascuno formato da 2-64 lettere minuscole, numeri o trattini.
Trova l'ID dell'app in Settings → Project Setup in LogRocket.
{
"integrations": {
"logrocket": {
"appId": "acme-inc/docs-site"
}
}
}LogRocket registra le sessioni dei visitatori, comprese le attività della console e della rete. Se ai tuoi lettori si applicano il GDPR, il CCPA o normative simili, attivalo solo dopo il Cookie Consent.
Segment
Instrada gli eventi della documentazione a ogni strumento downstream da un'unica origine.
Formato: la chiave di scrittura è composta da 10-64 lettere o numeri (senza trattini o trattini bassi).
Trova la chiave di scrittura in Connections → Sources → your JS source → Settings → API Keys in Segment.
{
"integrations": {
"segment": {
"key": "hcQ8wK9pXeR2mNq7"
}
}
}Clearbit
Identifica e arricchisce i visitatori anonimi.
Formato: la chiave API pubblica inizia con pk_, seguita da 6-64 lettere o numeri.
{
"integrations": {
"clearbit": {
"publicApiKey": "pk_4f8a2e1c9b6d"
}
}
}Hightouch
Invia gli eventi della documentazione direttamente al tuo data warehouse.
Formato: la chiave di scrittura è composta da 8-128 caratteri (lettere, numeri, :, ., _, -). L'host API opzionale è composto da 4-64 caratteri (lettere, numeri, ., -).
{
"integrations": {
"hightouch": {
"writeKey": "wk_prod_4f8a2e1c9b6d",
"apiHost": "us-east-1.hightouch-events.com"
}
}
}apiHost è facoltativo e serve solo per un endpoint degli eventi Hightouch self-hosted o specifico per una regione.
Koala
Identifica i visitatori con alta intenzione d'acquisto per vendite e marketing.
Formato: la chiave API pubblica inizia con pk_, seguita da 6-64 lettere o numeri.
{
"integrations": {
"koala": {
"publicApiKey": "pk_7e3a9c1f6b2d"
}
}
}Gestione del consenso
Tutti i 13 provider sopra elencati rispettano integrations.cookies. Quando è impostato, nessuno dei relativi script viene caricato finché il banner del consenso non registra l'approvazione: consulta Cookie Consent per la configurazione completa. Senza questa impostazione, ogni script viene caricato per ogni visitatore al caricamento della pagina.