Overview
Download a report from Mode as a CSV, PDF, or JSON file. Typically used for pulling live data and sending the output to a messaging service, like Email or Slack.
Variables
|
Name |
Reference |
Type |
Required |
Default |
Options |
Description |
|---|---|---|---|---|---|---|
|
Token ID |
MODE_TOKEN_ID |
Password |
✅ |
None |
- |
The ID of the Token used to authenticate with Mode. |
|
Token Password |
MODE_TOKEN_PASSWORD |
Password |
✅ |
None |
- |
The Token Password associated to the Token ID used to authenticate with Mode. |
|
Workspace Name |
MODE_WORKSPACE_NAME |
Alphanumeric |
✅ |
None |
- |
Typically found in the URL structure as https://app.mode.com/ACCOUNT_NAME/ |
|
Report ID |
MODE_REPORT_ID |
Alphanumeric |
✅ |
None |
- |
Numeric ID of the report you want to download, typically found at the end of the URL. |
|
Run ID |
MODE_RUN_ID |
Alphanumeric |
➖ |
None |
- |
The ID of the Run you want to download. If left blank, the most recent successful run for the report will be used. |
|
Download As |
MODE_FILE_TYPE |
Select |
✅ |
csv |
.csv: csv
|
File format to download the specified report as. |
|
File Name |
MODE_DESTINATION_FILE_NAME |
Alphanumeric |
✅ |
None |
- |
File name that will be created for the card being downloaded. Include the extension. |
|
Folder Name |
MODE_DESTINATION_FOLDER_NAME |
Alphanumeric |
➖ |
None |
- |
Folder where the file will be created. Leave blank to store in the current working directory |
YAML
Below is the YAML template
source:
template: Mode - Download Report as File to Workflows
inputs:
MODE_TOKEN_ID:
MODE_TOKEN_PASSWORD:
MODE_WORKSPACE_NAME:
MODE_REPORT_ID:
MODE_RUN_ID:
MODE_FILE_TYPE: csv
MODE_DESTINATION_FILE_NAME:
MODE_DESTINATION_FOLDER_NAME:
type: TEMPLATE
guardrails:
retry_count: 1
retry_wait: 0h0m0s
runtime_cutoff: 1h0m0s
exclude_exit_code_ranges:
- 200
- 203
- 204