Report Subscription - Retrieves subscriptions by report by ID

Retrieves subscriptions associated with a specific report identified by its ID.

get

Authorizations

Bearer

HTTPRequired

Please enter a valid token

Path parameters

reportIdstring · uuidRequired

Enter ID of the report for which subscriptions are requested.

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

Responses

200

Success: Successfully retrieved subscriptions for the specified report.

text/plainapplication/jsontext/json

Class for storing details about report subscription.

reportSubscriptionIdstring · uuidOptional

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the reportSubscriptionId property.

subscriptionNamestring · nullableOptional

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.

reportIdstring · uuidOptional

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the reportId property.

bookmarkStatestring · nullableOptional

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.

createdByUserIdstring · uuidOptional

A public property of type Guid (a unique identifier) that has both a getter and a setter method, which allows for getting and setting the value of the createdByUserId property.

createdByUserEmailstring · nullableOptional

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 CreatedByUserEmail property.

schedulestring · nullableOptional

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.

subjectstring · nullableOptional

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.

contentstring · nullableOptional

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.

isActivebooleanOptional

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.

reportPageNamestring · nullableOptional

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.

startDateTimestring · date-timeOptional

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.

endDateTimestring · date-timeOptional

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.

timeZonestring · nullableOptional

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.

hasAttachmentbooleanOptional

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.

hasVisualAttachmentbooleanOptional

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.

daxQuerystring[] · nullableOptional

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 DAXQuery property.

isRecipientSpecificbooleanOptional

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.

areValidReportParametersboolean · nullableOptional

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 IsValidSubscription property.

exportFormatstring · nullableOptional

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.

lastRunstring · date-time · nullableOptional

A public property of type DateTime that has both a getter and a setter method, which allows for getting and setting the value of the LastRun property. This property represents the date and time when the subscription was last executed or triggered.

400

Bad Request: The request could not be processed due to invalid syntax or missing/incorrect parameters.

text/plainapplication/jsontext/json

401

Unauthorized: Invalid credentials or missing/invalid authentication token.

text/plainapplication/jsontext/json

404

Not Found: The specified report could not be found.

text/plainapplication/jsontext/json

500

Internal Server Error: An unexpected error occurred or a server timeout.

text/plainapplication/jsontext/json

get

/reports/{reportId}/subscriptions

HTTPcURLJavaScriptPython

GET /reports/{reportId}/subscriptions HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "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": "2026-03-08T00:04:07.320Z",
    "endDateTime": "2026-03-08T00:04:07.320Z",
    "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",
                "displayName": "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",
            "displayName": "text"
          }
        ],
        "visualName": "text",
        "visualTitle": "text",
        "tenantName": "text"
      }
    ],
    "daxQuery": [
      "text"
    ],
    "isRecipientSpecific": true,
    "areValidReportParameters": true,
    "exportFormat": "text",
    "lastRun": "2026-03-08T00:04:07.320Z"
  }
]