AnalyticsAmplitude
Analytics

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"
    }
  }
}
PropertyTypeRequiredDescription
apiKeystringYesYour Amplitude API key

Where to find your API key

  1. Sign in to Amplitude.

  2. Go to SettingsProjects → select your project.

  3. Copy the API key from the project settings.

What's next