Skip to main content

Update event table request

A partial update of an existing event table. Only the fields present in the request are changed; omitted fields keep their current value. table_name and schema cannot be changed and are therefore not part of the request body.

event_time_fieldstringnullable

Name of the column holding the event timestamp.

Example: event_time
user_id_fieldstringnullable

Name of the column holding the user identifier.

Example: user_id
event_name_fieldstringnullable

Optional name of the column holding the event name. Leave unset for single-event tables (the whole table represents one event).

Example: event_name
date_partition_fieldstringnullable

Optional name of the date partition column used to prune scanned partitions.

Example: date
ignored_fieldsstring[]

Optional list of column names to ignore during indexing.

Example: ["internal_debug_column"]
foreign_keys object

Optional mapping of entity name to the foreign-key column that references it. The entity must already exist in the project. The user entity is configured via user_id_field and does not need to be repeated here.

property name*string
disabledbooleannullable

Whether indexing is disabled for the event table.

Example: false
display_name_prefixstringnullable

Optional prefix prepended to event display names from this table.

Example: web_
Update event table request
{
"event_time_field": "event_time",
"user_id_field": "user_id",
"event_name_field": "event_name",
"date_partition_field": "date",
"ignored_fields": [
"internal_debug_column"
],
"foreign_keys": {
"group": "group_id"
},
"disabled": false,
"display_name_prefix": "web_"
}