---
title: "Start a workbook report generation. Use the returned URL to check the status of the report generation."
method: POST
path: "/api/v1/Reports/Workbooks/{workbookId}/Generate"
tags: ["Reports"]
---

# Start a workbook report generation. Use the returned URL to check the status of the report generation.

`POST /api/v1/Reports/Workbooks/{workbookId}/Generate`

## Request

- Base URL: `https://api.slopesoftware.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.slopesoftware.com/api/v1/Reports/Workbooks/{workbookId}/Generate`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/slopesoftware/apis/akur8-life-api/docs/api/v1/Reports/Workbooks/:workbookId/Generate/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `workbookId` string, required: Workbook ID

## Request body

- GenerateWorkbookReportRequestV1
  - `elementId` string, nullable: Workbook Element ID
  - `reportFormat` 'Csv' | 'Excel' | 'Png'
  - `rowLimit` integer, nullable: Row Limit
  - `offset` integer, nullable: Offset
  - `parameters` object, nullable: Parameters — the Workbook control values to apply, keyed by the control's name. At least one projection ID control has to be supplied; filtering the report down far enough to complete in time is the caller's responsibility.

## Response `200`

Success

## Other responses

- `201`: Created
- `400`: Bad Request
- `401`: Unauthorized
- `403`: Not Allowed To Access
- `404`: Not Found
- `429`: Too Many Requests

---

[API](https://skmtc.dev/slopesoftware/apis/akur8-life-api.md) - [All operations](https://skmtc.dev/slopesoftware/apis/akur8-life-api/llms.txt) - [OpenAPI document](https://skmtc.dev/slopesoftware/apis/akur8-life-api/revisions/9771b2c79880?raw)