Skip to documentation
Brightree integration

Run Report

Perform Run Report through Brightree.

View as Markdown
brightree_run_report
readbrightree

Use in a workflow

Copy the discovered node config and fill its params from the input contract. Validate the complete graph before publishing. Integration results use {{node_id.default.field}}. Check business success before dependent writes; completion alone does not prove success.

{
  "_group": "Brightree",
  "params": {
    "max_rows": 1000,
    "allow_default_date_ranges": false
  },
  "handler": "brightree_run_report"
}

Action contracts and connections · Run recovery

Inputs

  • report
    textrequired
    Report

    Required text value.

  • filters
    json
    Filters

    Optional JSON value.

  • allow_default_date_ranges
    boolean
    Allow Default Date Ranges

    Optional true-or-false value.

    Default: false

  • max_rows
    number
    Max Rows

    Optional numeric value.

    Default: 1000

Outputs

  • successSuccess
  • rowsRows
  • row_countRow Count
  • columnsColumns
  • truncatedTruncated
  • errorError
  • total_row_countTotal Row Count
  • report_idReport Id
  • report_titleReport Title
  • date_rangesDate Ranges

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": [
    "report"
  ],
  "properties": {
    "report": {
      "type": "string",
      "description": "Required text value.",
      "x-workflow-field-type": "text"
    },
    "filters": {
      "description": "Optional JSON value.",
      "x-workflow-field-type": "json"
    },
    "max_rows": {
      "type": "number",
      "default": 1000,
      "description": "Optional numeric value.",
      "x-workflow-field-type": "number"
    },
    "allow_default_date_ranges": {
      "type": "boolean",
      "default": false,
      "description": "Optional true-or-false value.",
      "x-workflow-field-type": "boolean"
    }
  },
  "additionalProperties": false
}
Output schema
{
  "type": "object",
  "properties": {
    "rows": {},
    "error": {},
    "columns": {},
    "success": {},
    "report_id": {},
    "row_count": {},
    "truncated": {},
    "date_ranges": {},
    "report_title": {},
    "total_row_count": {}
  },
  "additionalProperties": true
}
View all Brightree actions