Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Attach a known user to the session so replays, funnels, and filters are searchable by who did what.
identify once you know who the user is — typically right after login. Every
session before and after links to that user, and earlier anonymous sessions are
associated retroactively. Pass a stable distinctId (your own user id) plus any
traits you want to filter and segment on (email, name, plan, …).
replay.identify("user_123", { email: "[email protected]", plan: "pro" });
Replayfy.identify("user_123", { email: "[email protected]", plan: "pro" });
Replay.identify("user_123", properties: ["email": "[email protected]", "plan": "pro"])
Replay.identify("user_123", mapOf("email" to "[email protected]", "plan" to "pro"))
Replay.identify("user_123", { email: "[email protected]", plan: "pro" });
Replay.identify("user_123", properties: {"email": "[email protected]", "plan": "pro"});
email, name, plan, and picture are promoted to first-class user fields on the dashboard — filterable, and picture renders as the user’s avatar. Any other trait is kept as searchable custom metadata.picture (or its alias avatar) to a public https image URL to show the user’s avatar on the recording header and the Users list. It works as a top-level trait or nested inside customProps, so every SDK supports it today with no upgrade; non-URL values are ignored.replay.identify("user_123", { email: "[email protected]", picture: "https://cdn.example.com/u/123.png" });
// or, from any SDK, via custom properties:
replay.identify("user_123", { customProps: { avatar: "https://cdn.example.com/u/123.png" } });
Replayfy.identify("user_123", { email: "[email protected]", picture: "https://cdn.example.com/u/123.png" });
// or, from any SDK, via custom properties:
Replayfy.identify("user_123", { customProps: { avatar: "https://cdn.example.com/u/123.png" } });