Skip to content

Dj sr heatmaps may #1892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Dj sr heatmaps may #1892

wants to merge 5 commits into from

Conversation

djmixpanel
Copy link
Contributor

No description provided.

Copy link

vercel bot commented Jun 5, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 6, 2025 4:19pm

@djmixpanel djmixpanel marked this pull request as ready for review June 6, 2025 16:11
@djmixpanel djmixpanel requested a review from a team as a code owner June 6, 2025 16:11
@djmixpanel djmixpanel requested review from ishamehramixpanel and removed request for a team June 6, 2025 16:11
Copy link
Contributor

@carlosdanieltt carlosdanieltt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good from my end!

@@ -21,6 +31,10 @@ To function, Heatmaps require Session Replay to be enabled, as they rely on sess

Heatmaps only capture data during sessions with recorded replays. If a page has limited replay coverage, the Heatmap may not offer meaningful insights.

<Callout type="warning">
When clicks occur very close to page navigation events, the heatmap may occasionally show clicks on the wrong page. This happens because the timing between page changes and click events may not align perfectly. If you notice clicks appearing on the wrong page, try using a different [backdrops](#backdrops) to find the correct page state.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: backdrop should be singular.

@dhaval-valotia dhaval-valotia requested a review from Copilot June 6, 2025 16:30
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates the documentation for session replays and heatmaps, providing more detailed information about the retention period and clarifying the features available.

  • Extended retention period details and customization options for user/session replays.
  • Added detailed descriptions for two types of heatmaps (Click Maps and Traditional Heatmaps) along with additional callouts for clarity.
  • Minor copy updates to ensure consistency across the documentation files.

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated no comments.

Show a summary per file
File Description
pages/docs/tracking-methods/sdks/swift/swift-replay.mdx Updated retention period text with enterprise customization details.
pages/docs/session-replay/implement-session-replay/session-replay-ios.mdx Updated retention period text to include customization details.
pages/docs/session-replay/implement-session-replay/session-replay-android.mdx Updated retention period text to include customization details.
pages/docs/session-replay/heatmaps.mdx Expanded heatmaps documentation with new sections for Click Maps and Traditional Heatmaps and updated callouts.
pages/docs/session-replay.mdx Updated multiple retention text areas and added a list item on event feed display properties.
Comments suppressed due to low confidence (2)

pages/docs/session-replay.mdx:43

  • Consider updating this callout to include the full retention customization range (between 7 days and 360 days) for consistency with the other sections.
By default, user replays are stored for 30 days after the time of ingestion. Customers on our Enterprise plan can customize this retention period. Once a replay is expired, there is no way to view that replay.

pages/docs/session-replay/heatmaps.mdx:108

  • [nitpick] Ensure language consistency by using uniformly styled quotes and apostrophes throughout the documentation to improve readability.
Backdrops are snapshots of your application in various states (such as a modal open, a menu expanded, or different page layouts). Backdrops are pulled from session replays that match the URL you're analyzing, helping you understand how different views or UI states affect user interactions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants