Skip to content

Commit

Permalink
Merge pull request #5385 from braze-inc/bf/react_GA_callouts
Browse files Browse the repository at this point in the history
  • Loading branch information
bre-fitzgerald authored May 15, 2023
2 parents e5da1d3 + 7180a7a commit bb2fc2f
Show file tree
Hide file tree
Showing 277 changed files with 1,603 additions and 518 deletions.
4 changes: 3 additions & 1 deletion _docs/_api/api_campaigns.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,11 @@ Because API campaigns are typically transactional, all users are eligible for AP
Navigate to the **Campaigns** page in your Braze account and click **Create Campaign**, then select **API Campaigns**. Now, you can move on to configuring your API campaign.

{% alert note %}
An [API-triggered campaign]({{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/delivery_types/api_triggered_delivery/) is different from an API campaign.
If you are using our [updated navigation]({{site.baseurl}}/navigation), you can find **Campaigns** under **Messaging**.
{% endalert %}

An [API-triggered campaign]({{site.baseurl}}/user_guide/engagement_tools/campaigns/building_campaigns/delivery_types/api_triggered_delivery/) is different from an API campaign.

## Configure your campaign

To configure your campaign, perform the following steps:
Expand Down
6 changes: 3 additions & 3 deletions _docs/_api/api_limits.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ page_type: reference

# Rate limits

> The Braze API infrastructure is designed to handle high volumes of data across our customer base. To this end, we enforce API rate limits per app group.
> The Braze API infrastructure is designed to handle high volumes of data across our customer base. To this end, we enforce API rate limits per workspace.
A rate limit is the number of requests the API can receive in a given time period. Many load-based denial-of-service incidents in large systems are unintentional—caused by errors in software or configurations—not malicious attacks. Rate limits ensure that such errors don't deprive our customers of Braze API resources. If too many requests are sent in a given time frame, you may see error responses with a status code of `429`, which indicates the rate limit has been hit.

Expand Down Expand Up @@ -37,8 +37,8 @@ These default limits can be increased upon request. Reach out to your customer s
| [`/canvas/trigger/send`][17.2] | 250 requests per minute for broadcast calls (when only specifying a segment or Connected Audience). Otherwise, 250,000 requests per hour. |
| [`/sends/id/create`][18] | 100 requests per day. |
| [`/subscription/status/set`][19] | 5,000 requests per minute. |
| [`/preference_center/v1/{preferenceCenterExternalId}/url/{userId}`][26]<br>[`/preference_center/v1/list`][27]<br>[`/preference_center/v1/{preferenceCenterExternalId}`][28] | 1,000 requests per minute, per app group. |
| [`/preference_center/v1`][29]<br>[`/preference_center/v1/{preferenceCenterExternalId}`][30] | 10 requests per minute, per app group. |
| [`/preference_center/v1/{preferenceCenterExternalId}/url/{userId}`][26]<br>[`/preference_center/v1/list`][27]<br>[`/preference_center/v1/{preferenceCenterExternalId}`][28] | 1,000 requests per minute, per workspace. |
| [`/preference_center/v1`][29]<br>[`/preference_center/v1/{preferenceCenterExternalId}`][30] | 10 requests per minute, per workspace. |
| [`DELETE: /catalogs/{catalog_name}`][31]<br>[`GET: /catalogs`][32]<br>[`POST: /catalogs`][33] | 5 requests per minute shared between the endpoints. |
| [`DELETE: /catalogs/{catalog_name}/items`][34]<br>[`PATCH: /catalogs/{catalog_name}/items`][35]<br>[`POST: /catalogs/{catalog_name}/items`][36] | 100 requests per minute shared between the endpoints. |
| [`DELETE: /catalogs/{catalog_name}/items/{item_id}`][37]<br>[`GET: /catalogs/{catalog_name}/items/{item_id}`][38]<br>[`GET: /catalogs/{catalog_name}/items`][39]<br>[`PATCH: /catalogs/{catalog_name}/items/{item_id}`][40]<br>[`POST: /catalogs/{catalog_name}/items/{item_id}`][41] | 50 requests per minute shared between the endpoints. |
Expand Down
12 changes: 9 additions & 3 deletions _docs/_api/basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ For more information, refer to the following article based on your platform: [iO

A REST Application Programming Interface key (REST API key) is a unique code that is passed into an API to authenticate the API call and identify the calling application or user. API access is done using HTTPS web requests to your company's REST API endpoint. We use REST API keys at Braze in tandem with our App Identifier keys to track, access, send, export, and analyze data to help make sure everything is running smoothly on both your and our end.

App Groups and API Keys go hand in hand at Braze. App Groups are designed to house versions of the same application across multiple platforms. Many customers also use app groups to contain free and premium versions of their applications on the same platform. As you may notice, these app groups are also making use of the REST API and have their own REST API keys. These keys can be individually scoped to include access to specific endpoints on the API. Each call to the API must include a key with access to the endpoint hit.
Workspaces and API Keys go hand in hand at Braze. Workspaces are designed to house versions of the same application across multiple platforms. Many customers also use workspaces to contain free and premium versions of their applications on the same platform. As you may notice, these workspaces are also making use of the REST API and have their own REST API keys. These keys can be individually scoped to include access to specific endpoints on the API. Each call to the API must include a key with access to the endpoint hit.

We refer to both the REST API key and App Group API key as the `api_key`. The `api_key` is included in each request as a request header and acts as an authentication key that allows you to utilize our REST APIs. These REST APIs are used to track users, send messages, export user data, and more. When you create a new REST API key, you will need to give it access to specific endpoints. By assigning specific permissions to an API key, you can limit exactly which calls an API key can authenticate.
We refer to both the REST API key and workspace API key as the `api_key`. The `api_key` is included in each request as a request header and acts as an authentication key that allows you to utilize our REST APIs. These REST APIs are used to track users, send messages, export user data, and more. When you create a new REST API key, you will need to give it access to specific endpoints. By assigning specific permissions to an API key, you can limit exactly which calls an API key can authenticate.

![REST API keys panel on the API Settings tab of the Developer Console.][27]

Expand Down Expand Up @@ -247,7 +247,13 @@ News Feed is being deprecated. Braze recommends that customers who use our News

![][28]{: style="max-width:20%;float:right;margin-left:15px;"}

To create a new REST API key, visit the **Developer Console** on your Braze dashboard. This page displays your existing API keys. To create a new key, click **Create New API Key**.
To create a new REST API key, visit the **Developer Console** > **API Settings** on your Braze dashboard.

{% alert note %}
If you are using our [updated navigation]({{site.baseurl}}/navigation), **API Settings** is now **API Keys** and can be found at **Settings** > **Setup and Testing** > **API Keys**.
{% endalert %}

This page displays your existing API keys. To create a new key, click **Create New API Key**.

You can then to do the following:

Expand Down
6 changes: 3 additions & 3 deletions _docs/_api/data_retention.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Warning! Don't make any changes to this document without approval from the legal
## Data Retention Handled by Customers Through Braze's Dashboard or API

Braze enables its customers to delete entire User Profiles and Attribute data themselves from their app group.
Braze enables its customers to delete entire User Profiles and Attribute data themselves from their workspace.

This means you can:
- Delete user profiles using the Braze [Delete user API endpoint]({{site.baseurl}}/api/endpoints/user_data/post_user_delete/)
Expand Down Expand Up @@ -50,7 +50,7 @@ Customers have full control over whether or not a user is Inactive or Dormant an
{% tab Campaign Interactions Data %}
**What is it?** Campaign Interactions are data related to End Users' interactions with a campaign. They are used for retargeting filters and to determine campaign re-eligibility.

**When is it deleted?** Braze automatically deletes from the Customer's App Groups the Campaign Interactions for campaigns that have not sent any messages in 25 calendar months and are not used for retargeting in any campaigns, Canvases, or Content Cards in an active status.
**When is it deleted?** Braze automatically deletes from the Customer's workspaces the Campaign Interactions for campaigns that have not sent any messages in 25 calendar months and are not used for retargeting in any campaigns, Canvases, or Content Cards in an active status.

**What happens after deletion?**

Expand All @@ -64,7 +64,7 @@ Customers have full control over whether or not a user is Inactive or Dormant an

**What is it?** Canvas Interactions are data related to End Users' interactions with a Canvas or Canvas step. They are used for retargeting filters and to determine Canvas re-eligibility.

**When is it deleted?** Braze automatically deletes from the Customer's App Groups the Canvas Interactions for Canvases that have not sent any messages in 25 calendar months and are not used for retargeting by any Active Campaigns or Canvases.
**When is it deleted?** Braze automatically deletes from the Customer's workspaces the Canvas Interactions for Canvases that have not sent any messages in 25 calendar months and are not used for retargeting by any Active Campaigns or Canvases.

**What happens after deletion?**
- Canvases with no Canvas Interactions cannot be used in retargeting filters for campaigns, Canvases, and Segments.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "This article outlines details about the List catalogs Braze endpoi
/catalogs
{% endapimethod %}

> Use this endpoint to return a list of catalogs in an app group.
> Use this endpoint to return a list of catalogs in a workspace.
{% multi_lang_include rate_limits.md endpoint='delete dashboard user' %}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,15 @@ Data returned includes how many messages were sent, opened, clicked, or converte

| Parameter | Required | Data Type | Description |
| --------- | -------- | --------- | ----------- |
| `campaign_id` | Required | String | See [campaign API identifier]({{site.baseurl}}/api/identifier_types/).<br><br> The `campaign_id` for API campaigns can be found on the **Developer Console** and the **Campaign Details** page within your dashboard, or you can use the [List campaigns endpoint](#campaign-list-endpoint). |
| `campaign_id` | Required | String | See [campaign API identifier]({{site.baseurl}}/api/identifier_types/).<br><br> The `campaign_id` for API campaigns can be found at **Developer Console** > **API Settings** and the **Campaign Details** page within your dashboard, or you can use the [List campaigns endpoint](#campaign-list-endpoint). |
| `length` | Required | Integer | Maximum number of days before `ending_at` to include in the returned series. Must be between 1 and 100 (inclusive). |
| `ending_at` | Optional | Datetime <br>([ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) string) | Date on which the data series should end. Defaults to time of the request. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

{% alert note %}
If you are using our [updated navigation]({{site.baseurl}}/navigation), **API Settings** is now **API Keys** and can be found at **Settings** > **Setup and Testing** > **API Keys**.
{% endalert %}

## Example request

{% raw %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,13 @@ If you want to retrieve Canvas data, refer to the [Export Canvas details]({{site

| Parameter | Required | Data Type | Description |
| --------- | -------- | --------- | ----------- |
| `campaign_id` | Required | String | See [campaign API identifier]({{site.baseurl}}/api/identifier_types/).<br><br> The `campaign_id` for API campaigns can be found on the **Developer Console** and the **Campaign Details** page within your dashboard; or you can use the [Export campaigns list endpoint](#campaign-list-endpoint). |
| `campaign_id` | Required | String | See [campaign API identifier]({{site.baseurl}}/api/identifier_types/).<br><br> The `campaign_id` for API campaigns can be found at **Developer Console** > **API Settings** and the **Campaign Details** page within your dashboard; or you can use the [Export campaigns list endpoint](#campaign-list-endpoint). |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

{% alert note %}
If you are using our [updated navigation]({{site.baseurl}}/navigation), **API Settings** is now **API Keys** and can be found at **Settings** > **Setup and Testing** > **API Keys**.
{% endalert %}

## Example request
{% raw %}
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,14 @@ description: "This article outlines details about the Export custom events analy
| `length` | Required | Integer | Maximum number of units (days or hours) before `ending_at` to include in the returned series. Must be between 1 and 100 (inclusive). |
| `unit` | Optional | String | Unit of time between data points. Can be `day` or `hour`, defaults to `day`. |
| `ending_at` | Optional | Datetime <br>([ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) string) | Date on which the data series should end. Defaults to time of the request. |
| `app_id` | Optional | String | App API identifier retrieved from the **Developer Console** to limit analytics to a specific app. |
| `app_id` | Optional | String | App API identifier retrieved from **Developer Console** > **API Settings** to limit analytics to a specific app. |
| `segment_id` | Optional | String | See [Segment API identifier]({{site.baseurl}}/api/identifier_types/). Segment ID indicating the analytics-enabled segment for which event analytics should be returned. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

{% alert note %}
If you are using our [updated navigation]({{site.baseurl}}/navigation), **API Settings** is now **API Keys** and can be found at **Settings** > **Setup and Testing** > **API Keys**.
{% endalert %}

## Example request
{% raw %}
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,13 @@ description: "This article outlines details about the Export daily new users Bra
| -------- | -------- | --------- | ----------- |
| `length` | Required | Integer | Maximum number of days before `ending_at` to include in the returned series. Must be between 1 and 100 (inclusive). |
| `ending_at` | Optional | Datetime <br>([ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) string) | Date on which the data series should end. Defaults to time of the request. |
| `app_id` | Optional | String | App API identifier retrieved from the **Developer Console**. If excluded, results for all apps in app group will be returned. |
| `app_id` | Optional | String | App API identifier retrieved from **Developer Console** > **API Settings**. If excluded, results for all apps in workspace will be returned. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

{% alert note %}
If you are using our [updated navigation]({{site.baseurl}}/navigation), **API Settings** is now **API Keys** and can be found at **Settings** > **Setup and Testing** > **API Keys**.
{% endalert %}

## Example request
{% raw %}
```
Expand Down
6 changes: 5 additions & 1 deletion _docs/_api/endpoints/export/kpi/get_kpi_dau_date.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,13 @@ description: "This article outlines details about the Export daily active users
| -------- | -------- | --------- | ----------- |
| `length` | Required | Integer | Maximum number of days before `ending_at` to include in the returned series. Must be between 1 and 100 (inclusive). |
| `ending_at` | Optional | Datetime <br>([ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) string) | Date on which the data series should end. Defaults to time of the request. |
| `app_id` | Optional | String | App API identifier retrieved from the **Developer Console**. If excluded, results for all apps in app group will be returned. |
| `app_id` | Optional | String | App API identifier retrieved from **Developer Console** > **API Settings**. If excluded, results for all apps in workspace will be returned. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

{% alert note %}
If you are using our [updated navigation]({{site.baseurl}}/navigation), **API Settings** is now **API Keys** and can be found at **Settings** > **Setup and Testing** > **API Keys**.
{% endalert %}

## Example request
{% raw %}
```
Expand Down
6 changes: 5 additions & 1 deletion _docs/_api/endpoints/export/kpi/get_kpi_mau_30_days.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,13 @@ description: "This article outlines details about the Export monthly active user
| -------- | -------- | --------- | ----------- |
| `length` | Required | Integer | Maximum number of days before `ending_at` to include in the returned series. Must be between 1 and 100 (inclusive). |
| `ending_at` | Optional | Datetime <br>([ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) string) | Date on which the data series should end. Defaults to time of the request. |
| `app_id` | Optional | String | App API identifier retrieved from the **Developer Console**. If excluded, results for all apps in app group will be returned. |
| `app_id` | Optional | String | App API identifier retrieved from **Developer Console** > **API Settings**. If excluded, results for all apps in workspace will be returned. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

{% alert note %}
If you are using our [updated navigation]({{site.baseurl}}/navigation), **API Settings** is now **API Keys** and can be found at **Settings** > **Setup and Testing** > **API Keys**.
{% endalert %}

## Example request
{% raw %}
```
Expand Down
6 changes: 5 additions & 1 deletion _docs/_api/endpoints/export/kpi/get_kpi_uninstalls_date.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,13 @@ description: "This article outlines details about the Export daily app uninstall
| -------- | -------- | --------- | ----------- |
| `length` | Required | Integer | Maximum number of days before `ending_at` to include in the returned series. Must be between 1 and 100 (inclusive). |
| `ending_at` | Optional | Datetime <br>([ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) string) | Date on which the data series should end. Defaults to time of the request. |
| `app_id` | Optional | String | App API identifier retrieved from the **Developer Console**. If excluded, results for all apps in app group will be returned. |
| `app_id` | Optional | String | App API identifier retrieved from **Developer Console** > **API Settings**. If excluded, results for all apps in workspace will be returned. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

{% alert note %}
If you are using our [updated navigation]({{site.baseurl}}/navigation), **API Settings** is now **API Keys** and can be found at **Settings** > **Setup and Testing** > **API Keys**.
{% endalert %}

## Example request
{% raw %}
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,16 @@ News Feed is being deprecated. Braze recommends that customers who use our News

| Parameter | Required | Data Type | Description |
| ----------- | -------- | --------- | ----------- |
| `card_id` | Required | String | See [Card API identifier]({{site.baseurl}}/api/identifier_types/). <br><br> The `card_id` for a given card can be found in the **Developer Console** page and on the card details page within your dashboard, or you can use the [Export News Feed cards list endpoint]({{site.baseurl}}/api/endpoints/export/news_feed/get_news_feed_cards/).|
| `card_id` | Required | String | See [Card API identifier]({{site.baseurl}}/api/identifier_types/). <br><br> The `card_id` for a given card can be found at **Developer Console** > **API Settings** and on the card details page within your dashboard, or you can use the [Export News Feed cards list endpoint]({{site.baseurl}}/api/endpoints/export/news_feed/get_news_feed_cards/).|
| `length` | Required | Integer | Maximum number of units (days or hours) before `ending_at` to include in the returned series. Must be between 1 and 100 (inclusive). |
| `unit` | Optional | String | Unit of time between data points. Can be `day` or `hour`, defaults to `day`. |
| `ending_at` | Optional | Datetime <br>([ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) string) | Date on which the data series should end. Defaults to time of the request. |
{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}

{% alert note %}
If you are using our [updated navigation]({{site.baseurl}}/navigation), **API Settings** is now **API Keys** and can be found at **Settings** > **Setup and Testing** > **API Keys**.
{% endalert %}

## Example request
{% raw %}
```
Expand Down
Loading

0 comments on commit bb2fc2f

Please sign in to comment.