NUnullplatform
Reports

Update a report

Changed on

Partially updates a report's draft. Send only the fields you want to change.

patch/report/{id}

Request

  • Base URL
    https://api.nullplatform.com
  • URL
    https://api.nullplatform.com/report/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

The unique identifier of the report.

Request body

namestring

The report's display name.

slugstring

A URL-friendly identifier for the report.

descriptionstring

A human-readable description of what the report shows.

schemaobject

A JSON Schema defining the report's input fields.

ui_schemaobject

A UI Schema controlling how the form renders.

queriesQueries

A map of query IDs to query definitions. Each ID is a name you choose to identify the query within the report.

visibility'user' | 'organization'

Who can see the report. user keeps it private to its owner; organization shares it with the whole organization.

Example request

{
  "name": "Deployment frequency",
  "slug": "deployment-frequency",
  "description": "Deployments per application, per week",
  "visibility": "user"
}

Response

The updated report.

idstring uuid

The unique report identifier.

namestring

The report's display name.

slugstring

A URL-friendly identifier for the report.

descriptionstring

A human-readable description of what the report shows.

schemaobject

A JSON Schema defining the report's input fields.

ui_schemaobject

A UI Schema controlling how the form renders.

queriesQueries

A map of query IDs to query definitions. Each ID is a name you choose to identify the query within the report.

visibility'user' | 'organization'

Who can see the report. user keeps it private to its owner; organization shares it with the whole organization.

created_atstring date-time

The ISO 8601 timestamp of when the report was created.

updated_atstring date-time

The ISO 8601 timestamp of the report's last update.

Example response

{
  "id": "ff5970bf-592d-4a8d-b858-3175ec444562",
  "name": "Deployment frequency",
  "slug": "deployment-frequency",
  "description": "How often each application deploys",
  "visibility": "user",
  "created_at": "2026-07-20T12:00:00Z",
  "updated_at": "2026-07-20T12:00:00Z"
}

Changes