[Index]

Model: data/CustomReporterModel

Data model for Custom Calculation fields in Reporter resources.

Model Details: data/CustomReporterModel

Title Description Details
Name * Unique name for this custom reporter model.
  • Field Name: name
  • Type: String
Reporter resources Data and rules that will be used to add custom calculation fields to Reporter resources.
  • Field Name: models.[n]
  • Type: Array
Reporter resource name *
  • Field Name: models.[n].name
  • Type: String
Custom Calculation Fields Specifies how calculation fields are created.
  • Field Name: calculation_fields.[n]
  • Type: Array
Field Name Name of the calculation field.
  • Field Name: models.[n].calculation_fields.[n].field_name
  • Type: String
Value Type Data type for the calculation field. Default: string
  • Field Name: models.[n].calculation_fields.[n].value_type
  • Type: String
  • Default: string
  • Choices: ["String", "Integer", "Float"]
Operations Available operations for string value types.
  • Field Name: string_operations.[n]
  • Type: Array
Operations Available operations for numeric value types.
  • Field Name: number_operations.[n]
  • Type: Array
Math Calculation Required when a calculation is performed based on the formula specified in the selected string, supporting operations such as sum, avg, min, max, and count.
  • Field Name: models.[n].calculation_fields.[n].is_aggregated
  • Type: Boolean
Ratio Calculation Required if the formula in the selected string involves ratio calculation; applicable when the math calculation option is enabled.
  • Field Name: models.[n].calculation_fields.[n].is_ratio
  • Type: Boolean
Select String SQL statement used to generate the value of this field.
  • Field Name: models.[n].calculation_fields.[n].select_str
  • Type: String