Update Analytics Folder

Rename, move, theme or pause one of your Analytics folders. A folder's theme dresses every page in it that has no theme of its own; pausing it stops its pages refreshing their data until you resume it. Every change is checked first, so a refused one changes nothing.

PUT

Path

Path parameters

stringrequired

The folder id, from List Analytics Folders.

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. Here a key acts in another organization only as one of its members: with "Use this key across all of your organizations" on, in an organization its creator belongs to with a role. Child organizations and MindCloud staff access do not reach this endpoint. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Body

Arguments

string

The new folder name.

The new folder name, 1 to 255 characters.

string

A folder to move this one into, from List Analytics Folders, or null for the top of its section.

Move the folder inside this folder (from List Analytics Folders), or null to move it to the top of its section. It keeps its pages, subfolders and shares.

string

A theme id from List Analytics Themes, "cirra", or null.

The theme the folder's pages wear unless a page picks its own: a theme id from List Analytics Themes, "cirra" for the plain Cirra look, or null to follow the organization default.

boolean

true to pause the folder, false to resume it.

true pauses the folder: its pages stop refreshing their data. false resumes it and brings its pages up to date.

Response fields

idstring

Unique id of the folder.

positionnumber

Its place in the sidebar, from 0: sort by it to read the folders in the order the sidebar shows them.

namestring

The folder name, as the Analytics sidebar shows it.

sectionstring

Which part of the sidebar the folder is in: pages and reports hold your own pages and reports; sharedWithMe organizes pages other people shared with you.

pages
reports
sharedWithMe

parentFolderIdstring

The folder this one is inside (from List Analytics Folders), or null at the top of its section.

themeIdstring

The theme every page in the folder wears unless the page picks its own: a theme id from List Analytics Themes, "cirra" for the plain Cirra look, or null to follow the organization default.

isPausedboolean

Whether the folder is paused: its pages stop refreshing their data until it is resumed.

pausedOndate

When the folder was paused, or null.

hasSharesboolean

Whether the folder is shared with anyone (List Analytics Folder Shares).

createdOndate

When the folder was created.

updatedOndate

When the folder was last changed.