Collect Monthly Workflow Report
Perform Collect Monthly Workflow Report through MyForms.
myforms_monthly_workflow_reportread
Inputs
- Report Anchor Date
report_anchor_dateexpressionOptional literal value or workflow expression.
- Report Month
report_monthtextOptional text value.
- Timezone Name
timezone_nametextrequiredRequired text value.
Default:
"America/Los_Angeles" - Account Key
account_keytextrequiredRequired text value.
Default:
"soundview_mr" - Workflow Template
workflow_templatetextrequiredRequired text value.
Default:
"Insurance Intake" - Workflow Template Id
workflow_template_idnumberrequiredRequired numeric value.
Default:
90290 - Include Deidentified Rows
include_deidentified_rowsbooleanrequiredRequired true-or-false value.
Default:
true - Max Csv Bytes
max_csv_bytesnumberrequiredRequired numeric value.
Default:
26214400 - Max Rows
max_rowsnumberrequiredRequired numeric value.
Default:
10000
Outputs
successSuccessreport_periodReport PeriodtotalTotalstatus_countsStatus Countscompleted_countCompleted Countaverage_turnaround_daysAverage Turnaround Daysmedian_turnaround_daysMedian Turnaround DaysrowsRowserrorError
Output schema completeness: best_effort_declared
Safety
- External effect
- read
- Confirmation recommended
- No
- Retry safe
- Yes
- Dry run supported
- No
Schemas
These schemas are first-pass authoring guidance. Runtime validation remains authoritative.
Input schema
{
"type": "object",
"required": [
"timezone_name",
"account_key",
"workflow_template",
"workflow_template_id",
"include_deidentified_rows",
"max_csv_bytes",
"max_rows"
],
"properties": {
"max_rows": {
"type": "number",
"default": 10000,
"description": "Required numeric value.",
"x-workflow-field-type": "number"
},
"account_key": {
"type": "string",
"default": "soundview_mr",
"description": "Required text value.",
"x-workflow-field-type": "text"
},
"report_month": {
"type": "string",
"description": "Optional text value.",
"x-workflow-field-type": "text"
},
"max_csv_bytes": {
"type": "number",
"default": 26214400,
"description": "Required numeric value.",
"x-workflow-field-type": "number"
},
"timezone_name": {
"type": "string",
"default": "America/Los_Angeles",
"description": "Required text value.",
"x-workflow-field-type": "text"
},
"workflow_template": {
"type": "string",
"default": "Insurance Intake",
"description": "Required text value.",
"x-workflow-field-type": "text"
},
"report_anchor_date": {
"description": "Optional literal value or workflow expression.",
"x-workflow-field-type": "expression"
},
"workflow_template_id": {
"type": "number",
"default": 90290,
"description": "Required numeric value.",
"x-workflow-field-type": "number"
},
"include_deidentified_rows": {
"type": "boolean",
"default": true,
"description": "Required true-or-false value.",
"x-workflow-field-type": "boolean"
}
},
"additionalProperties": false
}Output schema
{
"type": "object",
"properties": {
"rows": {},
"error": {},
"total": {},
"success": {},
"report_period": {},
"status_counts": {},
"completed_count": {},
"median_turnaround_days": {},
"average_turnaround_days": {}
},
"additionalProperties": true
}