Amplitude
Send analytics events from your documentation site to Amplitude.
Amplitude helps you understand user behavior through event-based analytics. Enable the integration to send documentation page views and events to your Amplitude project.
Prerequisites
-
An Amplitude account with a project created
-
Your Amplitude API key
-
Publishing access to your documentation project
Configure from the Editor
Open Site Config
In the Editor, click Site Config in the top toolbar.
Navigate to Integrations
Select Integrations from the left sidebar.
Enable Amplitude
Select Amplitude and enter your API key.
Publish
Click Publish to deploy the integration to your live site.
Configure via documentation.json
Add the amplitude key under integrations in your documentation.json:
{
"integrations": {
"amplitude": {
"apiKey": "your_amplitude_key"
}
}
}
| Property | Type | Required | Description |
|---|---|---|---|
apiKey | string | Yes | Your Amplitude API key |
Where to find your API key
-
Sign in to Amplitude.
-
Go to Settings → Projects → select your project.
-
Copy the API key from the project settings.
What's next
-
Analytics and Chat Integrations — overview of all supported integrations
-
Segment — route analytics data through Segment
-
Analytics overview — view traffic and engagement data for your documentation
Last updated 1 day ago
Built with Documentation.AI