Skip to main content Link Search Menu Expand Document (external link)

average() : Calculate Average of Values

On this page

Summary

Calculate the arithmetic mean (average) of numeric values in a collection.

Signature 

average(collection)

Parameters

Parameter Type Required Description
collection Array of Numbers Yes The collection of numeric values

Returns

Type: Number (Decimal)

The arithmetic mean of all values. Returns null for empty collections.

Examples

Simple Average 

<p>Average score: </p>

Data:

doc.Params["model"] = new {
    scores = new[] { 85, 92, 78, 95, 88 }
};

Output:

<p>Average score: 87.6</p>

Grade Report 

<h3>Student Performance</h3>

  <p>:
    Total ,
    Average 
  </p>

Data:

doc.Params["model"] = new {
    students = new[] {
        new { name = "Alice", scores = new[] { 85, 90, 92 } },
        new { name = "Bob", scores = new[] { 78, 82, 88 } },
        new { name = "Charlie", scores = new[] { 95, 93, 97 } }
    }
};

Output:

<h3>Student Performance</h3>
<p>Alice: Total 267, Average 89.0</p>
<p>Bob: Total 248, Average 82.7</p>
<p>Charlie: Total 285, Average 95.0</p>

Performance Metrics 

<h3>API Performance Summary</h3>
<p>Average response time: ms</p>
<p>Fastest: ms</p>
<p>Slowest: ms</p>

Data:

doc.Params["model"] = new {
    requests = new[] {
        new { endpoint = "/api/users", responseTime = 250 },
        new { endpoint = "/api/orders", responseTime = 180 },
        new { endpoint = "/api/products", responseTime = 320 },
        new { endpoint = "/api/inventory", responseTime = 290 }
    }
};

Output:

<h3>API Performance Summary</h3>
<p>Average response time: 260ms</p>
<p>Fastest: 180ms</p>
<p>Slowest: 320ms</p>

Price Analysis 

<h3>Product Pricing</h3>
<p>Average price: $</p>
<p>Total inventory value: $</p>
<p>Price range: $ - $</p>

Data:

doc.Params["model"] = new {
    products = new[] {
        new { name = "Widget A", price = 15.50 },
        new { name = "Widget B", price = 22.00 },
        new { name = "Widget C", price = 8.75 },
        new { name = "Widget D", price = 31.25 }
    }
};

Output:

<h3>Product Pricing</h3>
<p>Average price: $19.38</p>
<p>Total inventory value: $77.5</p>
<p>Price range: $8.75 - $31.25</p>

Notes

  • Returns null for empty or null collections
  • All items must be numeric
  • Result is a decimal (use round() for formatting)
  • Formula: sum of all values divided by count
  • For averaging a property across objects, use with collect(): average(collect(items, 'price'))
  • For averaging property values, use averageOf() as shorthand
  • Useful for:
    • Grade calculations
    • Performance metrics
    • Price analysis
    • Quality scores
    • Statistical summaries
  • Same as mean() function (mathematical synonym)
  • Consider using median() for data with outliers

See Also