Skip to content

Commit

Permalink
Merge pull request #4997 from braze-inc/develop
Browse files Browse the repository at this point in the history
  • Loading branch information
bre-fitzgerald authored Mar 9, 2023
2 parents 4f06e9a + c5c6103 commit 7770ee6
Show file tree
Hide file tree
Showing 16 changed files with 262 additions and 39 deletions.
1 change: 1 addition & 0 deletions _docs/_api/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ API key permissions are permissions you can assign a user or group to limit thei
| `messages.schedule.update` | Update a scheduled message. |
| `messages.schedule.delete` | Delete a scheduled message. |
| `messages.schedule_broadcasts` | Query all scheduled broadcast messages. |
| `messages.live_activity.update` | Update an iOS Live Activity. |
{: .reset-td-br-1 .reset-td-br-2}

{% endtab %}
Expand Down
46 changes: 33 additions & 13 deletions _docs/_api/endpoints/export.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ page_type: landing
guide_top_header: "Export Endpoints"
guide_top_text: "With this collection of endpoints, you will be able to access and export various levels of details on your KPIs, News Feed Cards, App Sessions, users, segments, Campaigns, and Canvases. <br> <br> Make sure you know your <a href='/docs/user_guide/administrative/access_braze/braze_instances/' target='_blank'>Braze instance</a>, <a href='/docs/api/api_key/' target='_blank'>API key</a>, and <a href='/docs/api/identifier_types/' target='_blank'>API identifier</a> when building out your parameters and request bodies."

guide_featured_title: "Campaign, Canvas, News Feed, and SMS Export Endpoints"
guide_featured_title: "Export Campaign Endpoints"
guide_featured_list:
- name: "GET: Campaign Analytics"
link: /docs/api/endpoints/export/campaigns/get_campaign_analytics/
Expand All @@ -27,6 +27,9 @@ guide_featured_list:
- name: "GET: Send Analytics"
link: /docs/api/endpoints/export/campaigns/get_send_analytics/
fa_icon: far fa-chart-bar

guide_menu_title: "Export Canvas Endpoints"
guide_menu_list:
- name: "GET: Canvas Data Series Analytics"
link: /docs/api/endpoints/export/canvas/get_canvas_analytics/
fa_icon: fas fa-project-diagram
Expand All @@ -39,24 +42,18 @@ guide_featured_list:
- name: "GET: Canvas List"
link: /docs/api/endpoints/export/canvas/get_canvases/
fa_icon: fas fa-project-diagram
- name: "GET: News Feed Card Engagement Stats"
link: /docs/api/endpoints/export/news_feed/get_news_feed_card_analytics/
fa_icon: fas fa-stream
- name: "GET: News Feed Card Details"
link: /docs/api/endpoints/export/news_feed/get_news_feed_card_details/
fa_icon: fas fa-stream
- name: "GET: News Feed Card List"
link: /docs/api/endpoints/export/news_feed/get_news_feed_cards/
fa_icon: fas fa-stream

guide_menu_title: "Custom Events, KPIs, Purchases, Segments, Sessions, and User Data Export Endpoints"
guide_menu_list:
guide_menu_title2: "Export Custom Events Endpoints"
guide_menu_list2:
- name: "GET: Custom Events List"
link: /docs/api/endpoints/export/custom_events/get_custom_events/
fa_icon: fas fa-chart-line
- name: "GET: Custom Event Analytics"
link: /docs/api/endpoints/export/custom_events/get_custom_events_analytics/
fa_icon: fas fa-chart-line

guide_menu_title3: "Export KPI Endpoints"
guide_menu_list3:
- name: "GET: KPIs for Daily New Users by Date"
link: /docs/api/endpoints/export/kpi/get_kpi_daily_new_users_date/
fa_icon: fas fa-bullseye
Expand All @@ -69,9 +66,27 @@ guide_menu_list:
- name: "GET: KPIs for Uninstalls by Date"
link: /docs/api/endpoints/export/kpi/get_kpi_uninstalls_date/
fa_icon: fas fa-bullseye

