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.

Get Analytics Notifications

Return a list of analytics notifications using a GET request.

Use a GET request on the Analytics Notification List resource to return a list of analytics notifications.

Example Usage

/services/data/v38.0/analytics/notifications?source=lightningReportSubscribe

Parameter Description
source Required for GET calls. Specifies what type of analytics notification to return. Valid values are:
  • lightningDashboardSubscribe — dashboard subscriptions
  • lightningReportSubscribe — report subscriptions
  • waveNotification — Analytics notifications
ownerId

Optional for GET calls. Allows users with Manage Analytics Notifications permission to get notifications for another user with the specified ownerId.

recordId Optional. Return notifications for a single record. Valid values are:
  • reportId— Unique report ID
  • lensId— Unique Analytics lens ID

Example Response Body

1[ {
2  "active" : true,
3  "createdDate" : "2016-08-08T04:14:12Z",
4  "deactivateOnTrigger" : false,
5  "id" : "0AuR00000004CYpKAM",
6  "lastModifiedDate" : "2016-08-08T04:14:12Z",
7  "name" : "Notification1",
8  "recordId" : "00OR0000000P7EgMAK",
9  "schedule" : {
10    "details" : {
11      "time" : 3
12    },
13    "frequency" : "daily"
14  },
15  "source" : "lightningReportSubscribe",
16  "thresholds" : [ {
17    "actions" : [ {
18      "configuration" : {
19        "recipients" : [ ]
20      },
21      "type" : "sendEmail"
22    } ],
23    "conditions" : null,
24    "type" : "always"
25  } ]
26}, {
27  "active" : true,
28  "createdDate" : "2016-08-10T22:22:17Z",
29  "deactivateOnTrigger" : false,
30  "id" : "0AuR000000000KSKAY",
31  "lastModifiedDate" : "2016-08-11T23:16:01Z",
32  "name" : "Notification2",
33  "recordId" : "00OR0000000PCHYMA4",
34  "schedule" : {
35    "details" : {
36      "daysOfMonth" : [ 1, 2, 4 ],
37      "time" : 22
38    },
39    "frequency" : "monthly",
40    "frequencyType" : "specific"
41  },
42  "source" : "lightningReportSubscribe",
43  "thresholds" : [ {
44    "actions" : [ {
45      "configuration" : {
46        "recipients" : [ ]
47      },
48      "type" : "sendEmail"
49    } ],
50    "conditions" : null,
51    "type" : "always"
52  } ]
53}, {
54  "active" : true,
55  "createdDate" : "2016-08-12T04:01:50Z",
56  "deactivateOnTrigger" : false,
57  "id" : "0AuR000000000KcKAI",
58  "lastModifiedDate" : "2016-08-12T04:16:34Z",
59  "name" : "Notification3",
60  "recordId" : "00OR0000000PBXEMA4",
61  "schedule" : {
62    "details" : {
63      "dayInWeek" : "mon",
64      "time" : 22,
65      "weekInMonth" : "third"
66    },
67    "frequency" : "monthly",
68    "frequencyType" : "relative"
69  },
70  "source" : "lightningReportSubscribe",
71  "thresholds" : [ {
72    "actions" : [ {
73      "configuration" : {
74        "recipients" : [ ]
75      },
76      "type" : "sendEmail"
77    } ],
78    "conditions" : null,
79    "type" : "always"
80  } ]
81} ]