Schedule Emailing of Worksheet

Content-Type (Required)

String

Specifies the media type of the request body.

application/x-www-form-urlencoded

sessionid

String

The session ID is the token received from the login API.

Note: Session ID is required for token-based authentication.

–

name-or-id (Required)

String

Name or ID of the Worksheet for which emailing needs to be scheduled.

Note: If the Worksheet name is provided, then workbookName must also be provided.

–

by

String

Specifies whether the name-or-id parameter should be interpreted as a Worksheet name or Worksheet ID.

If by=name, provide the Worksheet name in the name-or-id parameter.

If by=id, provide the Worksheet ID in the name-or-id parameter.

The default value is name.

–

folderName

String

Name of the folder containing the Workbook. If the Workbook is present in the root directory, specify [Root].

Note: If folderName is not provided, the Workbook is treated as a root-level entity by default.

–

workbookName

String

Name of the Workbook containing the Worksheet.

–

subject

String

Subject of the email.

–

message

String

Message body of the email.

–

recipientUserList

String

Comma-separated list of users to whom the email needs to be scheduled.

Note: At least one of recipientUserList, recipientGroupList, or recipientEmailAddress must be provided.

–

recipientGroupList

String

Comma-separated list of recipient groups.

–

recipientEmailAddress

String

Comma-separated list of recipient email addresses.

–

jobType

String

Specifies when the email job should run.

NOW – Runs immediately.

ONCE – Runs at the specified date and time.

Default: NOW

oneDateTime

String

Date and time when the job should run if jobType is ONCE.

Note: Required when jobType is ONCE.

–

fileFormat

String

Format in which the Worksheet data is exported and attached to the email.

none, csv, pdf, ppt, image

Default: none

attachmentParam

String

Optional parameters for customizing exported data.

• EXPORT_VIEW_TYPE: Specifies the type of view to export.
  Default: TABULAR.

• LINE_SEPARATOR: Specifies the line separator used in CSV exports.
  Default: \r\n.

• FIELD_SEPARATOR: Specifies the field delimiter used in CSV exports.
  Default: , (comma).

• ENCLOSURE: Specifies the character used to enclose each field in CSV exports.
  Default: blank.

• INCLUDE_HEADER: Indicates whether column headers should be included in CSV exports.
  Default: true.

• KEEP_MEASURE_FORMATTING: Indicates whether measure formatting should be preserved in CSV exports.
  Default: false.

• THEME_ID: Specifies the theme to apply to exported PDFs to match the UI appearance. Applicable for Worksheet tabular exports.

• INCLUDE_TABLE_VIEW: Includes tabular data in PDF exports when the visualization is a chart.
  Default: false.

• INCLUDE_COMPLETE_DATA: Includes complete chart data in PDF exports.
  Default: false.

• INCLUDE_DB_TITLE: Includes the dashboard title in exported PDFs or images. Applicable for dashboards only.
  Default: false.

• INCLUDE_CARD_INFO: Includes dashboard card information in exported PDFs, PowerPoint presentations, or images. Applicable for dashboards only.
  Default: false.

• IMAGE_FORMAT: Specifies the image format for dashboard exports.
  Default: PNG.

• INCLUDE_CSV_METADATA: Includes metadata when exporting Worksheet data or dashboard card data in CSV format. When enabled, the response is returned as a ZIP file.
  Default: false.

• IS_MULTI_GROUP: Includes all groups from a dashboard group widget in PDF or image exports. Applicable for dashboards only.
  Default: false.

• IS_MULTI_FILTER_COMBINATION: Generates a separate output for each filter combination provided. Applicable for PDF, PowerPoint, or image exports.
  Default: false.

• MULTI_FILTER_COMBINATION_FORMAT: Specifies the format used for filter combinations. Applicable for PDF, PowerPoint, or image exports.
  Default: XML.

• INCLUDE_COVER_SLIDE: Includes an introductory slide containing dashboard information in PowerPoint exports.
  Default: false.

• INCLUDE_FULL_VIEW: Includes a slide containing a full-dashboard snapshot in PowerPoint exports.
  Default: false.

• EXPORT_IN_MAX_VIEW: Exports dashboard cards in maximized view before capturing snapshots for PowerPoint exports.
  Default: false.

• PPT_TEMPLATE_NAME: Specifies the PowerPoint template to use for dashboard exports. The selected template determines the layout, design, and formatting of the generated presentation.

• INCLUDE_SUMMARY_CARDS: Includes dashboard summary cards on separate pages in exported PDFs. Applicable for dashboards only.
  Default: false.