Braze

Version 0.0.1

📘

Check out the Braze API docs for more information

Set up


Kleene supports ingesting both event data from Braze via Currents and data from their API. This connector only retrieves data from the API. To ingest event data please follow these instructions on Setting up Currents and choose your preferred filestore Amazon S3, Google Cloud Storage or Microsoft Azure Blob Storage. You can then ingest the data from any of these three locations using the respective connectors and specifying the location/bucket name. The data will be stored in AVRO files. Each different even type should have it's own extract. To ensure you retrieve all the data choose the option to 'Load all files inside a folder' and specify the folder name as below:

currents/dataexport.prod-02.<**filestore-code**>.integration.<**integration-id**>/event_type=<**chosen.event.type**>/

For Example:

currents/dataexport.prod-02.S3.integration.64b018a3545d435061c9b102/event_type=users.behaviors.app.FirstSession/

Accessing the Braze API

In order to get access to our Braze API, you have to create an API token.

Within Braze go to Settings > API Keys.
If you are using the older navigation, you can create an API key from Developer Console > API Settings.
click Create New API Key.

Then please do the following:

  • Give your new key a name for identification - Kleene
  • Ensure you have added the following permissions:
    users.track
    users.identify
    users.export.ids
    users.export.segment
    email.unsubscribe
    email.hard_bounces
    messages.schedule_broadcasts
    campaigns.details
    campaigns.data_series
    campaigns.list
    canvas.list
    segments.details
    segments.data_series
    segments.list
    purchases.product_list
    purchases.revenue_series
    purchases.quantity_series
    events.list
    events.data_series
    sessions.data_series
    content_blocks.info
    content_blocks.list
    ubscription.groups.get
    subscription.status.get
  • Specify allow listed IP addresses:
    54.78.204.135
    34.242.207.164:51820

Set up Source in Kleene app

Now you should have everything you need to set up the source in the Kleene app.

  • Source name
    Choose any name you wish
  • Braze Access Token
    This is the API key you generated.

Features


FeatureSupportNotes
Incremental✅Supported on the following reports: Campaign Statistics Daily, Email Hard Bounces and Email Unsubscribes
Custom backfill✅Available on Campaign Statistics Daily but limited to 100 days. Available on Email Hard Bounces and Email Unsubscribes up to a maximum of two years.
API reliability🟢Reliable

Reports detail


⬇️ Report🔑 Incremental key🔑 Primary key📄 Link to API endpoint
CampaignsN/ACAMPAIGN_IDExport campaign details
Campaign Statistics DailyTIMECAMPAIGN_ID, TIMEExport campaign analytics
Email Hard BouncesHARD_BOUNCED_ATN/AQuery hard bounced emails
Email UnsubscribesUNSUBSCRIBED_ATN/AQuery list of unsubscribed email addresses
SegmentsN/AIDExport segment details
Segment MembersN/ASEGMENT_ID, BRAZE_IDExport user profile by segment