Create Analytics Folder

Make a folder in your Analytics sidebar, at the top of Pages, Reports or Shared with me, or inside another folder.

POST

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

stringrequired

The folder name.

The folder name, 1 to 255 characters.

string

pages (the default), reports, or sharedWithMe. A subfolder goes where its parent is.

Which section the folder goes in: pages (the default), reports, or sharedWithMe. Ignored with parentFolderId, where the folder goes where its parent is.

pagesHolds your own pages (the default).
reportsHolds your own reports.
sharedWithMeOrganizes pages other people shared with you.

string

The id of a folder to put this one inside, from List Analytics Folders.

A folder to create this one inside, from List Analytics Folders.

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.