Skip to content
Mintlify
Mintlify
Analytics

Stream analytics events to Amazon S3

Configure Enterprise analytics streaming to send selected event categories from your Mintlify deployments to Amazon S3 in near real time.

Analytics require a Pro or Enterprise plan. Analytics streaming is available only on Enterprise plans.

Stream analytics events to Amazon S3 in near real time to send events to your data warehouse or downstream analytics pipelines without waiting for CSV exports.

Organization admins can add multiple destinations, select which event categories to send, and select which deployments to stream from. Analytics streaming uses an inclusion model: no events stream until you select at least one category and one deployment. The same category and deployment selections apply to every destination.

Add a destination

  1. Navigate to the Streaming page of your dashboard.
  2. In the Stream configuration section, click Configure.
  3. Select Add destination.
  4. Enter an optional label, then provide the Amazon S3 bucket, AWS region, access key ID, and secret access key. Optionally, enter a prefix that Mintlify adds to the beginning of every object key.
  5. Select Add destination.

To stop streaming to a destination, open the streaming configuration, click the remove icon next to the destination, then click Remove to confirm.

Select streamed categories

  1. Navigate to the Streaming page of your dashboard.

  2. In the Stream configuration section, click Configure.

  3. In the categories table, select the categories that you want to send.

    CategoryExamples
    Page viewsPage and Markdown view events.
    NavigationNavigation item clicks, navigation call-to-action clicks, and version changes.
    SearchSearch queries, result clicks, search closes, and search comparisons.
    Page componentsExpandable, accordion, code block, and API playground interactions.
    FeedbackThumbs up, thumbs down, and detailed feedback submissions.
    AI AssistantAssistant conversations, sources, suggestions, feedback, and errors.
    Context menu & MCPContext menu actions, MCP link copies, MCP server installs, and MCP tool calls.

    The examples summarize each category. Use the streamed eventType value to identify the exact event.

  4. Click Save.

Select streamed deployments

Select which of your organization’s deployments send events. The dashboard lists each deployment by subdomain. If you create a deployment, return to the streaming configuration and select it. New deployments do not automatically start streaming events.

  1. Navigate to the Streaming page of your dashboard.
  2. In the Stream configuration section, click Configure.
  3. In the deployments table, select the deployments that you want to send events from.
  4. Click Save.

No events stream until you select at least one category and one deployment.

Understand streamed data

Mintlify writes newline-delimited JSON (.jsonl) objects to your bucket. Mintlify generates object names from UTC timestamps. If you configure a key prefix, Mintlify writes the objects under that prefix.

Each line contains an event envelope with an eventType and payload. The eventType is the event name, such as docs.content.view. The payload contains the analytics event as a JSON object or a JSON-encoded string. If payload is a string, parse it as JSON before loading it into your warehouse.

The event payload contains the following fields:

FieldDescription
event_idUUID that identifies the event. Use it as a deduplication key when loading data.
subdomainSubdomain of the deployment that generated the event.
user_idID of the authenticated user, when available.
anon_idAnonymous visitor ID, when available.
session_idVisitor or assistant session ID, when available.
created_atISO 8601 timestamp for when the event occurred.
eventEvent name. This matches eventType in the envelope.
pathDocumentation path where the event occurred.
referrerReferring URL, when available.
user_agentBrowser or client user-agent string.
ipVisitor IP address.
propertiesEvent-specific data as a JSON object or JSON-encoded string.

Configuration changes can take up to one minute to apply.

Streamed events can contain personal data, including IP addresses, user and session identifiers, assistant queries and responses, and feedback comments or contact information. Apply access controls, retention policies, and other data-handling requirements appropriate for your organization.

Was this page helpful?Suggest editsRaise issue