List Analytics Folders

See the folders in your Analytics sidebar: your pages and reports, and the pages others shared with you, organized as you filed them. Use a folder's id to file a page into it, give its pages a theme, pause it or share it.

GET

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.

Query

FiltersNarrow list results with a provider-supported where expression. Learn more

string

RSQL expression used to filter list results.

PaginationRequest a specific window of rows with limit and offset. Learn more

number

Maximum number of rows to return.

number

Number of rows to skip.

SortingChoose the order of returned rows when this action supports sorting. Learn more

string

Comma-separated sort fields; prefix with - for descending.

Field selectionChoose which fields should be included in the response. Learn more

string

Comma-separated response fields to include.

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.