guide_menu_title4: "Export News Feed Endpoints"
guide_menu_list4:
- name: "GET: News Feed Card Engagement Stats"
link: /docs/api/endpoints/export/news_feed/get_news_feed_card_analytics/
fa_icon: fas fa-stream
- name: "GET: News Feed Card Details"
link: /docs/api/endpoints/export/news_feed/get_news_feed_card_details/
fa_icon: fas fa-stream
- name: "GET: News Feed Card List"
link: /docs/api/endpoints/export/news_feed/get_news_feed_cards/
fa_icon: fas fa-stream

guide_menu_title5: "Export Purchase Endpoint"
guide_menu_list5:
- name: "GET: List Product IDs"
link: /docs/api/endpoints/export/purchases/get_list_product_id/
fa_icon: fas fa-list

guide_menu_title6: "Export Segment Endpoints"
guide_menu_list6:
- name: "GET: Segment List"
link: /docs/api/endpoints/export/segments/get_segment/
fa_icon: fas fa-users
Expand All @@ -81,9 +96,15 @@ guide_menu_list:
- name: "GET: Segment Details"
link: /docs/api/endpoints/export/segments/get_segment_details/
fa_icon: fas fa-users

guide_menu_title7: "Export Sessions Endpoint"
guide_menu_list7:
- name: "GET: App Sessions Time-Series Data"
link: /docs/api/endpoints/export/sessions/get_sessions_analytics/
fa_icon: fas fa-tablet-alt

guide_menu_title8: "Export User Data Endpoints"
guide_menu_list8:
- name: "POST: User Data by Identifier"
link: /docs/api/endpoints/export/user_data/post_users_identifier/
fa_icon: fas fa-user
Expand All @@ -93,5 +114,4 @@ guide_menu_list:
- name: "POST: User Data by Global Control Group"
link: /docs/api/endpoints/export/user_data/post_users_global_control_group/
fa_icon: fas fa-user

---
6 changes: 6 additions & 0 deletions _docs/_api/endpoints/messaging.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,4 +74,10 @@ guide_menu_list:
- name: "POST: Send API-Triggered Canvas Messages Immediately"
link: /docs/api/endpoints/messaging/send_messages/post_send_triggered_canvases/
fa_icon: fas fa-inbox

guide_menu_title2: "Live Activity Endpoints"
guide_menu_list2:
- name: "POST: Update Live Activity"
link: /docs/api/endpoints/messaging/live_activity/update/
fa_icon: fas fa-tablet-alt
---
4 changes: 2 additions & 2 deletions _docs/_api/endpoints/messaging/live_activity/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Before using this endpoint, you must register an activity with the Braze Swift S
## Example request

```json
curl --location --request POST 'https://rest.iad-01.braze.com/messages/live_activity/update \
curl --location --request POST 'https://rest.iad-01.braze.com/messages/live_activity/update' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {YOUR-REST-API-KEY}' \
--data-raw '{
Expand All @@ -76,7 +76,7 @@ curl --location --request POST 'https://rest.iad-01.braze.com/messages/live_acti
"title": "Halftime"
}
}
}
}'
```

## Response
Expand Down
5 changes: 5 additions & 0 deletions _docs/_api/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ glossary_tags:
- name: SMS
- name: Subscription Groups
- name: User Data
- name: Live Activity

