Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -224,6 +224,7 @@
"integrations/analytics/heap",
"integrations/analytics/hightouch",
"integrations/analytics/hotjar",
"integrations/analytics/koala",
"integrations/analytics/logrocket",
"integrations/analytics/mixpanel",
"integrations/analytics/pirsch",
Expand Down
27 changes: 27 additions & 0 deletions integrations/analytics/koala.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "Koala"
description: "Track visitor behavior and identify accounts with Koala to understand who is engaging with your documentation."
keywords: ["Koala integration", "visitor tracking", "account identification", "public API key"]
---

Add the following to your `docs.json` file to send analytics to Koala.

<CodeGroup>

```json Analytics options in docs.json
"integrations": {
"koala": {
"publicApiKey": "required"
}
}
```

```json Example
"integrations": {
"koala": {
"publicApiKey": "pk_abc123def456"
}
}
```

</CodeGroup>
24 changes: 24 additions & 0 deletions integrations/analytics/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -284,6 +284,27 @@
}
/>

<Card
title="Koala"
href="/integrations/analytics/koala"
horizontal
icon={
<svg
className="h-6 w-6"
width="24"
height="24"
viewBox="0 0 24 24"
fill="none"
xmlns="http://www.w3.org/2000/svg"
>
<circle cx="12" cy="12" r="10" className="fill-black dark:fill-white" />
<circle cx="9" cy="10" r="2" className="fill-white dark:fill-black" />
<circle cx="15" cy="10" r="2" className="fill-white dark:fill-black" />
<ellipse cx="12" cy="15" rx="3" ry="2" className="fill-white dark:fill-black" />
</svg>
}
/>

<Card
title="Hotjar"
href="/integrations/analytics/hotjar"
Expand Down Expand Up @@ -611,10 +632,13 @@
"hjid": "required",
"hjsv": "required"
},
"koala": {
"publicApiKey": "required"
},
"logrocket": {
"appId": "required"
},
"mixpanel": {

Check warning on line 641 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L641

Use 'Mixpanel' instead of 'mixpanel'.
"projectToken": "required"
},
"pirsch": {
Expand All @@ -623,7 +647,7 @@
"plausible": {
"domain": "required"
},
"posthog": {

Check warning on line 650 in integrations/analytics/overview.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

integrations/analytics/overview.mdx#L650

Use 'PostHog' instead of 'posthog'.
"apiKey": "required",
"apiHost": "optional"
},
Expand Down
10 changes: 10 additions & 0 deletions organize/settings-integrations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,16 @@ Configure all integrations as properties of the `integrations` object in your `d
</Expandable>
</ResponseField>

<ResponseField name="integrations.koala" type="object">
Koala visitor tracking and account identification integration.

<Expandable title="integrations.koala">
<ResponseField name="publicApiKey" type="string" required>
Your Koala public API key. Minimum length: 2.
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField name="integrations.logrocket" type="object">
LogRocket session replay integration.

Expand Down
7 changes: 4 additions & 3 deletions organize/settings-reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@

Top-level navigation tabs.

**Type:** array of object—each with: `tab` (string, required), `icon` (string), `iconType` (string), `hidden` (boolean), `href` (string uri, required)
**Type:** array of object—each with: `tab` (string, required), `icon` (string), `iconType` (string), `align` (`"start"` | `"end"`), `hidden` (boolean), `href` (string uri, required)

##### `navigation.global.anchors`

Expand All @@ -156,9 +156,9 @@

##### `navigation.global.dropdowns`

Dropdown menus.

Check warning on line 159 in organize/settings-reference.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-reference.mdx#L159

Use 'dropdowns?' instead of 'Dropdown'.

**Type:** array of object—each with: `dropdown` (string, required), `icon` (string), `iconType` (string), `hidden` (boolean), `href` (string uri, required)
**Type:** array of object—each with: `dropdown` (string, required), `icon` (string), `iconType` (string), `color` (object with `light` and `dark` hex strings), `description` (string), `hidden` (boolean), `href` (string uri, required)

##### `navigation.global.languages`

Expand All @@ -178,7 +178,7 @@

Product switcher in the global nav.

**Type:** array of object—each with: `product` (string, required), `description` (string), `icon` (string), `iconType` (string)
**Type:** array of object—each with: `product` (string, required), `name` (string), `description` (string), `icon` (string), `iconType` (string)

#### `navigation.languages`

Expand Down Expand Up @@ -208,7 +208,7 @@

#### `navigation.dropdowns`

Dropdown menus.

Check warning on line 211 in organize/settings-reference.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings-reference.mdx#L211

Use 'dropdowns?' instead of 'Dropdown'.

**Type:** array of object—see `navigation.global.dropdowns` for shape.

Expand Down Expand Up @@ -905,6 +905,7 @@
| `integrations.hotjar.hjid` | string | Yes | Hotjar site ID. |
| `integrations.hotjar.hjsv` | string | Yes | Hotjar script version. |
| `integrations.intercom.appId` | string (min 6) | Yes | Intercom app ID. |
| `integrations.koala.publicApiKey` | string (min 2) | Yes | Koala public API key. |
| `integrations.logrocket.appId` | string | Yes | LogRocket app ID. |
| `integrations.mixpanel.projectToken` | string | Yes | Mixpanel project token. |
| `integrations.pirsch.id` | string | Yes | Pirsch site ID. |
Expand Down
21 changes: 21 additions & 0 deletions organize/settings-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ See [Navigation](/organize/navigation) for complete documentation on building yo
Display name of the tab. Minimum length: 1.
</ResponseField>
<IconsOptional />
<ResponseField name="align" type='"start" | "end"'>
Tab alignment in the navigation. Set to `end` to push the tab to the right side of the tab bar.
</ResponseField>
<ResponseField name="hidden" type="boolean">
Whether to hide this tab by default.
</ResponseField>
Expand Down Expand Up @@ -76,6 +79,21 @@ See [Navigation](/organize/navigation) for complete documentation on building yo
Display name of the dropdown. Minimum length: 1.
</ResponseField>
<IconsOptional />
<ResponseField name="color" type="object">
Custom colors for the dropdown icon.

<Expandable title="color">
<ResponseField name="light" type="string">
Dropdown color for light mode. Must be a hex code beginning with `#`.
</ResponseField>
<ResponseField name="dark" type="string">
Dropdown color for dark mode. Must be a hex code beginning with `#`.
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="description" type="string">
Description of the dropdown.
</ResponseField>
<ResponseField name="hidden" type="boolean">
Whether to hide this dropdown by default.
</ResponseField>
Expand Down Expand Up @@ -130,6 +148,9 @@ See [Navigation](/organize/navigation) for complete documentation on building yo
<ResponseField name="product" type="string" required>
Display name of the product.
</ResponseField>
<ResponseField name="name" type="string">
Optional display name for the product. When set, this is shown instead of the `product` field value.
</ResponseField>
<ResponseField name="description" type="string">
Description of the product.
</ResponseField>
Expand Down
Loading