Braze

Braze is a customer engagement platform used to orchestrate cross-channel messaging campaigns and analyze customer behavior.

ingestr supports Braze as a source.

URI format

braze://?api_key=<rest-api-key>&endpoint=<rest-endpoint>

URI parameters:

• api_key is a Braze REST API key with access to the relevant export endpoints. You can create one in the Braze dashboard under Settings → APIs and Identifiers.
• endpoint is your instance's REST endpoint host, e.g. rest.iad-01.braze.com. Braze is multi-instance, so the host depends on which cluster your account is on — find it in the dashboard or in the API overview. The https:// scheme is optional.

Here's a sample command that copies campaigns from Braze into a DuckDB database:

ingestr ingest \
  --source-uri "braze://?api_key=YOUR_REST_API_KEY&endpoint=rest.iad-01.braze.com" \
  --source-table "campaigns" \
  --dest-uri duckdb:///braze.duckdb \
  --dest-table "public.campaigns"

Tables

Braze source allows ingesting the following resources into separate tables:

Table	PK	Inc Key	Inc Strategy	Details
campaigns	id	last_edited	merge	Marketing campaigns (including archived) with their name, tags, and API flags.
canvases	id	last_edited	merge	Canvas (journey) definitions (including archived) with their name and tags.
segments	id	–	replace	Audience segments with their name and analytics-tracking flag.
events	name	–	replace	Custom events catalog: name, description, status, tags, and analytics-report flag.
products	product_id	–	replace	Product IDs seen in purchase events.
kpi_dau	time	time	merge	Daily active users by date.
kpi_mau	time	time	merge	Monthly active users (rolling 30-day) by date.
kpi_new_users	time	time	merge	New users by date.
kpi_uninstalls	time	time	merge	App uninstalls by date.
event_series	time, event_name	time	merge	Daily occurrence count per custom event. Fetches all events by default; an optional event_series:<name>[,<name>] filter limits it.
segment_series	time, segment_id	time	merge	Daily size per segment. Fetches all segments by default; an optional segment_series:<id>[,<id>] filter limits it.
campaign_series	time, campaign_id	time	merge	Daily per-campaign stats (conversions, revenue, unique recipients; per-channel detail in a messages column). Fetches all campaigns by default; an optional campaign_series:<id>[,<id>] filter limits it.
canvas_series	time, canvas_id	time	merge	Daily per-canvas (journey) stats (entries, conversions, revenue). Fetches all canvases by default; an optional canvas_series:<id>[,<id>] filter limits it.
sessions	time	time	merge	Daily session count.
purchase_quantity	time	time	merge	Daily total number of purchases.
purchase_revenue	time	time	merge	Daily total revenue.
user_data	braze_id, segment_id	–	replace	Segment users with their email/push subscription state and profile fields (a point-in-time snapshot). Exports all segments by default; an optional user_data:<id>[,<id>] filter limits it.

Use these as the --source-table parameter in the ingestr ingest command.

User data

The user_data table exports the users of one or more segments along with their subscription state. By default it exports every segment; pass a comma-separated list of segment ids as a suffix to limit it:

--source-table "user_data"                                  # all segments
--source-table "user_data:<segment_id>"                     # one segment
--source-table "user_data:<segment_id_1>,<segment_id_2>"    # specific segments

You can find segment ids by ingesting the segments table (its id column) or in the Braze dashboard. Each run produces a fresh full snapshot, and every row is tagged with the segment_id it came from (so the same user can appear under multiple segments). Exported fields include the subscription state (email_subscribe, push_subscribe, plus the opt-in/unsubscribe timestamps Braze returns automatically alongside them), identifiers (braze_id, external_id, email, phone), profile fields (name, country, language, time zone, …), and per-product purchases.

WARNING

Exporting all segments runs one async export per segment and can produce a very large, heavily duplicated dataset (the same user appears in every segment they belong to). Prefer naming the specific segments you need.

Per-app KPIs

By default the kpi_* tables aggregate across all apps in the workspace. To break a KPI down by app, append a comma-separated list of app identifiers (found in the Braze dashboard under Settings → APIs and Identifiers) to the table name:

--source-table "kpi_dau:app-one-id,app-two-id"

Each row is then tagged with an app_id column. This is only supported on kpi_* tables.

Incremental loading

campaigns, canvases, and the kpi_* tables load incrementally — use --interval-start and --interval-end to limit the data to a time range. When no interval is provided, the list tables fetch all records and the KPI tables fetch the most recent 100 days. The segments, events, and products tables are always fully refreshed.