Skip to content

Update Report Dashboard Api

PATCH
/report-dashboards/{dashboard_id}

Edit a dashboard this credential owns: title, description, visibility, the order of its reports. expected_revision guards a concurrent edit (409).

Authorizations

Parameters

Path Parameters

dashboard_id
required
string format: uuid

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

object
description
Any of:
string
<= 2000 characters
expected_revision
Any of:
integer
>= 1
report_ids
Any of:
Array<string>
<= 12 items
title
Any of:
string
>= 1 characters <= 200 characters
visibility
Any of:
string
Allowed values: private org

Responses

200

Successful Response

object
data
required
object
can_delete
required
boolean
can_edit
required
boolean
cards
Array<object>

One card as THIS viewer may see it. report (and report_id) only when ok: the card runs that report through its own run operation, as the viewer. hidden: the position (and title / owner only for the report’s own owner). not_available: only the position.

object
owner
Any of:
object
id
Any of:
string
is_you
boolean
name
Any of:
string
position
required
integer
report
Any of:
object
can_delete
required
boolean
can_edit
required
boolean
chart_type
required
string
Allowed values: table bar line funnel stage_over_time time_in_stage
config
required
object
key
additional properties
any
created_at
required
string format: date-time
description
Any of:
string
id
required
string format: uuid
is_owner
required
boolean
owner
required
object
id
Any of:
string
is_you
boolean
name
Any of:
string
restricted
Array<object>

A part of a report the viewer may not see. Hidden means ABSENT: it carries no title, no object name, no type and no reason, only its position id (m0 the first measure, g0 the first group-by, f0 the first filter, stage the stage field), so a client can lock that slot in place.

object
id
required
string
restricted
boolean
default: true
restricted_count
integer
revision
required
integer
source
required
object
is_archived
boolean
kind
required
string
Allowed values: object process_list
plural_noun
required
string
singular_noun
required
string
slug
required
string
title
required
string
updated_at
required
string format: date-time
visibility
required
string
Allowed values: private org
report_id
Any of:
string format: uuid
state
required
string
Allowed values: ok hidden not_available
title
Any of:
string
created_at
required
string format: date-time
description
Any of:
string
id
required
string format: uuid
is_owner
required
boolean
owner
required
object
id
Any of:
string
is_you
boolean
name
Any of:
string
report_count
integer
revision
required
integer
title
required
string
updated_at
required
string format: date-time
visibility
required
string
Allowed values: private org
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string