docs: add analytics events reference page#5512
Conversation
Co-Authored-By: will.kendall@buildwithfern.com <wpk235@gmail.com>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| | `code_block_feedback_opened` | User opened the feedback prompt on a code block. | Code block context | | ||
| | `code_block_feedback_submitted` | User submitted feedback on a code block. | Code block context | | ||
|
|
||
| ## API Playground events |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'API Playground events' should use sentence-style capitalization.
|
|
||
| This disables all analytics integrations configured in the `analytics` section of `docs.yml`, including Google Analytics 4, Google Tag Manager, PostHog, and any other providers. | ||
|
|
||
| ## CLI and Dashboard events |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'CLI and Dashboard events' should use sentence-style capitalization.
|
|
||
| ## CLI and Dashboard events | ||
|
|
||
| The Fern CLI and [Dashboard](https://dashboard.buildwithfern.com) emit their own analytics events for internal product telemetry (command usage, onboarding funnels, billing events, etc.). These are not forwarded to your analytics providers and are used only by Fern for product improvement. |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Microsoft.Contractions] Use 'aren't' instead of 'are not'.
|
🌿 Preview your docs: https://fern-preview-devin-1778793395-analytics-events-reference.docs.buildwithfern.com/learn Here are the markdown pages you've updated: |
Co-Authored-By: will.kendall@buildwithfern.com <wpk235@gmail.com>
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
| | `$pageview` | Fired on every route change. Includes the current URL. | PostHog, Segment | | ||
| | `$pageleave` | Fired when a user navigates away from a page. | PostHog | | ||
|
|
||
| Page view tracking is automatic and requires no additional configuration. GA4 and GTM handle their own page view tracking natively when configured. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'GTM' has no definition.
|
|
||
| | Event | Description | Forwarded to | | ||
| | --- | --- | --- | | ||
| | `feedback_voted` | User clicked the thumbs up or thumbs down button. | PostHog, GA4, GTM | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'GTM' has no definition.
| | Event | Description | Forwarded to | | ||
| | --- | --- | --- | | ||
| | `feedback_voted` | User clicked the thumbs up or thumbs down button. | PostHog, GA4, GTM | | ||
| | `feedback_submitted` | User submitted written feedback after voting. | PostHog, GA4, GTM | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'GTM' has no definition.
| | --- | --- | --- | | ||
| | `feedback_voted` | User clicked the thumbs up or thumbs down button. | PostHog, GA4, GTM | | ||
| | `feedback_submitted` | User submitted written feedback after voting. | PostHog, GA4, GTM | | ||
| | `code_block_feedback_opened` | User opened the feedback prompt on a code block. | PostHog, GA4, GTM | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'GTM' has no definition.
| | `feedback_voted` | User clicked the thumbs up or thumbs down button. | PostHog, GA4, GTM | | ||
| | `feedback_submitted` | User submitted written feedback after voting. | PostHog, GA4, GTM | | ||
| | `code_block_feedback_opened` | User opened the feedback prompt on a code block. | PostHog, GA4, GTM | | ||
| | `code_block_feedback_submitted` | User submitted feedback on a code block. | PostHog, GA4, GTM | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'GTM' has no definition.
|
|
||
| | Event | Description | Forwarded to | | ||
| | --- | --- | --- | | ||
| | `api_playground_request_sent` | User sent a request from the API Explorer. | PostHog, GA4, GTM | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'GTM' has no definition.
| | Event | Description | Forwarded to | | ||
| | --- | --- | --- | | ||
| | `api_playground_request_sent` | User sent a request from the API Explorer. | PostHog, GA4, GTM | | ||
| | `api_playground_request_received` | A response was received in the API Explorer. | PostHog, GA4, GTM | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'GTM' has no definition.
|
|
||
| | Event | Description | Forwarded to | | ||
| | --- | --- | --- | | ||
| | `not_found` | A visitor hit a 404 page. | PostHog, GA4, GTM | |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Acronyms] 'GTM' has no definition.
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
…sing provider cards Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
Co-Authored-By: Devin Logan <devinannlogan@gmail.com>
…/github.com/fern-api/docs into devin/1778793395-analytics-events-reference
| | --- | --- | --- | | ||
| | `not_found` | A visitor hit a 404 page. | PostHog, GA4, GTM | | ||
|
|
||
| ## CLI and Dashboard events |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[FernStyles.Headings] 'CLI and Dashboard events' should use sentence-style capitalization.
1 participant
Summary
Adds a new "Analytics events reference" page and updates the integrations overview with more context about how Fern handles analytics.
New page (
analytics-events.mdx):Overview page updates (
overview.mdx):Other changes:
Review & Testing Checklist for Human
/learn/docs/integrations/analytics/events/learn/docs/integrations/overviewfern-platformcodebase (packages/fern-docs/bundle/src/components/analytics/)Notes
track()event bus reach PostHog, GA4, and GTM. Page views are sent directly to PostHog and Segment.ask_ai_suggestis server-side internal only.Link to Devin session: https://app.devin.ai/sessions/7eb127847ed44b0db184b320e1a6ab12
Requested by: @devalog