List scheduled exports for a user

GET

/v2/members/:memberId/schedules

GET

/v2/members/:memberId/schedules

$ curl https://api.sigmacomputing.com/v2/members/memberId/schedules \
>      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "entries": [
3     {
4       "configV2": {
5         "alertConfig": {
6           "volume": 1.1,
7           "window": "alltime"
8         },
9         "attachmentSettings": {
10           "mergePdfAttachments": true,
11           "zipAttachments": true
12         },
13         "conditionOptions": {
14           "type": "always"
15         },
16         "dashboardSettings": {
17           "filters": [
18             {
19               "filterStr": "string",
20               "id": "string"
21             }
22           ],
23           "variableValues": {}
24         },
25         "dynamicExportSettings": {
26           "variables": {}
27         },
28         "dynamicRecipientSettings": {
29           "recipientColumnId": "string",
30           "sourceNodeId": "string"
31         },
32         "embedOpts": {
33           "embedId": "string",
34           "evalConnectionId": "string"
35         },
36         "formatting": {
37           "pivotHeaderStyle": "merged"
38         },
39         "includeLink": true,
40         "messageBody": "string",
41         "notificationAttachments": [
42           {
43             "chartId": "string",
44             "formatOptions": {
45               "type": "CSV"
46             },
47             "workbookExportSource": {
48               "elementId": "string",
49               "type": "element"
50             }
51           }
52         ],
53         "notificationName": "string",
54         "rowLimit": 1.1,
55         "runAsRecipient": true,
56         "title": "string",
57         "workbookVariant": {
58           "bookmarkId": "string",
59           "exploreKey": "string",
60           "tagId": "string"
61         }
62       },
63       "createdAt": "2024-01-15T09:30:00Z",
64       "createdBy": "string",
65       "disabledAt": "2024-01-15T09:30:00Z",
66       "disabledBy": "string",
67       "isSuspended": true,
68       "lastUpdatedByUser": "string",
69       "ownerId": "string",
70       "schedule": {
71         "cronSpec": "string",
72         "timezone": "string"
73       },
74       "scheduledNotificationId": "string",
75       "updatedAt": "2024-01-15T09:30:00Z",
76       "updatedBy": "string",
77       "workbookId": "string"
78     }
79   ],
80   "nextPage": "string",
81   "total": 1.1,
82   "hasMore": true
83 }

Retrieve all scheduled exports owned by a specific user across all workbooks and reports that they have access to.

Usage notes

Retrieve the memberId by calling the /v2/members endpoint.
To perform this operation for another user, you must use API credentials owned by a user assigned the Admin account type.
Non-admin users can only retrieve their own schedules.
To retrieve scheduled exports for a specific workbook, call the /v2/workbooks/{workbookId}/schedules endpoint.

Usage scenarios

User dashboard: Display all scheduled exports owned by a user in a centralized dashboard.
Scheduled export management: Allow users to view and manage all their scheduled exports across different workbooks and reports.
Audit and compliance: Review all scheduled exports created by a specific user for governance purposes.
Cross-user management: Admins can view and manage schedules on behalf of other users.

Retrieve all scheduled exports owned by a specific user across all workbooks and reports that they have access to. ### Usage notes - Retrieve the **memberId** by calling the [/v2/members](https://help.sigmacomputing.com/reference/list-members) endpoint. - To perform this operation for another user, you must use API credentials owned by a user assigned the Admin account type. - Non-admin users can only retrieve their own schedules. - To retrieve scheduled exports for a specific workbook, call the [/v2/workbooks/{workbookId}/schedules](https://help.sigmacomputing.com/reference/list-workbook-schedules) endpoint. ### Usage scenarios - **User dashboard:** Display all scheduled exports owned by a user in a centralized dashboard. - **Scheduled export management:** Allow users to view and manage all their scheduled exports across different workbooks and reports. - **Audit and compliance:** Review all scheduled exports created by a specific user for governance purposes. - **Cross-user management:** Admins can view and manage schedules on behalf of other users.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Path parameters

memberIdstringRequired

Query parameters

pagestringOptional

limitdoubleOptional

Response

The response body.

entrieslist of objects

Array of results returned by the endpoint

nextPagestring or null

Returns a string that can be used as the page parameter in the next request to fetch the next page of results. The last page of results returns null.

totaldouble

Total number of results. Useful to determine if there is a need to paginate.

hasMoreboolean

[Deprecated] Indicates whether more results are available.