---
title: "Generate embed URL for a given workbook"
method: POST
path: "/management/v2/reports/embed/generate-url"
tags: ["Embedded Reports"]
---

# Generate embed URL for a given workbook

`POST /management/v2/reports/embed/generate-url`

## Request

- Base URL: `https://your-subdomain.deputy.deputy.com/api`
- URL: `https://your-subdomain.deputy.deputy.com/api/management/v2/reports/embed/generate-url`
- Auth: API key in header `OAuth`

Generate embed URL for a given workbook.

## Request body

- EmbeddedReportsGenerateURLRequest
  - `data` ModelEmbedPayload
    - `workbookId` string
    - `workbookUrlId` string
    - `action` string
    - `isCustomWorkbook` boolean

## Response `200`

A successful response.

- EmbeddedReportsGenerateURLResponse
  - `success` boolean
  - `embedUrl` string
  - `isUserMigrated` boolean

---

[API](https://skmtc.dev/deputy/apis/deputy-v2-api.md) - [All operations](https://skmtc.dev/deputy/apis/deputy-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/deputy/apis/deputy-v2-api/revisions/78f0278f4608?raw)