v1

latestOpenAPI 3.0.02026-07-24990169.2 KB

List charts

Search and filter a list of your charts. The returned chart objects, do not include the full chart metadata. To get the full metadata add ?expand=true or use /v3/charts/{id}. Requires scope chart:read.

get/charts

Query parameters

userIdinteger

User id of visualization author

authorIdinteger

User id of visualization author

publishedboolean

Flag to filter results by publish status

searchstring

Search for charts with a specific title.

folderIdinteger

List visualizations inside a specific folder

teamIdstring

List visualizations belonging to a specific team. Use teamId=null to search for user visualizations not part of a team

workspacestring

List visualizations belonging to a specific workspace

order'ASC' | 'DESC'

Result order (ascending or descending)

orderBystring

limitinteger

Maximum items to fetch. Useful for pagination.

offsetinteger

Number of items to skip. Useful for pagination.

minLastEditStepinteger

Filter visualizations by the last editor step they've been opened in (1=upload, 2=describe, 3=visualize, etc)

expandboolean

When set to true, the response includes additional properties such as visualization metadata.

openCommentsboolean

Include open comments count

deletedboolean

Only return deleted charts in the response

Response

Successful