> For the complete documentation index, see [llms.txt](https://docs.changeup.com/app/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.changeup.com/app/changeup-dms/reporting/embed-reports.md).

# Embed Reports

The following is example code for generating an embeddable URL for a report. Your account manager can assist with the dashboard, necessary filters, and the reporting API key. Custom reporting dashboards can be tailored to client specifications.

```javascript
const {createHmac} = require("crypto");

const key = 'Your ChangeUp Reporting Secret API Key';

// the dashboard you want to embed
const dashboard = 'dsh_01GRS8C4BVZ8X9N7E86Z82DQG9'

// compose the data object with filters and dashboard
const data = encodeURIComponent(
  JSON.stringify({
    dashboard,
    filters: {
      "Date Range": "last_month",
      "Aggregation": "day",
      "ClientId": "YourClientId",
      // more filters can be added based on dashboard design
    }
  })
);

// create the encrypted signature
const signature = createHmac("sha256", key).update(data).digest("hex");

// compose the embed url
const embedUrl = `https://reporting.changeup.com/embed/dashboard/${dashboard}?data=${data}&signature=${signature}`
java
```

### Sample Reports

<div><figure><img src="/files/qlAh2iUaGZ8C5W3g1O31" alt="Sample changeup donations report" width="450"><figcaption><p>Sample donation activity report</p></figcaption></figure> <figure><img src="/files/LogNtwSELzPQNYOhdfVT" alt=""><figcaption><p>Sample transaction level report</p></figcaption></figure></div>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.changeup.com/app/changeup-dms/reporting/embed-reports.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
