report

Update an existing report

patch/v1/org/{orgId}/report/{reportId}

Request

  • Base URL: https://localhost
  • URL: https://localhost/v1/org/{orgId}/report/{reportId}
  • Auth: none declared

Path parameters

orgIdstring required

Org identifier (either id or slug)

reportIdstring required

Report id

Query parameters

referencedReportUrlstring

Displayed report url

Request body

labelstring

report label

descriptionstring

report description

filterstring

filter automatically applied to every chart in this report

share'NORMAL' | 'FULL'

sharing settings of report

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE'

sensitivity level of report

chartIdsstring[]

list of charts in this report

Example request

{
  "label": "Headcount Report",
  "description": "This is a report on headcount etd",
  "filter": "department:engineering",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "chartIds": [
    "588f7ee98f138b19220041a7"
  ]
}

Response

report updated

Changes

No recorded changes to this operation across all 20 revisions of this API.