Analytics- und Session-Replay-Anbieter
Binden Sie 13 Analytics-, Session-Replay- und Identitätsanbieter über einen docs.json-Block in Ihre Dokumentationsseite ein.
Jamdesk lädt Skripte für 13 zusätzliche Analytics-, Session-Replay- und Identitätsanbieter direkt aus docs.json. Fügen Sie den Block des Anbieters unter integrations hinzu. Jamdesk fügt dessen Skript auf jeder Seite Ihrer veröffentlichten Dokumentationsseite 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 niemals gerendert – keine Fehlerseite, kein fehlerhaftes Skript-Tag. Wenn ein Anbieter nicht geladen wird, kopieren Sie den Wert erneut aus seinem Dashboard und prüfen Sie ihn anhand des unten angegebenen Formats.
Über das Dashboard konfigurieren
Der schnellste Weg, einen dieser Anbieter einzurichten: Dashboard → Integrations. Wählen Sie die Karte eines Anbieters aus, fügen Sie seinen Schlüssel ein, und Jamdesk trägt den docs.json-Block für Sie ein und löst einen erneuten Build aus (nur für GitHub-verbundene Projekte). Die folgenden Abschnitte dienen zum direkten Bearbeiten von docs.json oder für reine CLI-Projekte.
PostHog
Produktanalysen, 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.
Sie finden Ihren 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 wird standardmäßig auf https://us.i.posthog.com gesetzt. Legen Sie ihn auf Ihren EU-Cloud-Host oder Ihre Reverse-Proxy-URL fest, wenn Sie einen solchen verwenden.
Mixpanel
Ereignisanalysen und Funnels.
Format: Das Projekttoken besteht genau aus 32 Kleinbuchstaben als Hexadezimalzeichen (0-9, a-f).
Sie finden Ihr Token unter Project Settings → Access Keys → Project Token in Mixpanel.
{
"integrations": {
"mixpanel": {
"projectToken": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
}
}Amplitude
Produktanalysen und Verhaltensgruppen.
Format: Der API-Schlüssel besteht genau aus 32 Kleinbuchstaben als Hexadezimalzeichen (0-9, a-f).
Sie finden Ihren Schlüssel unter Settings → Projects → your project → API Key in Amplitude.
{
"integrations": {
"amplitude": {
"apiKey": "f6e5d4c3b2a1908877665544332211ff"
}
}
}Hotjar
Heatmaps und Sitzungsaufzeichnungen.
Format: Die Website-ID besteht aus 1–12 Ziffern. Die Snippet-Version besteht aus 1–4 Ziffern (normalerweise 6).
Sie finden beide Werte unter Sites & Organizations → your site in Hotjar.
{
"integrations": {
"hotjar": {
"hjid": "3482910",
"hjsv": "6"
}
}
}Hotjar zeichnet Besuchersitzungen auf. Wenn für Ihre Leser die DSGVO, der CCPA oder ähnliche Vorschriften gelten, müssen Sie den Dienst hinter Cookie Consent schalten.
Microsoft Clarity
Kostenlose Heatmaps und Sitzungsaufzeichnungen.
Format: Die Projekt-ID besteht aus 4–32 Buchstaben oder Ziffern.
Sie finden Ihre Projekt-ID unter Settings → Overview → Project ID in Clarity.
{
"integrations": {
"clarity": {
"projectId": "qbxk2paw9m"
}
}
}Clarity zeichnet Besuchersitzungen auf. Wenn für Ihre Leser die DSGVO, der CCPA oder ähnliche Vorschriften gelten, müssen Sie den Dienst hinter Cookie Consent schalten.
Fathom
Datenschutzorientierte, cookie-freie Analysen.
Format: Die Website-ID besteht aus 4–16 Buchstaben oder Ziffern.
Sie finden Ihre Website-ID unter Settings → Sites → your site in Fathom.
{
"integrations": {
"fathom": {
"siteId": "ABCD1234"
}
}
}Pirsch
Cookie-freie, datenschutzfreundliche Analysen.
Format: Der Identifikationscode besteht aus 4–64 Buchstaben oder Ziffern.
Sie finden Ihren 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.
Sie finden Ihre 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 Kleinbuchstaben, Ziffern oder Bindestrichen.
Sie finden Ihre App-ID unter Settings → Project Setup in LogRocket.
{
"integrations": {
"logrocket": {
"appId": "acme-inc/docs-site"
}
}
}LogRocket zeichnet Besuchersitzungen einschließlich Konsolen- und Netzwerkaktivitäten auf. Wenn für Ihre Leser die DSGVO, der CCPA oder ähnliche Vorschriften gelten, müssen Sie den Dienst hinter Cookie Consent schalten.
Segment
Leiten Sie Dokumentationsereignisse von einer Quelle an jedes nachgelagerte Tool weiter.
Format: Der Write-Key besteht aus 10–64 Buchstaben oder Ziffern (keine Bindestriche oder Unterstriche).
Sie finden Ihren Write-Key unter Connections → Sources → your JS source → Settings → API Keys in Segment.
{
"integrations": {
"segment": {
"key": "hcQ8wK9pXeR2mNq7"
}
}
}Clearbit
Identifizieren und bereichern Sie anonyme Besucher.
Format: Der öffentliche API-Schlüssel beginnt mit pk_, gefolgt von 6–64 Buchstaben oder Ziffern.
{
"integrations": {
"clearbit": {
"publicApiKey": "pk_4f8a2e1c9b6d"
}
}
}Hightouch
Senden Sie Dokumentationsereignisse direkt an Ihr 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
Identifizieren Sie 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"
}
}
}Einwilligungssteuerung
Alle 13 oben genannten Anbieter berücksichtigen integrations.cookies. Wenn diese Einstellung aktiviert ist, werden ihre Skripte erst geladen, wenn Ihr Einwilligungsbanner die Zustimmung erfasst – die vollständige Einrichtung finden Sie unter Cookie Consent. Ohne diese Einstellung wird jedes Skript beim Laden der Seite für jeden Besucher geladen.