feat(docs): add PostHog tracking for API explorer responses #5489
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Co-Authored-By: Catherine Deskur <catherine@buildwithfern.com>
Contributor
Author
🤖 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:
|
Contributor
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Contributor
🌱 Smoke Test PreviewTesting branch changes with smoke test content:
🕷️ Smoke Test Crawler ResultsPages crawled: 33 🎉 All pages loaded successfully with no errors! |
![vercel[bot]](https://avatars.githubusercontent.com/in/8329?s=60&v=4){kind=small}
packages/fern-docs/bundle/src/components/playground/endpoint/PlaygroundEndpoint.tsx
Outdated
Show resolved
Hide resolved
Co-Authored-By: Catherine Deskur <catherine@buildwithfern.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Short description of the changes made
Updates the
api_playground_request_receivedPostHog tracking event to include additional fields and extends tracking to cover all response types (REST, stream, and audio file responses).New tracked fields:
docsRoute- the docs route pathendpointId- the endpoint IDendpointName- the endpoint nameendpointRoute- the endpoint route path (e.g.,/users/:id)method- the HTTP methodresponseCode- the HTTP response status coderesponseMessage- the response body (truncated to 100 characters)What was the motivation & context behind this PR?
Requested by Catherine Deskur to improve analytics tracking for API explorer usage.
How has this PR been tested?
pnpm lint:biome)pnpm format)Updates since last revision
?? "") for whenJSON.stringify()returnsundefined, addressing Vercel Agent feedbackHuman Review Checklist
api_playground_request_receivedevent structure changed - the nestedresponseobject (withstatus,statusText,time,size) was replaced with flat fields (responseCode,responseMessage). Verify this is acceptable for existing PostHog dashboards."[audio file response]"instead of actual content - confirm this is appropriateLink to Devin run: https://app.devin.ai/sessions/9363494060664bb9b7a00175fb4a850d
Requested by: Catherine Deskur (catherine@buildwithfern.com)