Report Subscription - Retrieves subscriptions by report by ID

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

GET/reports/{reportId}/subscriptions

Authorization

Bearer

Path parameters

reportId*string (uuid)

Enter ID of the report for which subscriptions are requested.

Query parameters

Header parameters

Response

200400401404500

Success: Successfully retrieved subscriptions for the specified report.

Body

text/plainapplication/jsontext/json

reportSubscriptionIdstring (uuid)

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.

subscriptionNamenullable string

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 (uuid)

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.

bookmarkStatenullable string

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 (uuid)

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.

createdByUserEmailnullable string

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.

schedulenullable string

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.

subscribersnullable array of string

A public property of type list of string that has both a getter and a setter method, which allows for getting and setting the value of the subscribers property.

subjectnullable string

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.

contentnullable string

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.

isActiveboolean

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.

reportPageNamenullable string

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-time)

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-time)

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.

timeZonenullable string

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.

reportParameternullable array of object

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

hasAttachmentboolean

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.

reportParametersnullable string

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

Request

JavaScriptCurlPythonHTTP

const response = await fetch('/reports/{reportId}/subscriptions', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

200400401404500

[
  {
    "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": [
      "text"
    ],
    "subject": "text",
    "content": "text",
    "isActive": false,
    "reportPageName": "text",
    "startDateTime": "2025-01-30T13:01:13.749Z",
    "endDateTime": "2025-01-30T13:01:13.749Z",
    "timeZone": "text",
    "reportParameter": [
      {
        "name": "text",
        "value": "text"
      }
    ],
    "hasAttachment": false,
    "reportParameters": "text"
  }
]