Analytics & Session Replay Providers
Add PostHog, Mixpanel, Amplitude, Hotjar, Clarity, Fathom, Pirsch, Heap, LogRocket, Segment, Clearbit, Hightouch, or Koala with one docs.json block.
Jamdesk loads scripts for 13 more analytics, session-replay, and identity providers from docs.json. Add the provider's block under integrations. Jamdesk injects its script on every page of your published docs site.
Jamdesk checks each value against a strict format before loading the script. A value in the wrong format (extra characters, wrong prefix, wrong length) is silently skipped. You get no error page and no broken script tag. If a provider isn't loading, re-copy the value from its dashboard and check it against the format below.
Configure from the Dashboard
Set these up fastest from Dashboard → Integrations. Pick a provider's card and paste its key. Jamdesk commits the docs.json block and triggers a rebuild (GitHub-connected projects only). Use the sections below to edit docs.json directly or for CLI-only projects.
PostHog
Product analytics, session replay, and feature flags.
Format: Project API key starts with phc_, followed by 8-64 letters or numbers. The optional API host must be an https:// URL.
Find your key at Settings → Project → Project API key in PostHog.
{
"integrations": {
"posthog": {
"apiKey": "phc_Kj8fPqZx92RmNbTeYcWs",
"apiHost": "https://us.i.posthog.com"
}
}
}apiHost is optional. It defaults to https://us.i.posthog.com. Set it to your EU cloud host or reverse-proxy URL if you use one.
Mixpanel
Event analytics and funnels.
Format: Project token is exactly 32 lowercase hex characters (0-9, a-f).
Find your token at Project Settings → Access Keys → Project Token in Mixpanel.
{
"integrations": {
"mixpanel": {
"projectToken": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6"
}
}
}Amplitude
Product analytics and behavioral cohorts.
Format: API key is exactly 32 lowercase hex characters (0-9, a-f).
Find your key at Settings → Projects → your project → API Key in Amplitude.
{
"integrations": {
"amplitude": {
"apiKey": "f6e5d4c3b2a1908877665544332211ff"
}
}
}Hotjar
Heatmaps and session recordings.
Format: Site ID is 1-12 digits. Snippet version is 1-4 digits (usually 6).
Find the site ID and snippet version at Sites & Organizations → your site in Hotjar.
{
"integrations": {
"hotjar": {
"hjid": "3482910",
"hjsv": "6"
}
}
}Hotjar records visitor sessions. If GDPR, CCPA, or similar regulations apply to your readers, gate it behind Cookie Consent.
Microsoft Clarity
Free heatmaps and session recordings.
Format: Project ID is 4-32 letters or numbers.
Find your project ID at Settings → Overview → Project ID in Clarity.
{
"integrations": {
"clarity": {
"projectId": "qbxk2paw9m"
}
}
}Clarity records visitor sessions. If GDPR, CCPA, or similar regulations apply to your readers, gate it behind Cookie Consent.
Fathom
Privacy-first, cookie-free analytics.
Format: Site ID is 4-16 letters or numbers.
Find your site ID at Settings → Sites → your site in Fathom.
{
"integrations": {
"fathom": {
"siteId": "ABCD1234"
}
}
}Pirsch
Cookie-free, privacy-friendly analytics.
Format: Identification code is 4-64 letters or numbers.
Find your code at Settings → Developer → Identification Code in Pirsch.
{
"integrations": {
"pirsch": {
"id": "Jd8fK2pQmZx9AeRt"
}
}
}Heap
Automatic event capture, no manual instrumentation.
Format: App ID is 6-20 digits.
Find your App ID at Account → Manage → Projects in Heap.
{
"integrations": {
"heap": {
"appId": "1234567890"
}
}
}LogRocket
Session replay with console and network logs.
Format: App ID is two slug segments separated by a slash (org-slug/app-slug). Each segment is 2-64 lowercase letters, numbers, or hyphens.
Find your App ID at Settings → Project Setup in LogRocket.
{
"integrations": {
"logrocket": {
"appId": "acme-inc/docs-site"
}
}
}LogRocket records visitor sessions, including console and network activity. If GDPR, CCPA, or similar regulations apply to your readers, gate it behind Cookie Consent.
Segment
Route documentation events to every downstream tool from one source.
Format: Write key is 10-64 letters or numbers (no hyphens or underscores).
Find your write key at Connections → Sources → your JS source → Settings → API Keys in Segment.
{
"integrations": {
"segment": {
"key": "hcQ8wK9pXeR2mNq7"
}
}
}Clearbit
Identify and enrich anonymous visitors.
Format: Public API key starts with pk_, followed by 6-64 letters or numbers.
{
"integrations": {
"clearbit": {
"publicApiKey": "pk_4f8a2e1c9b6d"
}
}
}Hightouch
Send documentation events straight to your data warehouse.
Format: Write key is 8-128 characters (letters, numbers, :, ., _, -). The optional API host is 4-64 characters (letters, numbers, ., -).
{
"integrations": {
"hightouch": {
"writeKey": "wk_prod_4f8a2e1c9b6d",
"apiHost": "us-east-1.hightouch-events.com"
}
}
}apiHost is optional. Set it only for a self-hosted or region-specific Hightouch events endpoint.
Koala
Identify high-intent visitors for sales and marketing.
Format: Public API key starts with pk_, followed by 6-64 letters or numbers.
{
"integrations": {
"koala": {
"publicApiKey": "pk_7e3a9c1f6b2d"
}
}
}Consent Gating
Every provider above respects integrations.cookies. With it set, their scripts load only after your consent banner records approval. See Cookie Consent for setup. Without it, every script loads for every visitor on page load.