Provider di analisi e replay
Aggiungi PostHog, Mixpanel, Amplitude, Hotjar, Clarity, Fathom, Pirsch, Heap, LogRocket, Segment, Clearbit, Hightouch o Koala con un solo blocco in docs.json.
Jamdesk carica gli script di altri 13 provider di analisi, replay di sessione e identità da docs.json. Aggiungi il blocco del provider sotto integrations. Jamdesk inserisce il proprio script in ogni pagina del sito di documentazione pubblicato.
Jamdesk verifica ogni valore con un formato rigoroso prima di caricare lo script. Un valore nel formato sbagliato (caratteri in più, prefisso errato, lunghezza errata) viene ignorato senza errori né tag script rotti. Se un provider non si carica, ricopia il valore dalla sua dashboard e controllalo con il formato sottostante.
Configurazione dal dashboard
Il modo più rapido è da Dashboard → Integrations. Scegli la scheda di un provider e incolla la sua chiave. Jamdesk salva il blocco docs.json e avvia una nuova build (solo per progetti collegati a GitHub). Usa le sezioni seguenti per modificare docs.json direttamente o per progetti che usano solo la CLI.
PostHog
Analisi di prodotto, replay di sessione e feature flag.
Formato: La chiave API del progetto inizia con phc_, seguita da 8-64 lettere o numeri. L'host API facoltativo deve essere un URL https://.
Trova la tua chiave in PostHog a Settings → Project → Project API key.
{
"integrations": {
"posthog": {
"apiKey": "phc_Kj8fPqZx92RmNbTeYcWs",
"apiHost": "https://us.i.posthog.com"
}
}
}apiHost è facoltativo. Il valore predefinito è https://us.i.posthog.com. Impostalo sull'host del cloud UE o sull'URL di un reverse proxy se ne usi uno.
Mixpanel
Analisi degli eventi e funnel.
Formato: Il token di progetto è esattamente 32 caratteri esadecimali minuscoli (0-9, a-f).
Trova il tuo token in Mixpanel a Project Settings → Access Keys → Project Token.
{
"integrations": {
"mixpanel": {
"projectToken": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
}
}Amplitude
Analisi di prodotto e coorti comportamentali.
Formato: La chiave API è esattamente 32 caratteri esadecimali minuscoli (0-9, a-f).
Trova la tua chiave in Amplitude a Settings → Projects → il tuo progetto → API Key.
{
"integrations": {
"amplitude": {
"apiKey": "f6e5d4c3b2a1908877665544332211ff"
}
}
}Hotjar
Mappe di calore e registrazioni di sessione.
Formato: L'ID del sito è composto da 1-12 cifre. La versione dello snippet è composta da 1-4 cifre (di solito 6).
Trova l'ID del sito e la versione dello snippet in Hotjar a Sites & Organizations → il tuo sito.
{
"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, subordinalo al Consenso ai cookie.
Microsoft Clarity
Mappe di calore e registrazioni di sessione gratuite.
Formato: L'ID del progetto è composto da 4-32 lettere o numeri.
Trova l'ID del progetto in Clarity a Settings → Overview → Project ID.
{
"integrations": {
"clarity": {
"projectId": "qbxk2paw9m"
}
}
}Clarity registra le sessioni dei visitatori. Se ai tuoi lettori si applicano il GDPR, il CCPA o normative simili, subordinalo al Consenso ai cookie.
Fathom
Analisi rispettose della privacy e senza cookie.
Formato: L'ID del sito è composto da 4-16 lettere o numeri.
Trova l'ID del sito in Fathom a Settings → Sites → il tuo sito.
{
"integrations": {
"fathom": {
"siteId": "ABCD1234"
}
}
}Pirsch
Analisi senza cookie e rispettose della privacy.
Formato: Il codice di identificazione è composto da 4-64 lettere o numeri.
Trova il codice in Pirsch a Settings → Developer → Identification Code.
{
"integrations": {
"pirsch": {
"id": "Jd8fK2pQmZx9AeRt"
}
}
}Heap
Cattura automatica degli eventi, senza strumentazione manuale.
Formato: L'App ID è composto da 6-20 cifre.
Trova il tuo App ID in Heap a Account → Manage → Projects.
{
"integrations": {
"heap": {
"appId": "1234567890"
}
}
}LogRocket
Replay di sessione con log della console e della rete.
Formato: L'App ID è costituito da due segmenti slug separati da una barra (org-slug/app-slug). Ogni segmento è composto da 2-64 lettere minuscole, numeri o trattini.
Trova il tuo App ID in LogRocket a Settings → Project Setup.
{
"integrations": {
"logrocket": {
"appId": "acme-inc/docs-site"
}
}
}LogRocket registra le sessioni dei visitatori, incluse l'attività della console e della rete. Se ai tuoi lettori si applicano il GDPR, il CCPA o normative simili, subordinalo al Consenso ai cookie.
Segment
Instrada gli eventi della documentazione verso tutti gli strumenti a valle da un'unica fonte.
Formato: La write key è composta da 10-64 lettere o numeri (senza trattini né trattini bassi).
Trova la tua write key in Segment a Connections → Sources → la tua sorgente JS → Settings → API Keys.
{
"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 direttamente gli eventi della documentazione al tuo data warehouse.
Formato: La write key è composta da 8-128 caratteri (lettere, numeri, :, ., _, -). L'host API facoltativo è composto da 4-64 caratteri (lettere, numeri, ., -).
{
"integrations": {
"hightouch": {
"writeKey": "wk_prod_4f8a2e1c9b6d",
"apiHost": "us-east-1.hightouch-events.com"
}
}
}apiHost è facoltativo. Impostalo solo per un endpoint eventi Hightouch self-hosted o specifico per regione.
Koala
Identifica i visitatori ad alto interesse 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
Ogni provider sopra rispetta integrations.cookies. Con questa impostazione, i loro script vengono caricati solo dopo che il banner del consenso registra l'approvazione. Consulta Consenso ai cookie per la configurazione. Senza di essa, ogni script viene caricato per ogni visitatore al caricamento della pagina.