Report Subscription - Creates a subscription by report ID
Enter ID of the report for which the subscription is being created.
The requested API version
1.0Optional User Id
Optional User Email
Class for representing a request to create a new subscription for a report.
A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the subscriptionName property.
A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the bookmarkState property.
A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the schedule property.
A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the subject property.
A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the content property.
A public property of type bool that has both a getter and a setter method, which allows for getting and setting the value of the isActive property.
A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the reportPage property.
A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the StartDateTime property.
A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the EndDateTime property.
A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the TimeZone(IST etc) property.
A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the HasAttachment property.
A public property of type boolean that has both a getter and a setter method, which allows for getting and setting the value of the HasVisualAttachment property. The value of this property should be true if the subscription is on the visual of the report.
A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the IsRecipientSpecific property.
A public property of type string that has both a getter and a setter method, which allows for getting and setting the value of the ExportFormat property.
Success: Successfully created a new subscription.
Bad Request: The request could not be processed due to invalid syntax or missing/incorrect parameters.
Unauthorized: Invalid credentials or missing/invalid authentication token.
Forbidden: Access denied to create a subscription for the report due to insufficient permissions or account restrictions.
Not Found: The specified report was not found.
Internal Server Error: An unexpected error occurred or a server timeout.
POST /reports/{reportId}/subscriptions HTTP/1.1
Host:
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 2061
{
"subscriptionName": "Revenue Goal",
"bookmarkState": "Active",
"schedule": "00 1 29/1 * *",
"subscribers": [
{
"email": "user1@example.com",
"id": "GUID-for-user1"
},
{
"email": "user2@example.com",
"id": "GUID-for-user2"
}
],
"subject": "Revenue Goal",
"content": "Revenue Goal with Owner and Account Name",
"isActive": true,
"reportPageName": "4110e2fb8d3520193ebb",
"startDateTime": "2024-09-01T09:00:00",
"endDateTime": "2024-09-30T18:00:00",
"timeZone": "(UTC+05:30) Chennai, Kolkata, Mumbai, New Delhi",
"reportParameter": [
{
"name": "Parameter1",
"value": "Value1"
},
{
"name": "Parameter2",
"value": "Value2"
}
],
"hasAttachment": false,
"hasVisualAttachment": true,
"visualSubscription": {
"datasetName": "Regional Sales Sample",
"tenantId": "0e36ef93-16df-4557-b11b-4e2e5017e763",
"datasetId": "f7f8da44-60c7-441f-80fd-b2bb3e71cf80",
"schema": {
"tables": [
{
"tableName": "Owners",
"columns": [
"Owner"
],
"measures": [
"Rev Goal"
]
}
],
"filters": [
{
"target": {
"tableName": "Owners",
"column": "Owner",
"measure": "Rev Goal",
"aggregationFunction": "Sum"
},
"values": null,
"filterType": 0,
"orderBy": {
"tableName": "Owners",
"column": "Owner",
"measure": "Rev Goal",
"aggregationFunction": "Sum"
},
"operator": "Top",
"logicalOperator": "And",
"conditions": [
{
"operator": "Contains",
"value": "string"
},
{
"operator": "DoesNotContain",
"value": "string"
},
{
"operator": "StartsWith",
"value": "string"
},
{
"operator": "DoesNotStartWith",
"value": "string"
},
{
"operator": "Is",
"value": "string"
},
{
"operator": "IsNot",
"value": "string"
},
{
"operator": "LessThan",
"value": "2"
},
{
"operator": "GreaterThan",
"value": "5"
},
{
"operator": "LessThanOrEqual",
"value": "4"
},
{
"operator": "IsBlank",
"value": null
},
{
"operator": "IsNotBlank",
"value": null
},
{
"operator": "IsEmpty",
"value": null
},
{
"operator": "IsNotEmpty",
"value": null
}
],
"itemCount": 3,
"includeToday": false,
"operatorRelative": 1,
"timeUnitType": 7,
"timeUnitCount": 3
}
]
},
"visibleColumns": [
{
"tableName": "Accounts",
"column": "Account Name",
"measure": null,
"aggregationFunction": null
},
{
"tableName": "Owners",
"column": null,
"measure": "Rev Goal",
"aggregationFunction": null
}
],
"visualName": "6bea0a8104782766d52c"
},
"isRecipientSpecific": true,
"exportFormat": "pdf"
}{
"reportSubscriptionId": "123e4567-e89b-12d3-a456-426614174000",
"subscriptionName": "text",
"reportId": "123e4567-e89b-12d3-a456-426614174000",
"bookmarkState": "text",
"createdByUserId": "123e4567-e89b-12d3-a456-426614174000",
"createdByUserEmail": "text",
"schedule": "text",
"subscribers": [
{
"email": "text",
"id": "text"
}
],
"subject": "text",
"content": "text",
"isActive": true,
"reportPageName": "text",
"startDateTime": "2025-09-01T08:20:58.881Z",
"endDateTime": "2025-09-01T08:20:58.881Z",
"timeZone": "text",
"reportParameter": [
{
"name": "text",
"value": "text"
}
],
"hasAttachment": true,
"hasVisualAttachment": true,
"visualSubscription": {
"datasetName": "text",
"tenantId": "text",
"datasetId": "text",
"schema": {
"tables": [
{
"tableName": "text",
"columns": [
"text"
],
"measures": [
"text"
]
}
],
"filters": [
{
"target": {
"tableName": "text",
"column": "text",
"measure": "text",
"aggregationFunction": "text"
},
"values": [
"text"
],
"filterType": 1,
"orderBy": {
"tableName": "text",
"column": "text",
"measure": "text",
"aggregationFunction": "text"
},
"operator": "text",
"logicalOperator": "text",
"conditions": [
{
"operator": "text",
"value": null
}
],
"itemCount": 1,
"includeToday": true,
"operatorRelative": 1,
"timeUnitType": 1,
"timeUnitCount": 1
}
]
},
"visibleColumns": [
{
"tableName": "text",
"column": "text",
"measure": "text",
"aggregationFunction": "text"
}
],
"visualName": "text",
"tenantName": "text"
},
"daxQuery": "text",
"isRecipientSpecific": true,
"areValidReportParameters": true,
"exportFormat": "text"
}Last updated