GET api/reportserver/v3/data-alerts
Returns a collection of all data alerts.
Request Information
URI Parameters
None.
Body Parameters
None.
Response Information
Resource Description
Collection of DataAlert
| Name | Description | Type | Additional information |
|---|---|---|---|
| Rules |
Specifies the data alert rules. | Collection of DataAlertRule |
Required |
| Id |
Provides the scheduled task identifier. | string |
Required |
| UserId |
Specifies the ID of the user who has created the scheduled task. | string |
None. |
| Name |
Gets or sets the scheduled task name. | string |
Required |
| Enabled |
Gets or sets whether the scheduled task is either enabled or disabled. | boolean |
None. |
| Reports |
Gets or sets the reports which are rendered by the scheduled task. | Collection of ScheduledTaskReport |
Required |
| StartDate |
Obsolete since R2 2020. Use StartDateUtc property instead. Gets or sets the start date of the scheduled task in the author local time zone. | date |
None. |
| StartDateUtc |
Gets or sets the start date of the scheduled task in UTC. | date |
None. |
| BaseUtcOffset |
Gets or sets the UTC offset to the local timezone of the scheduled task author. Used for the mail templates date time type tokens. | decimal number |
None. |
| RecurrenceRule |
Gets or sets recurrence rule for the scheduled task. | RecurrenceRule |
None. |
| LocalUsersMailTemplate |
Gets or sets the mail template for local users. Set to null to use the default template. | TaskMailTemplateModel |
None. |
| ExternalUsersMailTemplate |
Gets or sets the mail template for external users. Set to null to use the default template. | TaskMailTemplateModel |
None. |
| ExternalEmails |
Gets or sets the emails of the external users to whom the report document should be sent. | Collection of string |
None. |
| SubscriberIds |
Provides a list of IDs of the users subscribed to the data alert. | Collection of string |
None. |
Response Formats
application/json
[
{
"Rules": [
{
"Index": 139,
"DataItemName": "Sales Reports",
"Clauses": [
{
"Column": "TotalSales",
"Operator": "is",
"Value": "100"
},
{
"Column": "Region",
"Operator": "is",
"Value": "100"
}
]
},
{
"Index": 145,
"DataItemName": "HR Reports",
"Clauses": [
{
"Column": "Region",
"Operator": "is",
"Value": "100"
},
{
"Column": "TotalSales",
"Operator": "is",
"Value": "100"
}
]
}
],
"Id": "9450e84e5f7",
"UserId": "ae45f6406743419fa6c2ff1a615f4f12",
"Name": "Financial Reports",
"Enabled": true,
"Reports": [
{
"ReportId": "25de97258ab",
"DocumentFormat": "Pdf",
"Parameters": {
"CustomerId": 12345,
"IsActive": true
}
},
{
"ReportId": "72763cddeff",
"DocumentFormat": "Pdf",
"Parameters": {
"CustomerId": 12345,
"IsActive": true
}
}
],
"StartDate": "2026-08-12T14:15:59.9321197+00:00",
"StartDateUtc": "2026-08-12T14:15:59.9321197Z",
"BaseUtcOffset": 165.1,
"RecurrenceRule": null,
"LocalUsersMailTemplate": {
"Subject": "Your scheduled report is ready",
"Body": "The report you subscribed to has been generated and is attached to this email."
},
"ExternalUsersMailTemplate": {
"Subject": "Your scheduled report is ready",
"Body": "The report you subscribed to has been generated and is attached to this email."
},
"ExternalEmails": [
"jane.doe@example.com",
"john.smith@example.com"
],
"SubscriberIds": [
"bae449c94df74c0cbcbc0a73d1c922be",
"cb236bbab6504619a1e050b0425572ca"
]
},
{
"Rules": [
{
"Index": 172,
"DataItemName": "Financial Reports",
"Clauses": [
{
"Column": "CustomerName",
"Operator": "is",
"Value": "100"
},
{
"Column": "OrderDate",
"Operator": "is",
"Value": "100"
}
]
},
{
"Index": 178,
"DataItemName": "Marketing Reports",
"Clauses": [
{
"Column": "OrderDate",
"Operator": "is",
"Value": "100"
},
{
"Column": "CustomerName",
"Operator": "is",
"Value": "100"
}
]
}
],
"Id": "35559ca6468",
"UserId": "92e1333f284a4ea999c199bf346d3ecb",
"Name": "HR Reports",
"Enabled": true,
"Reports": [
{
"ReportId": "0621c8a76ec",
"DocumentFormat": "Pdf",
"Parameters": {
"IsActive": true,
"OrderDate": "2024-01-15"
}
},
{
"ReportId": "9ed1cafa310",
"DocumentFormat": "Pdf",
"Parameters": {
"IsActive": true,
"OrderDate": "2024-01-15"
}
}
],
"StartDate": "2026-08-12T14:15:59.9331552+00:00",
"StartDateUtc": "2026-08-12T14:15:59.9331552Z",
"BaseUtcOffset": 198.1,
"RecurrenceRule": null,
"LocalUsersMailTemplate": {
"Subject": "Your scheduled report is ready",
"Body": "The report you subscribed to has been generated and is attached to this email."
},
"ExternalUsersMailTemplate": {
"Subject": "Your scheduled report is ready",
"Body": "The report you subscribed to has been generated and is attached to this email."
},
"ExternalEmails": [
"john.smith@example.com",
"maria.garcia@example.com"
],
"SubscriberIds": [
"cfbe56d2af144383a835692ee2bd8052",
"f6e83f4afb394e139554bea30c013f1e"
]
}
]