> ## Documentation Index
> Fetch the complete documentation index at: https://help.trfyx.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Embedded dashboards

> Prepare and share Trfyx dashboard views with the right audience.

# Embedded dashboards

Embedded dashboards let you present analytics in another part of your workflow or product, where teammates or intended viewers can access the information they need. The exact embedding method, access model, and available controls depend on the dashboard and sharing options enabled in your Trfyx workspace.

Before distributing an embedded view, confirm what data it exposes, who can access it, and whether the viewer experience matches your intended use.

## Prepare a dashboard for sharing

<Steps>
  <Step title="Choose the audience and purpose">
    Decide whether the dashboard is for internal reporting, customer-facing product experiences, or another use case. The audience determines what data should be included and what access controls are appropriate.
  </Step>

  <Step title="Keep the view focused">
    Include the metrics and breakdowns needed for the decision at hand. Remove irrelevant charts, test data, and filters that could mislead viewers.
  </Step>

  <Step title="Check date ranges and definitions">
    Make metric definitions, time ranges, timezone assumptions, and important filters clear. Avoid comparing unlike periods or audiences without explaining the difference.
  </Step>

  <Step title="Use the supported embed or sharing flow">
    Follow the dashboard's current embed or share instructions in Trfyx. Do not expose workspace credentials, API secrets, or private links in public pages or client-side source code.
  </Step>

  <Step title="Test as a viewer">
    Open the destination using the same access level as the intended viewer. Confirm that it loads correctly and reveals only the data that audience is authorized to see.
  </Step>
</Steps>

## Security and access considerations

* Apply the least-privilege principle: share only the data required by the audience.
* Never place secret API tokens or workspace credentials in browser code.
* Treat public embed URLs as public if anyone who has the URL can access them.
* Confirm whether filters are merely visual or actually restrict the underlying data available to the viewer.
* Review privacy requirements before embedding user-level information or session-related details.
* Re-test permissions after changing dashboard settings or moving the embed to a new location.

## Design guidelines

**Lead with the decision.** Place the most important performance indicator first, followed by diagnostic detail.

**Use consistent definitions.** Two charts labeled "conversion rate" should use the same numerator, denominator, and time window unless the difference is explicitly explained.

**Show the time period.** A metric without a date range can be misunderstood.

**Include context for unusual results.** Where appropriate, annotate releases, campaigns, outages, or tracking changes that affect interpretation.

**Test responsive behavior.** Confirm that the embed remains readable on the screen sizes your audience uses.

## Troubleshooting an embed

If an embed does not load, verify the URL or method generated by Trfyx, the viewer's access, the destination page's security policy, and any browser-console errors. If it loads but shows unexpected values, inspect filters, date ranges, project selection, and data permissions.

See [Troubleshooting](/troubleshooting) for the broader tracking and reporting checklist.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.