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

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
Host: 
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": "2025-12-13T11:30:57.896Z",
    "endDateTime": "2025-12-13T11:30:57.896Z",
    "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",
        "visualTitle": "text",
        "tenantName": "text"
      }
    ],
    "daxQuery": [
      "text"
    ],
    "isRecipientSpecific": true,
    "areValidReportParameters": true,
    "exportFormat": "text",
    "lastRun": "2025-12-13T11:30:57.896Z"
  }
]