Report Subscription - Creates a subscription by report ID

Creates a new subscription for the specified report identified by its ID.

post

Authorizations

Path parameters

reportIdstring · uuidRequired

Enter ID of the report for which the subscription is being created.

Query parameters

versionstringOptional

The requested API version

Default: 1.0

Header parameters

embedfast-user-idstringOptional

Optional User Id

embedfast-user-emailstringOptional

Optional User Email

Body

application/jsontext/jsonapplication/*+json

Class for representing a request to create a new subscription for a report.

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.

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.

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.

subscribersstring[] | nullableOptional

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.

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.

reportParameterobject[] | 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 ReportParameter 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.

Responses

text/plainapplication/jsontext/json

objectOptional

Class for storing details about report subscription.

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

text/plainapplication/jsontext/json

post

HTTPcURLJavaScriptPython

POST /reports/{reportId}/subscriptions HTTP/1.1
Host: 
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 562

{
  "subscriptionName": "Monthly Report Subscription",
  "bookmarkState": "Active",
  "schedule": "0 0 1 * *",
  "subscribers": [
    "[e-mail]",
    "[e-mail]"
  ],
  "subject": "Monthly Report Summary",
  "content": "This is the content of the monthly report subscription.",
  "isActive": true,
  "reportPageName": "Sales Dashboard",
  "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": true
}

application/jsontext/jsonapplication/*+json

{
  "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": true,
  "reportPageName": "text",
  "startDateTime": "2025-04-19T16:38:07.686Z",
  "endDateTime": "2025-04-19T16:38:07.686Z",
  "timeZone": "text",
  "reportParameter": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "hasAttachment": true,
  "reportParameters": "text"
}