Install Analytics Template

Install a template as your own page, or a bundle as pages in a new folder. Give a connection id, or null to skip, for every app the install plan lists. Synced data sources start fetching right away.

POST

Path

Path parameters

stringrequired

The template id, from List Analytics Templates.

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

objectrequired

A connection id or null for every app the install plan lists, keyed by app id or slug.

One entry per app the template needs, keyed by the app's id or slug (from the install plan): a connection id (from the install plan or List Connections), or null to skip that app.

string

A name for the new page (or a bundle's folder).

A name for the new page, or for a bundle's new folder. Defaults to the template's name.

array of string

For a bundle, the members to install, from the install plan's members.

For a bundle, the members to install (ids from the install plan's members). Defaults to every member you can install.

Response fields

kindstring

page for one installed page; bundle for a bundle installed as pages in a new folder.

page
bundle

folderIdstring

The new folder holding a bundle's pages (List Analytics Folders), or null for a page template.

pagesarray of objects

The pages the install made.

idstring
The new page, now yours: read it with Get Analytics Page.
templateIdstring
The template it was made from (for a bundle, the member).
connectedAppIdsarray
The apps wired to the connections you gave. Their data sources are fetching now.
skippedAppIdsarray
The apps you skipped. Their data sources and the panels reading them stay empty until you connect them.

reusedDataSourceCountnumber

How many of the template's data sources were ones you already had, from an earlier install: they are reused with their data. Null for a bundle.