Endpoint Send Report Via Email Excel Pdf Or Pdf Gantt Format
Name
send_report_email
Description
Sends the report as a Excel / PDF attachment via email to the designated recipients. [API reference]
Parameters
Parameter | Required | Options | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Name:
Label: ReportId |
YES | |||||||||||||||||||||
Name:
Label: Format |
YES |
|
||||||||||||||||||||
Name:
Label: Subject |
||||||||||||||||||||||
Name:
Label: Message |
||||||||||||||||||||||
Name:
Label: CC Me |
|
|||||||||||||||||||||
Name:
Label: Paper Size (Only for PDF) |
|
|||||||||||||||||||||
Name:
Label: SendToEmails |
||||||||||||||||||||||
Name:
Label: SendToGroups |
Output Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description |
---|---|---|---|---|
Version |
DT_I4
|
int
|
||
ResultCode |
DT_I4
|
int
|
||
Message |
DT_WSTR
|
nvarchar(1000)
|
1000 | |
failedItems |
DT_WSTR
|
nvarchar(4000)
|
4000 |
Input Columns
Label | Data Type (SSIS) | Data Type (SQL) | Length | Description | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
There are no Static columns defined for this endpoint. This endpoint detects columns dynamically at runtime. |
Examples
SSIS
Use Smartsheet Connector in API Source or in API Destination SSIS Data Flow components to read or write data.
API Source
Required Parameters | |
---|---|
ReportId | Fill-in the parameter... |

API Destination
Required Parameters | |
---|---|
ReportId | Fill-in the parameter... |

ODBC application
Use these SQL queries in your ODBC application data source:
Send Report via Email to Users or Groups (as PDF, Excel)
This example shows how to send Report via Email (PDF or Excel format) to list of emails or groups.
SELECT * FROM send_report_email
WITH(
ReportId='2972339541069700'
, Subject='Test report'
, Message='This email contains report attachment'
, CcMe='true'
, PaperSize='LETTER'
, SendToEmails='bob@mycompany.com~sam@mycompany.com'
--OR (Emails or Group only - one allowed)
--, SendToGroups='10022222001~10333330002'
)
SQL Server
Use these SQL queries in SQL Server after you create a data source in Data Gateway:
Send Report via Email to Users or Groups (as PDF, Excel)
This example shows how to send Report via Email (PDF or Excel format) to list of emails or groups.
DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT * FROM send_report_email
WITH(
ReportId=''2972339541069700''
, Subject=''Test report''
, Message=''This email contains report attachment''
, CcMe=''true''
, PaperSize=''LETTER''
, SendToEmails=''bob@mycompany.com~sam@mycompany.com''
--OR (Emails or Group only - one allowed)
--, SendToGroups=''10022222001~10333330002''
)';
EXEC (@MyQuery) AT [LS_TO_SMARTSHEET_IN_GATEWAY];