Get Analytics Template Install Plan

See what a template needs before you install it: the apps to connect, the connections you can pick for each, and, for a bundle, its pages. Then call Install Analytics Template with a connection id (or null to skip) for every app.

GET

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.

Response fields

templateIdstring

The template the plan is for, from List Analytics Templates.

kindstring

page installs one page; bundle installs its members as pages in a new folder.

page
bundle

appsarray of objects

Every app the install needs, each with the connections it accepts. Install Analytics Template takes a connection id or null (skip it) for every one.

appIdstring
The app. Use it, or appSlug, as the key in Install Analytics Template connections.
appSlugstring
The app's slug, as List Universal Apps answers it.
appNamestring
The app's name.
dataSourceCountnumber
How many of the template's data sources read this app.
panelCountnumber
How many panels show nothing until this app is connected.
connectionsarray
The connections the install accepts for this app: your own and the organization's shared ones. Empty when you have none; connect the app in MindCloud first, or skip it.
- idstring
  The connection id, as List Connections answers it. Pass it in connections to wire the app.
- namestring
  The connection name, as List Connections answers it.
- statusstring
  The connection's status after its last sign-in, test or use.
- isCompanyboolean
  Whether it is one of the organization's shared connections rather than the creator's own, as List Connections answers it.

membersarray of objects

For a bundle, its templates and whether you can install each; empty for a page template.

idstring
The member template id. Pass it in templateIds to install only some members.
namestring
The member template name.
canInstallboolean
Whether you can install this member.