Formula

Learn how to read the formula column on monday boards using the platform API

The formula column calculates anything from simple mathematical equations to complex formulas.

Via the API, the formula column is read-only. You can query its calculated value, but you cannot filter, update, or clear it.

Column Type

Implementation Type

Supported Operations

formula

FormulaValue

  • Read: Yes
  • Filter: No
  • Update: No
  • Clear: No

Queries

Formula columns can be queried through the column_values field on items queries using an inline fragment on FormulaValue.

query {
  items(ids: [1234567890, 9876543210]) {
    column_values {
      ... on FormulaValue {
        id
        value
        display_value
      }
    }
  }
}
import { ApiClient } from "@mondaydotcomorg/api";
const mondayApiClient = new ApiClient({ token: myToken });

const query = `
  query($itemIds: [ID!], $columnType: [ColumnType!]) {
    items(ids: $itemIds) {
      id
      column_values(types: $columnType) {
        column { title id }
        ... on FormulaValue {
          display_value
        }
      }
    }
  }
`;

const variables = {
  itemIds: [9571351485, 9572374902],
  columnType: "formula"
};

const response = await mondayApiClient.request(query, variables);

Fields

You can use the following fields to specify what information your FormulaValue implementation will return.

Field

Description

column Column!

The column the value belongs to.

id ID!

The column's unique identifier.

text String

Always returns null for this column. Use display_value instead.

type ColumnType!

The column's type.

value JSON

Always returns null for this column. Use display_value instead.

display_value String

The formula column's content. Subject to the following limits:

  • Does not support formulas with mirror columns
  • Up to 10,000 formula values per minute
  • Maximum of 5 formula columns in one request