---
search:
  tags:
    - Reports and dashboards
    - POST
seo:
  description: >-
    Runs a definition without saving it, so a caller can see the result before…
    Reference for the POST /api/v1/reports/preview endpoint in the Taylorz CRM
    API.
sidebar:
  label: Preview a report definition
  badge: POST
title: Preview a report definition
type: openapi-operation
---
Runs a definition without saving it, so a caller can see the result before creating the report.

`POST /api/v1/reports/preview`

**Request body** (`application/json`, required)

- `filters` (object[])
- `groupBy` (string)
- `limit` (integer)
- `measure` (object, required)
- `objectId` (string, required)

Request body example:

```json
{
  "filters": [],
  "groupBy": "string",
  "limit": 50,
  "measure": {
    "operation": "count"
  },
  "objectId": "string"
}
```

**Responses**

- `200` — The rows the definition produces
- `400` — The request body, query or parameters were refused
- `401` — The access token is missing, invalid or revoked
- `403` — The tenant's module is off, or the token's scope or the member's role does not permit the action
- `404` — No such record, or none the caller may read
- `413` — The request exceeds the route's body limit
- `500` — An unexpected failure

Response example, 200:

```json
[
  {
    "label": "string",
    "value": "string"
  }
]
```