Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Template Configuration

The configuration for an Analytics Template.

Properties

Property Name	Type	Description	Filter Group and Version	Available Version
`id`	String	The ID or fully qualified name of the template.	Small, 55.0	55.0
`layout`	UILayoutDefinition	The user interface layout definition for the template.	Small, 56.0	56.0
`name`	String	The local API name of the template.	Small, 55.0	55.0
`namespace`	String	The namespace of the template provider.	Small, 55.0	55.0
`ui`	UIDefinition	The user interface definition for the template.	Small, 36.0	36.0
`variables`	Map <String, VariableDefinition>	A map of the defined variables for the template.	Small, 36.0	36.0

The following JSON is an example response body.

1{
2  "ui": {
3    "pages": [
4      {
5        "title": "Application Preferences",
6        "variables": [
7          "lensDashboardName",
8          "dashboardHeader"
9        ]
10      },
11      {
12        "title": "Other preferences",
13        "variables": [
14          "emailNotifications",
15          "emailAddress"
16        ]
17      }
18    ]
19  },
20  "variables": {
21    "numberPicked": {
22      "defaultValue": 3,
23      "description": "A number between 1 and 10.",
24      "excludeSelected": false,
25      "excludes": [],
26      "label": "Please pick a number between 1 and 10?",
27      "required": true,
28      "variableType": {
29        "enums": [],
30        "max": 10,
31        "min": 1,
32        "type": "NumberType"
33      }
34    },
35    "lensDashboardName": {
36      "defaultValue": "My View of Election Data",
37      "description": "The name of the sample lens.",
38      "excludeSelected": false,
39      "excludes": [],
40      "label": "What would you like to name your lens and dashboard?",
41      "required": true,
42      "variableType": {
43      "  type": "StringType"
44      }
45    },
46    "dashboardHeader": {
47      "defaultValue": "Wow! Interactive Dashboards are Nice!",
48      "description": "The dashboard header.",
49      "excludeSelected": false,
50      "excludes": [],
51      "label": "What would you like the dashboard header to say?",
52      "required": true,
53      "variableType": {
54        "enums": [],
55        "type": "StringType"
56      }
57    },
58    "emailNotifications": {
59      "defaultValue": "Yes",
60      "description": "Email notifications",
61      "excludeSelected": false,
62      "excludes": [],
63      "label": "Would you like to receive emails for promotions?",
64      "required": false,
65      "variableType": {
66        "enums": ["Yes","No"],
67        "type": "StringType"
68      }
69    },
70    "emailAddress": {
71      "defaultValue": null,
72      "description": "Your email address.",
73      "excludeSelected": false,
74      "excludes": [],
75      "label": "Please enter your email address?",
76      "required": false,
77      "variableType": {
78        "enums": [],
79        "type": "StringType"
80        }
81      }
82    }
83}

CRM Analytics REST API Developer Guide

Template Configuration

See Also