Analytics- und Session-Replay-Anbieter
PostHog, Mixpanel, Amplitude, Hotjar, Clarity, Fathom, Pirsch, Heap, LogRocket, Segment, Clearbit, Hightouch oder Koala mit einem docs.json-Block einbinden.
Jamdesk lädt Skripte für 13 weitere Analyse-, Session-Replay- und Identitätsanbieter aus der docs.json. Fügen Sie den Block des Anbieters unter integrations ein. Jamdesk bindet das Skript auf jeder Seite Ihrer veröffentlichten Dokumentation ein.
Jamdesk prüft jeden Wert anhand eines strikten Formats, bevor das Skript geladen wird. Ein Wert im falschen Format (zusätzliche Zeichen, falsches Präfix, falsche Länge) wird stillschweigend übersprungen. Sie erhalten weder eine Fehlermeldung noch ein fehlerhaftes Skript-Tag. Wenn ein Anbieter nicht geladen wird, kopieren Sie den Wert erneut aus dem Dashboard des Anbieters und prüfen Sie ihn anhand des unten stehenden Formats.
Über das Dashboard konfigurieren
Am schnellsten richten Sie diese Anbieter über Dashboard → Integrations ein. Wählen Sie die Karte eines Anbieters und fügen Sie dessen Schlüssel ein. Jamdesk übernimmt den docs.json-Block und startet einen neuen Build (nur für Projekte mit GitHub-Verbindung). Die folgenden Abschnitte zeigen, wie Sie docs.json direkt bearbeiten, etwa bei Projekten, die nur über die CLI verwaltet werden.
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.
Ihren Schlüssel finden Sie in PostHog unter Settings → Project → Project API key.
{
"integrations": {
"posthog": {
"apiKey": "phc_Kj8fPqZx92RmNbTeYcWs",
"apiHost": "https://us.i.posthog.com"
}
}
}apiHost ist optional. Standardmäßig wird https://us.i.posthog.com verwendet. Setzen Sie den Wert auf Ihren EU-Cloud-Host oder die URL Ihres Reverse-Proxys, falls Sie einen verwenden.
Mixpanel
Ereignisanalyse und Funnels.
Format: Das Projekt-Token besteht aus genau 32 Kleinbuchstaben-Hexadezimalzeichen (0-9, a-f).
Ihr Token finden Sie in Mixpanel unter Project Settings → Access Keys → Project Token.
{
"integrations": {
"mixpanel": {
"projectToken": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
}
}Amplitude
Produktanalyse und Verhaltenskohorten.
Format: Der API-Schlüssel besteht aus genau 32 Kleinbuchstaben-Hexadezimalzeichen (0-9, a-f).
Ihren Schlüssel finden Sie in Amplitude unter Settings → Projects → Ihr Projekt → API Key.
{
"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 (meist 6).
Site-ID und Snippet-Version finden Sie in Hotjar unter Sites & Organizations → Ihre Site.
{
"integrations": {
"hotjar": {
"hjid": "3482910",
"hjsv": "6"
}
}
}Hotjar zeichnet Besuchersitzungen auf. Falls für Ihre Leser DSGVO, CCPA oder ähnliche Vorschriften gelten, schalten Sie es über Cookie Consent ab.
Microsoft Clarity
Kostenlose Heatmaps und Sitzungsaufzeichnungen.
Format: Die Projekt-ID besteht aus 4–32 Buchstaben oder Ziffern.
Ihre Projekt-ID finden Sie in Clarity unter Settings → Overview → Project ID.
{
"integrations": {
"clarity": {
"projectId": "qbxk2paw9m"
}
}
}Clarity zeichnet Besuchersitzungen auf. Falls für Ihre Leser DSGVO, CCPA oder ähnliche Vorschriften gelten, schalten Sie es über Cookie Consent ab.
Fathom
Datenschutzorientierte Analyse ohne Cookies.
Format: Die Site-ID besteht aus 4–16 Buchstaben oder Ziffern.
Ihre Site-ID finden Sie in Fathom unter Settings → Sites → Ihre Site.
{
"integrations": {
"fathom": {
"siteId": "ABCD1234"
}
}
}Pirsch
Cookiefreie, datenschutzfreundliche Analyse.
Format: Der Identifikationscode besteht aus 4–64 Buchstaben oder Ziffern.
Ihren Code finden Sie in Pirsch unter Settings → Developer → Identification Code.
{
"integrations": {
"pirsch": {
"id": "Jd8fK2pQmZx9AeRt"
}
}
}Heap
Automatische Ereigniserfassung ohne manuelle Instrumentierung.
Format: Die App-ID besteht aus 6–20 Ziffern.
Ihre App-ID finden Sie in Heap unter Account → Manage → Projects.
{
"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). Jedes Segment besteht aus 2–64 Kleinbuchstaben, Ziffern oder Bindestrichen.
Ihre App-ID finden Sie in LogRocket unter Settings → Project Setup.
{
"integrations": {
"logrocket": {
"appId": "acme-inc/docs-site"
}
}
}LogRocket zeichnet Besuchersitzungen einschließlich Konsolen- und Netzwerkaktivität auf. Falls für Ihre Leser DSGVO, CCPA oder ähnliche Vorschriften gelten, schalten Sie es über Cookie Consent ab.
Segment
Dokumentationsereignisse aus einer Quelle an alle nachgelagerten Tools weiterleiten.
Format: Der Write-Key besteht aus 10–64 Buchstaben oder Ziffern (keine Bindestriche oder Unterstriche).
Ihren Write-Key finden Sie in Segment unter Connections → Sources → Ihre JS-Quelle → Settings → API Keys.
{
"integrations": {
"segment": {
"key": "hcQ8wK9pXeR2mNq7"
}
}
}Clearbit
Anonyme Besucher identifizieren und anreichern.
Format: Der öffentliche API-Schlüssel beginnt mit pk_, gefolgt von 6–64 Buchstaben oder Ziffern.
{
"integrations": {
"clearbit": {
"publicApiKey": "pk_4f8a2e1c9b6d"
}
}
}Hightouch
Dokumentationsereignisse direkt in Ihr Data Warehouse senden.
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. Setzen Sie ihn nur, wenn Sie einen selbst gehosteten oder regionsspezifischen Hightouch-Events-Endpunkt verwenden.
Koala
Besucher mit hoher Kaufabsicht für Vertrieb und Marketing identifizieren.
Format: Der öffentliche API-Schlüssel beginnt mit pk_, gefolgt von 6–64 Buchstaben oder Ziffern.
{
"integrations": {
"koala": {
"publicApiKey": "pk_7e3a9c1f6b2d"
}
}
}Einwilligung voraussetzen
Jeder der oben genannten Anbieter berücksichtigt integrations.cookies. Ist dieser Wert gesetzt, werden ihre Skripte erst geladen, nachdem Ihr Einwilligungsbanner die Zustimmung erfasst hat. Die Einrichtung finden Sie unter Cookie Consent. Ohne diese Einstellung werden alle Skripte beim Laden der Seite für jeden Besucher ausgeführt.