List Analytics Pages

See every Analytics page the key's creator can open, their own and the ones shared with them. Search by name with q, and filter by type, access, ownerId, folderId or isPaused.

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

Arguments

string

Part of the page name, or its id.

Search text: pages whose name contains it, ignoring case, or whose id is exactly it. * is a wildcard.

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

The page id.

namestring

The page title.

descriptionstring

The line under the title, or null.

typestring

What kind of page it is.

pageAn ordinary page in the sidebar.
reportA report: one written panel that fills the page.
subpageA page opened from a click on another page, not listed on its own.

accessstring

What the key's creator can do on it.

ownerThe key's creator owns the page.
editShared with the creator to edit.
viewShared with the creator to view.

ownerIdstring

The owner's userId, from List Members.

ownerNamestring

The owner's name.

folderIdstring

The creator's folder the page is filed in (from List Analytics Folders), or null when it is unfiled or shared with them.

iconstring

The page icon id, or null.

iconColorstring

The page icon color, or null.

isPausedboolean

Whether its data stopped refreshing, by the page itself or a folder above it.

pausedByFolderIdstring

The folder that paused it (from List Analytics Folders), or null.

hasSharesboolean

Whether anyone besides the owner can open it.

linkedFromPageIdsarray of string

The pages whose clicks open this one, from List Analytics Pages.

createdOndate

When it was created.

updatedOndate

When the page or one of its panels last changed.