Create a fact context item

curl --request POST \ --url https://api.staging.getmodus.com/api/v1/context/facts \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "name": "order_amount_usd", "description": "Total order amount in USD after FX conversion.", "expr": "${orders.amount_usd}", "aggregation": "SUM", "dataType": "NUMBER" } '

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

name

string

required

Fact name.

Example:

"order_amount_usd"

description

string

required

Human description.

Example:

"Total order amount in USD after FX conversion."

expr

string

required

Semantic-layer expression.

Example:

"${orders.amount_usd}"

aggregation

string

default:SUM

Aggregation strategy. Defaults to SUM.

Example:

"SUM"

dataType

string

default:NUMBER

Data type tag. Defaults to NUMBER.

Example:

"NUMBER"

synonyms

string[]

Optional synonyms used for fuzzy matching.

accessModifier

string

default:public

Access modifier (public / private). Defaults to public.

Example:

"public"

Response

contextItemId

string

required

UUID of the newly-created context item. Use it on subsequent GET / PATCH / DELETE calls.

Example:

"7a3f9d2c-1111-4000-a000-000000000abc"

kind

enum<string>

required

Kind of context item created.

Available options:

note,

saved_query,

link,

dimension,

fact,

metric,

filter

Example:

"note"

s3Key

string | null

Tenant S3 key for the raw content blob (notes, saved queries, links). Null for kinds without S3 backing.

Example:

"context_notes/7a3f9d2c.../Q3_churn_analysis.md"

title

string | null

Resolved title for the created item. Null for kinds without a title field.

Example:

"Q3 churn analysis"