> For the complete documentation index, see [llms.txt](https://docs.coupler.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.coupler.io/sources/category/email/braze.md).

# Braze

Braze is a customer engagement platform that helps marketing teams orchestrate campaigns, canvases, and messaging across email, push, SMS, and in-app channels. It centralizes user behavior data, segmentation, and performance analytics in one place. Connecting Braze to Coupler.io lets you pull that data into your reporting tools without manual exports.

**Why connect Braze to Coupler.io?**

* Sync campaign and canvas performance data automatically to Google Sheets, BigQuery, Looker Studio, or AI tools like ChatGPT and Gemini
* Combine Braze data with other sources (CRM, revenue, ad spend) using Join or Append transformations
* Track KPIs like daily new users, active users, and uninstalls over time in a centralized dashboard
* Keep historical snapshots of segment sizes and engagement metrics without manual downloads

## Prerequisites

* A Braze account with access to the **Developer Console**
* An API key with read permissions for the entities you want to sync (campaigns, canvases, segments, events, cards, KPIs)
* Your Braze **REST endpoint URL** (varies by region, e.g., `https://rest.iad-01.braze.com`)

## Quick start

{% hint style="success" %}
Start with **Campaigns analytics** or **Canvases analytics** — these give you the richest performance data right away and work well as a foundation for dashboards.
{% endhint %}

## How to connect

{% stepper %}
{% step %}
**Create a Braze API key.** In Braze, go to **Settings → Developer Console → API Keys** and create a new key. Grant it read access to the data entities you need (campaigns, canvases, segments, events, cards, KPIs). Copy the key.
{% endstep %}

{% step %}
**Add Braze as a source in Coupler.io.** In your Coupler.io workspace, create a new data flow and select **Braze** as the source. Paste your API key and enter your Braze REST endpoint URL.
{% endstep %}

{% step %}
**Select an entity.** Choose which entity to pull — for example, Campaigns analytics, Canvases analytics, or Segments. Set a start date using the date picker to define how far back to sync historical data.
{% endstep %}

{% step %}
**Choose a destination.** Pick where you want your data to land — Google Sheets, Excel, BigQuery, Looker Studio, or an AI destination like Claude, ChatGPT, or Gemini.
{% endstep %}

{% step %}
**Run the data flow.** Click **Run** to execute a manual sync. Once it completes successfully, your data will appear in the destination and you'll be able to set up a schedule.
{% endstep %}
{% endstepper %}

## Available entities

| Entity                   | What it contains                                 |
| ------------------------ | ------------------------------------------------ |
| Campaigns                | List of all campaigns with metadata              |
| Campaigns analytics      | Performance metrics per campaign                 |
| Campaigns details        | Detailed configuration and settings per campaign |
| Canvases                 | List of all canvases                             |
| Canvases analytics       | Performance metrics per canvas                   |
| Canvases details         | Step-level canvas configuration                  |
| Events                   | Custom event list                                |
| Events analytics         | Event occurrence counts over time                |
| KPI daily new users      | New user registrations per day                   |
| KPI daily active users   | Daily active user counts                         |
| KPI daily app uninstalls | App uninstall counts per day                     |
| Cards                    | Content card list                                |
| Cards analytics          | Impressions, clicks, and dismissals per card     |
| Segments                 | List of all segments                             |
| Segments analytics       | Segment size over time                           |
| Segments details         | Segment filter logic and configuration           |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.coupler.io/sources/category/email/braze.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.