Skip to navigation

Verify a report code representation (Deprecated)

Deprecated
View as Markdown

Deprecation notice: This endpoint is deprecated. Instead, use POST /v2/reports with contents and dryRun: true in the request body.

This endpoint validates a report code representation without creating or modifying any report. It performs the same validation as the /v2/reports/spec endpoint but never persists the result, so you can confirm a representation is valid before creating a report from it.

Beta: This documentation describes a private beta feature and is subject to the Beta features disclaimer.

System and user requirements

  • To perform this operation, you must use API credentials owned by a user assigned an account type with Create, edit, and publish reports permission.

Usage notes

  • The response valid field indicates whether the representation passed validation. When valid is false, the errors array describes each validation failure.
  • The request body is identical to the /v2/reports/spec endpoint.
  • No report is created and no data is persisted by this endpoint.

Usage scenarios

  • Agentic workflows: Agents can validate a generated representation before committing it to a create or update operation.
  • Automation: Validate representations in CI or migration tooling before applying them.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

The request body.
namestringRequired
The name of the report.
folderIdstringRequired
The identifier of the folder in which the report is located.
documentobjectRequired

The code representation of the report to write: its pages, elements, columns, sources, layout, and theme.

descriptionstringOptional
The description of the report.

Response

The response body.
object
A valid report code representation.
OR
object
An invalid report code representation, with the validation failures.