Analytics- & Replay-Anbieter
Füge PostHog, Mixpanel, Amplitude, Hotjar, Clarity, Fathom, Pirsch, Heap, LogRocket, Segment, Clearbit, Hightouch oder Koala mit einem docs.json-Block hinzu.
Jamdesk lädt Skripte für 13 zusätzliche Analytics-, Session-Replay- und Identitätsanbieter direkt aus docs.json. Füge den Block des Anbieters unter integrations hinzu, und Jamdesk bindet sein Skript auf jeder Seite deiner veröffentlichten Dokumentationswebsite ein.
Jeder Wert wird anhand eines strikten Formats geprüft, bevor Jamdesk das Skript lädt. Ein Wert im falschen Format (zusätzliche Zeichen, falsches Präfix, falsche Länge) wird stillschweigend übersprungen und nie gerendert – keine Fehlerseite, kein beschädigtes Skript-Tag. Wenn ein Anbieter nicht geladen wird, kopiere den Wert erneut aus seinem Dashboard und prüfe ihn anhand des untenstehenden Formats.
Über das Dashboard konfigurieren
Am schnellsten richtest du einen dieser Anbieter über Dashboard → Integrations ein. Wähle die Karte eines Anbieters aus, füge seinen Schlüssel ein, und Jamdesk schreibt den docs.json-Block für dich, löst einen neuen Build aus und (nur bei GitHub-verbundenen Projekten) startet den Build. Die folgenden Abschnitte dienen zum direkten Bearbeiten von docs.json oder für Projekte, die nur die CLI verwenden.
PostHog
Produktanalyse, Session Replay und Feature-Flags.
Format: Der Projekt-API-Schlüssel beginnt mit phc_, gefolgt von 8–64 Buchstaben oder Ziffern. Der optionale API-Host muss eine https://-URL sein.
Du findest deinen Schlüssel unter Settings → Project → Project API key in PostHog.
{
"integrations": {
"posthog": {
"apiKey": "phc_Kj8fPqZx92RmNbTeYcWs",
"apiHost": "https://us.i.posthog.com"
}
}
}apiHost ist optional und verwendet standardmäßig https://us.i.posthog.com. Lege ihn auf deinen EU-Cloud-Host oder deine Reverse-Proxy-URL fest, falls du einen davon verwendest.
Mixpanel
Ereignisanalyse und Trichter.
Format: Das Projekt-Token besteht genau aus 32 kleingeschriebenen Hexadezimalzeichen (0-9, a-f).
Du findest dein Token unter Project Settings → Access Keys → Project Token in Mixpanel.
{
"integrations": {
"mixpanel": {
"projectToken": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
}
}Amplitude
Produktanalyse und Verhaltenskohorten.
Format: Der API-Schlüssel besteht genau aus 32 kleingeschriebenen Hexadezimalzeichen (0-9, a-f).
Du findest deinen Schlüssel unter Settings → Projects → your project → API Key in Amplitude.
{
"integrations": {
"amplitude": {
"apiKey": "f6e5d4c3b2a1908877665544332211ff"
}
}
}Hotjar
Heatmaps und Sitzungsaufzeichnungen.
Format: Die Site-ID besteht aus 1–12 Ziffern. Die Snippet-Version besteht aus 1–4 Ziffern (üblicherweise 6).
Du findest beide Werte unter Sites & Organizations → your site in Hotjar.
{
"integrations": {
"hotjar": {
"hjid": "3482910",
"hjsv": "6"
}
}
}Hotjar zeichnet Besuchersitzungen auf. Wenn für deine Leser die DSGVO, der CCPA oder ähnliche Vorschriften gelten, schalte den Dienst erst nach Cookie Consent frei.
Microsoft Clarity
Kostenlose Heatmaps und Sitzungsaufzeichnungen.
Format: Die Projekt-ID besteht aus 4–32 Buchstaben oder Ziffern.
Du findest deine Projekt-ID unter Settings → Overview → Project ID in Clarity.
{
"integrations": {
"clarity": {
"projectId": "qbxk2paw9m"
}
}
}Clarity zeichnet Besuchersitzungen auf. Wenn für deine Leser die DSGVO, der CCPA oder ähnliche Vorschriften gelten, schalte den Dienst erst nach Cookie Consent frei.
Fathom
Datenschutzorientierte, cookie-freie Analytics.
Format: Die Site-ID besteht aus 4–16 Buchstaben oder Ziffern.
Du findest deine Site-ID unter Settings → Sites → your site in Fathom.
{
"integrations": {
"fathom": {
"siteId": "ABCD1234"
}
}
}Pirsch
Cookie-freie, datenschutzfreundliche Analytics.
Format: Der Identifikationscode besteht aus 4–64 Buchstaben oder Ziffern.
Du findest deinen Code unter Settings → Developer → Identification Code in Pirsch.
{
"integrations": {
"pirsch": {
"id": "Jd8fK2pQmZx9AeRt"
}
}
}Heap
Automatische Ereigniserfassung ohne manuelle Instrumentierung.
Format: Die App-ID besteht aus 6–20 Ziffern.
Du findest deine App-ID unter Account → Manage → Projects in Heap.
{
"integrations": {
"heap": {
"appId": "1234567890"
}
}
}LogRocket
Session Replay mit Konsolen- und Netzwerkprotokollen.
Format: Die App-ID besteht aus zwei durch einen Schrägstrich getrennten Slug-Segmenten – org-slug/app-slug – mit jeweils 2–64 kleingeschriebenen Buchstaben, Ziffern oder Bindestrichen.
Du findest deine App-ID unter Settings → Project Setup in LogRocket.
{
"integrations": {
"logrocket": {
"appId": "acme-inc/docs-site"
}
}
}LogRocket zeichnet Besuchersitzungen einschließlich Konsolen- und Netzwerkaktivität auf. Wenn für deine Leser die DSGVO, der CCPA oder ähnliche Vorschriften gelten, schalte den Dienst erst nach Cookie Consent frei.
Segment
Leite Dokumentationsereignisse von einer Quelle an jedes nachgelagerte Tool weiter.
Format: Der Write Key besteht aus 10–64 Buchstaben oder Ziffern (keine Bindestriche oder Unterstriche).
Du findest deinen Write Key unter Connections → Sources → your JS source → Settings → API Keys in Segment.
{
"integrations": {
"segment": {
"key": "hcQ8wK9pXeR2mNq7"
}
}
}Clearbit
Identifiziere anonyme Besucher und reichere ihre Daten an.
Format: Der öffentliche API-Schlüssel beginnt mit pk_, gefolgt von 6–64 Buchstaben oder Ziffern.
{
"integrations": {
"clearbit": {
"publicApiKey": "pk_4f8a2e1c9b6d"
}
}
}Hightouch
Sende Dokumentationsereignisse direkt an dein Data Warehouse.
Format: Der Write Key besteht aus 8–128 Zeichen (Buchstaben, Ziffern, :, ., _, -). Der optionale API-Host besteht aus 4–64 Zeichen (Buchstaben, Ziffern, ., -).
{
"integrations": {
"hightouch": {
"writeKey": "wk_prod_4f8a2e1c9b6d",
"apiHost": "us-east-1.hightouch-events.com"
}
}
}apiHost ist optional und wird nur für einen selbst gehosteten oder regionsspezifischen Hightouch-Ereignis-Endpoint benötigt.
Koala
Identifiziere Besucher mit hoher Kaufabsicht für Vertrieb und Marketing.
Format: Der öffentliche API-Schlüssel beginnt mit pk_, gefolgt von 6–64 Buchstaben oder Ziffern.
{
"integrations": {
"koala": {
"publicApiKey": "pk_7e3a9c1f6b2d"
}
}
}Einwilligung voraussetzen
Alle 13 oben genannten Anbieter berücksichtigen integrations.cookies. Sobald dieser Wert gesetzt ist, werden ihre Skripte erst geladen, wenn dein Einwilligungsbanner die Zustimmung erfasst – unter Cookie Consent findest du die vollständige Einrichtung. Ohne diese Einstellung wird jedes Skript beim Laden der Seite für jeden Besucher geladen.