glossaries:
- name: <a href='/docs/api/endpoints/user_data/post_user_alias/'>/users/alias/new</a>
Expand Down Expand Up @@ -156,6 +157,10 @@ glossaries:
description: Return a JSON list of information about scheduled campaigns and entry Canvases between now and a designated <code>end_time</code> specified in the request.
tags:
- Schedule Messages
- name: <a href='/docs/api/endpoints/messaging/live_activity/update/'>/messages/live_activity/update</a>
description: Update an iOS Live Activity.
tags:
- Live Activity
- name: <a href='/docs/api/endpoints/subscription_groups/post_update_user_subscription_group_status/'>/subscription/status/set</a>
description: Batch update the subscription state of up to 50 users on the Braze dashboard.
tags:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ To complete the installation, you will need the [App Identifier API key]({{site.

## Step 1: Integrate the Braze library

{% alert note %}
Braze React Native SDK v1.38.0+ requires at least React Native v0.64+. Braze React Native SDK is not yet compatible with the new React Native architecture.
{% alert warning %}
Braze React Native SDK v1.38.0+ requires at least React Native v0.64+. Braze React Native SDK is not yet compatible with the new React Native architecture (v0.69.0 or above).
{% endalert %}

{% tabs local %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ Let's say you were to rolling out a new type of user profile for your app. You m
{% tab Javascript %}
```javascript
const featureFlag = braze.getFeatureFlag("expanded_user_profile");
if (feature.enabled) {
if (featureFlag.enabled) {
console.log(`expanded_user_profile is enabled`);
} else {
console.log(`expanded_user_profile is not enabled`);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ You will not need to recreate each email from scratch; you can simply copy the f

#### Step 3: Schedule your Braze campaign

Schedule your campaign to start at a specific time. You will need to know this time to plug into Phrasee.
Schedule your campaign to start at a specific time, this can also be done using the API and the [`campaign/trigger/send` endpoint](https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_triggered_campaigns/). You will need to know this time to plug into Phrasee.

![A scheduled delivery campaign sent at a designated time.]({% image_buster /assets/img/phrasee/6_braze_schedule.png %})

Expand Down Expand Up @@ -113,7 +113,7 @@ You can also enter the whole Phrasee variant into the **Message body** for the r

#### Step 4: Schedule your Braze campaign

Schedule your campaign to start at a specific time. You will need to know this time to plug into Phrasee.
Schedule your campaign to start at a specific time, this can also be done using the API and the [`campaign/trigger/send` endpoint](https://www.braze.com/docs/api/endpoints/messaging/send_messages/post_send_triggered_campaigns/). You will need to know this time to plug into Phrasee.

![A scheduled delivery campaign sent at a designated time.]({% image_buster /assets/img/phrasee/6_braze_schedule.png %})

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Phrasee [React](https://phrasee.co/platform/react/), powered by Phrasee X, lever
|---|---|
| Phrasee account | A [Phrasee account][3] is required to take advantage of this partnership. |
| Phrasee connect server token | A long string of characters that will serve as your Braze campaign's password to access your Phrasee language.<br><br>You can request this from your Phrasee customer success manager if you haven't already been provided it. |
| Currents (Optional) | In order to export data to Currents, you need to have [Braze Currents]({{site.baseurl}}/user_guide/data_and_analytics/braze_currents/#access-currents) set up for your account. |
| Currents | In order to export data to Currents, you need to have [Braze Currents]({{site.baseurl}}/user_guide/data_and_analytics/braze_currents/#access-currents) set up for your account. |
{: .reset-td-br-1 .reset-td-br-2}

## Integration
Expand All @@ -46,13 +46,10 @@ By default, the Current will include certain PII attributes like email and addre

### Step 4: Phrasee X code snippets

The linked code snippets leverage [Connected Content]({{site.baseurl}}/user_guide/personalization_and_dynamic_content/connected_content) and, once placed in your emails, will dynamically pull in language and a tracking pixel so Phrasee can optimize your language in real-time using Phrasee X.
Reach out to your Phrasee account team for the required code snippets.

These code snippets can be found in [Phrasee's documentation](https://support.phrasee.co/en/articles/6101325-braze-dynamic-optimization-code-snippets).
These snippets leverage [Connected Content]({{site.baseurl}}/user_guide/personalization_and_dynamic_content/connected_content) and, once placed in your emails, will dynamically pull in language and a tracking pixel so Phrasee can optimize your language in real-time using Phrasee X.

{% alert tip %}
If you are having trouble viewing the code snippets, make sure you are logged in to Phrasee.
{% endalert %}

[1]: https://phrasee.co/
[3]: mailto:awesome@phrasee.co
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,19 @@ Due to user privacy reasons, Facebook doesn't allow you to see:
- The size of the Custom Audience. [Learn more.](https://marketingland.com/exclusive-facebook-will-no-longer-show-audience-reach-estimates-for-custom-audiences-after-vulnerability-detected-236923)
{% endalert %}

#### Configure your audience export

When building Facebook audiences, you may wish to include or exclude certain users based on their preferences, and in order to comply with privacy laws, such as the “Do Not Sell or Share” right under the [CCPA](https://oag.ca.gov/privacy/ccpa). Marketers should implement the relevant filters for users’ eligibility within their Canvas entry criteria. Below we list some options.

If you have collected the [iOS IDFA through the Braze SDK]({{site.baseurl}}/developer_guide/platform_integration_guides/ios/initial_sdk_setup/other_sdk_customizations/#optional-idfa-collection), you will be able to use the **Ads Tracking Enabled** filter. Select the value as `true` to only send users into Audience Sync destinations where they have opted in.

![][16]{: style="max-width:75%;"}

If you are collecting ‘opt-ins’, ‘opt-outs’, ‘Do Not Sell Or Share’ or any other relevant custom attributes, you should include these within your Canvas entry criteria as a filter:

![A Canvas with an entry audience of "opted_in_marketing" equals "true".][15]{: style="max-width:75%;"}


#### Lookalike Audiences

Once you've successfully exported a segment as a Facebook Audience, you can create additional groups using Facebook's [Lookalike Audiences][4]. This feature looks at your chosen audience's demographics, interests, and other attributes and creates a new audience of people with similar attributes.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,11 +57,8 @@ Winning Path is similar to [Winning Variant]({{site.baseurl}}/user_guide/engagem

For more, refer to [Winning Path]({{site.baseurl}}/user_guide/engagement_tools/canvas/canvas_components/experiment_step/winning_path).

### Step 3: Select how long to track conversions

Experiment Paths will record users who enter each step and convert while in the assigned path. This will track all conversion events specified in the Canvas setup. Use the input box at the bottom of the panel to enter how many days (between 1 and 30) you'd like this experiment to track conversions. Note that the time window you specify here will determine how long conversions (specified in Canvas setup) will be tracked for Experiment Paths. The per-event conversion windows specified in Canvas setup will not apply to this component's tracking.

### Step 4: Create paths
### Step 3: Create paths

Lastly, you must build your downstream paths. Select **Done** and return to the Canvas builder. Click the <i class="fas fa-plus-circle"></i> plus button under each path to begin creating journeys using the usual Canvas tools as you see fit, and launch the Canvas when you are ready.

Expand All @@ -71,16 +68,21 @@ Keep in mind that paths and their downstream steps cannot be removed from a Canv

## Tracking performance

Each path will display statistics in the [Canvas Analytics]({{site.baseurl}}/user_guide/engagement_tools/canvas/get_started/measuring_and_testing_with_canvas_analytics/) view, just like any Canvas step.

From the Canvas Analytics page, click the Experiment Path to open a [detailed table]({{site.baseurl}}/user_guide/engagement_tools/canvas/get_started/measuring_and_testing_with_canvas_analytics/#performance-breakdown-by-variant) identical to the **Analyze Variants** tab to compare detailed performance and conversion statistics across paths. You can also export the table via CSV and compare percent changes for metrics of interest relative to the path or control you select.

Each step in each path will display statistics in the [Canvas Analytics]({{site.baseurl}}/user_guide/engagement_tools/canvas/get_started/measuring_and_testing_with_canvas_analytics/) view, just like any Canvas step. However, keep in mind that individual steps' analytics do **not** take into account the structure of the Experiment. The analytics in the Experiment Step should be used to compare across paths.

### Winning Path performance

If Winning Path was turned on, your analytics view is separated into two tabs: **Initial Experiment** and **Winning Path**.

- **Initial Experiment:** Shows the metrics for each path during the experiment window. You can see a summary of how all the paths performed for the specified conversion events, and which path was selected as the winner.
- **Winning Path:** Shows only the metrics for the Winning Path.
- **Winning Path:** Shows only the metrics for the Winning Path starting from the moment the Initial Experiment finished.

### Additional settings

Experiment Paths will record users who enter each step and convert while in the assigned path. This will track all conversion events specified in the Canvas setup. On the Additional Settings tab, use the input to enter how many days (between 1 and 30) you'd like this experiment to track conversions. Note that the time window you specify here will determine how long conversion events (chosen in Canvas setup) will be tracked for Experiment Paths. The per-event conversion windows specified in Canvas setup will not apply to this step's tracking and will be replaced by this Conversion Window.


[0]: {% image_buster /assets/img/experiment_step/experiment_step.png %}
[1]: {% image_buster /assets/img/experiment_step/exp_settings.png %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Add an [Experiment Path]({{site.baseurl}}/user_guide/engagement_tools/canvas/can

![Settings in Experiment Path titled "Distribute Subsequent Users to Winning Path". The section includes a toggle for Winning Path, and options to configure the conversion event and experiment window.][1]

Specify the conversion event that should determine the winner. If there are no conversion events available, return to the first step of Canvas setup and [assign conversion events]({{site.baseurl}}/user_guide/engagement_tools/canvas/create_a_canvas/create_a_canvas/#choose-conversion-events).
Specify the conversion event that should determine the winner. If there are no conversion events available, return to the first step of Canvas setup and [assign conversion events]({{site.baseurl}}/user_guide/engagement_tools/canvas/create_a_canvas/create_a_canvas/#choose-conversion-events). Note that if you determine the winner with opens and clicks, only the first message in the path that generates opens or clicks will contribute to determining the winner.

Then set the **Experiment Window**. The **Experiment Window** specifies how long the experiment will run before the Winning Path is determined and all users that follow are sent down that path. The window begins when the first user enters the step.

Expand All @@ -47,5 +47,11 @@ The duration of the delay step should be slightly longer than the Experiment Win
If you'd like this functionality to be built into Winning Path, please let the Braze product team know by [voting for it on the Braze Product Portal](https://portal.productboard.com/ko5rgqefrdssb5wesynqswxp/c/206-winning-path-for-one-time-sends?utm_medium=social&utm_source=portal_share).
{% endalert %}

## Using Winning Paths with local time delivery

We don't recommend using local time delivery in Canvases with Winning Paths. This is because Experiment Windows begin when the first user passes through. Users who are in very early time zones may enter the step and trigger the start of the Experiment Window much earlier than you expect, which can result in the Experiment concluding before the bulk of your users in more typical time zones have had enough time to enter the Canvas and/or convert.

Alternatively, if you wish to use local delivery, use an Experiment Window of 24-48 or more hours. That way, users in early time zones enter the canvas and trigger the experiment to start, but plenty of time in the Experiment Window remains. Users in later time zones will still have sufficient time to enter the Canvas and the Experiment Step with Winning Paths and possibly convert before the Experiment Window expires.

[1]: {% image_buster /assets/img/experiment_step/experiment_winning_path.png %}
[2]: {% image_buster /assets/img/experiment_step/experiment_onetime_workaround.png %}
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,6 @@ alias: "/create_dnd_iam/"

With the Drag & Drop Editor, you can create completely custom and personalized in-app messages in either campaigns or Canvas using the drag & drop editing experience.

{% alert important %}
This feature is currently in early access. Please reach out to your customer success representative for access.
{% endalert %}

If you want to use your existing custom HTML templates or templates created by a third party, they must be recreated in the Drag & Drop Editor.

Not sure whether your in-app message should be sent using a campaign or a [Canvas]({{site.baseurl}}/user_guide/engagement_tools/canvas/create_a_canvas/in-app_messages_in_canvas/)? Campaigns are better for single, simple messaging campaigns, while Canvases are better for multi-step user journeys. Once you've selected where to build your message, let's dive into the steps to create a drag & drop in-app message!
Expand Down
Loading

2 comments on commit 7770ee6

@vercel
Copy link

@vercel vercel bot commented on 7770ee6 Mar 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

braze-docs-fr – ./

braze-docs-fr-braze.vercel.app
braze-docs-fr.vercel.app
braze-docs-fr-git-master-braze.vercel.app

@vercel
Copy link

@vercel vercel bot commented on 7770ee6 Mar 9, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

braze-docs-en – ./

braze-docs-en.vercel.app
braze-docs-en-git-master-braze.vercel.app
braze-docs-en-braze.vercel.app

Please sign in to comment.