Skip to main content
POST
Create Runtime App

Body

application/json
key
string
required
Required string length: 1 - 64
Pattern: ^[a-z][a-z0-9_]*$
name
string
required
Required string length: 1 - 128
description
string | null
Maximum string length: 2048
accent_color
string | null
Maximum string length: 16
template_key
string | null
Maximum string length: 64
privacy_mode
enum<string>
default:redacted_only
Available options:
redacted_only,
both_role_gated,
hashed_pii,
user_choice
batch_interval_seconds
integer
default:300
Required range: 30 <= x <= 3600
dataset_field_picks
string[] | null
free_form_tags
Free Form Tags · object | null
max_events_per_hour
integer | null
Required range: x >= 1
max_events_per_day
integer | null
Required range: x >= 1
require_signed_token
boolean
default:false
config
AppConfig · object | null

Response

Successful Response

id
string
required
workspace_id
string
required
key
string
required
name
string
required
status
enum<string>
required
Available options:
active,
disabled,
archived
privacy_mode
enum<string>
required
Available options:
redacted_only,
both_role_gated,
hashed_pii,
user_choice
batch_interval_seconds
integer
required
require_signed_token
boolean
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
description
string | null
accent_color
string | null
template_key
string | null
template_version
integer | null
dataset_field_picks
string[]
free_form_tags
Free Form Tags · object
max_events_per_hour
integer | null
max_events_per_day
integer | null
current_config_version
AppConfigVersionRead · object | null
custom_param_count
integer
default:0