# getFormula

A Formula model is a data model that represents a single numerical statistic, such as an average or a count. Suitable for *headline* or *scorecard* type of visualizations.

## **Usage**

```typescript
const formula = await data.widgetSource.getFormula({
    column: 'column_name',
    operation: 'count',
    // + operationExp for custom operations
    // + base options...
});
```

## **Options**

The `getFormula` model inherits all options from the [base options](/carto-for-developers/reference/carto-widgets-reference/models.md#model-base-options), plus:

```typescript
export interface FormulaRequestOptions extends BaseRequestOptions {
  column: string | '*' | '';
  operation: 'count' | 'avg' | 'min' | 'max' | 'sum' | 'custom' ;
  operationExp?: string;
}
```

* **column:** the name of the column that you will run the statistical operation on. It also accepts the `*` value, that will
  * name of the column
  * `*` for total row count , used with count in operation
  * empty string, in combination with custom + operationExp
* **operation:** the statistical operation that will be performed on the column. Accepted values are:
  * `count`
  * `avg`
  * `min`
  * `max`
  * `sum`
  * `custom`: a custom SQL expression, specified by `operationExp`.
* **operationExp** (optional): when using `operation: 'custom'` you need to specify the exact SQL operation that you want to run on your column. For example: `AVG(column_A) / AVG(column_B) * 100`.

## **Response**

A simple object containing the numerical value of the widget:

```typescript
type FormulaResponse = {value: number}; 
/* example response  
    {value: 1433230}
*/
```

The response can be then mapped to any HTML element, such as a scorecard.

<figure><img src="/files/xX0xUPhfRNUYv8RzvRa7" alt="" width="563"><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.carto.com/carto-for-developers/reference/carto-widgets-reference/models/getformula.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.