Computed Fields API

Programmatic access to Computed Fields uses the Field endpoints on the Qualytics REST API. The requests below cover creation, update, deletion, and read. Requests share the same base URL and Bearer token authentication as the rest of the platform API.

• Base URL. Your deployment's platform host (for example, https://<your-tenant>.qualytics.io/api).
• Auth. Bearer token in the Authorization header. See Access Tokens to create one.

Payload Shape

A Computed Field is a specialization of the generic Field payload. Common fields:

Create

Endpoint: POST /fields

Permission: Editor team permission on the parent datastore, or Author when owner_id is omitted or set to the caller's own user id.

curl -X POST "https://<your-tenant>.qualytics.io/api/fields" \
  -H "Authorization: Bearer $QUALYTICS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "container_id": 34,
    "name": "order_total_numeric",
    "transformation_type": "cast",
    "transformation_config": {
      "source_field": "order_total",
      "target_type": "decimal(10,2)"
    },
    "description": "Numeric version of order_total for aggregation checks."
  }'

curl -X POST "https://<your-tenant>.qualytics.io/api/fields" \
  -H "Authorization: Bearer $QUALYTICS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "container_id": 34,
    "name": "full_name",
    "transformation_type": "custom_expression",
    "transformation_config": {
      "expression": "concat_ws('\'' '\'', first_name, last_name)"
    },
    "description": "First and last name concatenated with a space."
  }'

Returns the created Field object with its assigned id. The Computed Field's first values populate on the next profile of the container.

Update

Endpoint: PUT /fields/{id}

Permission: Editor team permission on the parent datastore, or Author when the caller is the current owner. Reassigning ownership always requires Editor.

curl -X PUT "https://<your-tenant>.qualytics.io/api/fields/128" \
  -H "Authorization: Bearer $QUALYTICS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "full_name",
    "transformation_type": "custom_expression",
    "transformation_config": {
      "expression": "concat_ws('\'' '\'', first_name, middle_name, last_name)"
    },
    "description": "First, middle, and last name concatenated with a space."
  }'

The container_id cannot be changed. Saving an edit re-registers the transformation on the container; the next profile computes values against the new definition.

Delete

Endpoint: DELETE /fields/{id}

Permission: Editor team permission on the parent datastore, or Author when the caller is the current owner.

curl -X DELETE "https://<your-tenant>.qualytics.io/api/fields/128" \
  -H "Authorization: Bearer $QUALYTICS_TOKEN"

Returns 204 No Content on success. The Computed Field definition, the derived output, and any quality checks that reference it are removed. Source fields are not affected.

Read

Endpoint: GET /fields/{id} for a single field, GET /fields?container_id={id} to list every field (including Computed Fields) inside a container.

Permission: Reporter team permission on the parent datastore or above.

Error Responses