Skip to main content
PUT
cURL

Authorizations

Authorization
string
header
required

For your own scripts and server-to-server integrations. Create a key in the app under Settings > Access > API keys and copy it then, because it is shown once. Send it as Authorization: Bearer <key>. The key acts as the member who made it, in the organization it was made in. A call needs the member's permission and one of the key's scopes, such as inventory:read or sales:write. A key with * has every scope.

Path Parameters

dataset
string
required
field
string | null
required

Body

application/json

A calculated field to add to a dataset, or its new version.

key
string
required

How reports name it, in lower case with dashes, such as margin-percent. Not one of the dataset's own fields' keys.

Pattern: ^[a-z][a-z0-9-]{0,63}$
label
string
required

Its name above a report's column, such as Margin %.

Maximum string length: 120
formula
string
required

Such as SAFE_DIVIDE(SUM([Margin]), SUM([Revenue])) * 100, with fields in brackets by key or name.

Maximum string length: 2000

Response

CalculatedFieldResource

data
CalculatedFieldResource · object
required