CO-2650 CO-2735 Add custom data dictionary documentation.

_docs/_api/endpoints/export.md

@@ -45,6 +45,9 @@ guide_menu_list:
 
 guide_menu_title2: "Export custom events endpoints"
 guide_menu_list2:
+  - name: "GET: Custom Events"
+    link: /docs/api/endpoints/export/custom_events/get_custom_events_data/
+    image: /assets/img/braze_icons/line-chart-up-01.svg
   - name: "GET: Custom Events List"
     link: /docs/api/endpoints/export/custom_events/get_custom_events/
     image: /assets/img/braze_icons/line-chart-up-01.svg
@@ -120,4 +123,10 @@ guide_menu_list8:
   - name: "POST: User Data by Global Control Group"
     link: /docs/api/endpoints/export/user_data/post_users_global_control_group/
     image: /assets/img/braze_icons/users-01.svg
+
+guide_menu_title9: "Export custom attributes endpoints"
+guide_menu_list9:
+  - name: "GET: Custom Attributes"
+    link: /docs/api/endpoints/export/custom_attributes/get_custom_attributes/
+    image: /assets/img/braze_icons/line-chart-up-01.svg
 ---

_docs/_api/endpoints/export/custom_attributes.md

@@ -0,0 +1,6 @@
+---
+nav_title: Custom Attributes
+config_only: true
+noindex: true
+page_order: 10
+---

_docs/_api/endpoints/export/custom_attributes/get_custom_attributes.md

@@ -0,0 +1,88 @@
+---
+nav_title: "GET: Export Custom Attributes"
+article_title: "GET: Export Custom Attributes"
+search_tag: Endpoint
+page_order: 4
+layout: api_page
+page_type: reference
+description: "This article outlines details about the Export custom attributes Braze endpoint."
+
+---
+{% api %}
+# Export custom attributes
+{% apimethod get %}
+/custom_attributes
+{% endapimethod %}
+
+> Use this endpoint to export a list of custom attributes recorded for your app. The attributes are returned in groups of 50, sorted alphabetically.
+
+{% alert important %}
+This endpoint is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
+{% endalert %}
+
+
+## Prerequisites
+
+To use this endpoint, you'll need an [API key]({{site.baseurl}}/api/basics#rest-api-key/) with the `custom_attributes.get` permission.
+
+## Rate limit
+
+{% multi_lang_include rate_limits.md endpoint='custom_attributes' %}
+
+## Query parameters
+
+Note that each call to this endpoint will return 50 attributes. For more than 50 attributes, use the `Link` header to retrieve the data on the next page as shown in the following example response.
+
+| Parameter | Required | Data Type | Description |
+|---|---|---|---|
+| `cursor` | Optional | String | Determines the pagination of the custom attributes. |
+{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}
+
+## Example requests
+
+### Without cursor
+
+```
+curl --location --request GET 'https://rest.iad-01.braze.com/custom_attributes' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Bearer YOUR-REST-API-KEY'
+```
+
+### With cursor
+
+```
+curl --location --request GET 'https://rest.iad-03.braze.com/custom_attributes?cursor=c2tpcDow' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Bearer YOUR-REST-API-KEY'
+```
+
+## Response
+
+```json
+Content-Type: application/json
+Authorization: Bearer YOUR-REST-API-KEY
+{
+    "message": (required, string) the status of the export, returns 'success' when completed without errors,
+    "attributes" : [
+        {
+            "array_length": 100, (number) the maximum array length, or null if not applicable,
+            "data_type": "Number", (string) the data type,
+            "description": "The attribute description", (string) the attribute description,
+            "name": "The attribute name", (string) the attribute name,
+            "status": "Active", (string) the attribute status,
+            "tag_names": ["Tag One", "Tag Two"] (array) the tag names associated with the attribute formatted as strings,
+        },
+        ...
+    ]
+}
+```
+
+### Fatal error response codes {#fatal-export}
+
+For status codes and associated error messages that will be returned if your request encounters a fatal error, reference [Fatal errors]({{site.baseurl}}/api/errors/#fatal-errors).
+
+{% alert tip %}
+For help with CSV and API exports, visit [Export troubleshooting]({{site.baseurl}}/user_guide/data_and_analytics/export_braze_data/export_troubleshooting/).
+{% endalert %}
+
+{% endapi %}

_docs/_api/endpoints/export/custom_events/get_custom_events_data.md

@@ -0,0 +1,87 @@
+---
+nav_title: "GET: Export Custom Events"
+article_title: "GET: Export Custom Events"
+search_tag: Endpoint
+page_order: 4
+layout: api_page
+page_type: reference
+description: "This article outlines details about the Export custom events Braze endpoint."
+
+---
+{% api %}
+# Export custom events
+{% apimethod get %}
+/events
+{% endapimethod %}
+
+> Use this endpoint to export a list of custom events recorded for your app. The events are returned in groups of 50, sorted alphabetically.
+
+{% alert important %}
+This endpoint is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
+{% endalert %}
+
+
+## Prerequisites
+
+To use this endpoint, you'll need an [API key]({{site.baseurl}}/api/basics#rest-api-key/) with the `events.get` permission.
+
+## Rate limit
+
+{% multi_lang_include rate_limits.md endpoint='events' %}
+
+## Query parameters
+
+Note that each call to this endpoint will return 50 events. For more than 50 events, use the `Link` header to retrieve the data on the next page as shown in the following example response.
+
+| Parameter | Required | Data Type | Description |
+|---|---|---|---|
+| `cursor` | Optional | String | Determines the pagination of the custom events. |
+{: .reset-td-br-1 .reset-td-br-2 .reset-td-br-3 .reset-td-br-4}
+
+## Example requests
+
+### Without cursor
+
+```
+curl --location --request GET 'https://rest.iad-01.braze.com/events' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Bearer YOUR-REST-API-KEY'
+```
+
+### With cursor
+
+```
+curl --location --request GET 'https://rest.iad-03.braze.com/events?cursor=c2tpcDow' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Bearer YOUR-REST-API-KEY'
+```
+
+## Response
+
+```json
+Content-Type: application/json
+Authorization: Bearer YOUR-REST-API-KEY
+{
+    "message": (required, string) the status of the export, returns 'success' when completed without errors,
+    "events" : [
+        {
+            "name": "The event name", (string) the event name,
+            "description": "The event description", (string) the event description,
+            "included_in_analytics_report": false, (boolean) the analytics report inclusion,
+            "status": "Active", (string) the event status,
+            "tag_names": ["Tag One", "Tag Two"] (array) the tag names associated with the event formatted as strings,
+        },
+        ...
+    ]
+}
+```
+
+### Fatal error response codes {#fatal-export}
+
+For status codes and associated error messages that will be returned if your request encounters a fatal error, reference [Fatal errors]({{site.baseurl}}/api/errors/#fatal-errors).
+
+{% alert tip %}
+For help with CSV and API exports, visit [Export troubleshooting]({{site.baseurl}}/user_guide/data_and_analytics/export_braze_data/export_troubleshooting/).
+{% endalert %}
+
+{% endapi %}

_docs/_api/home.md

@@ -266,12 +266,20 @@ glossaries:
     description: Retrieve a series of the number of sessions for your app over a designated time period.
     tags:
       - Sessions
+  - name: <a href='/docs/api/endpoints/export/custom_attributes/get_custom_attributes/'>/custom_attributes</a>
+    description: Export a list of custom attributes including the name, description, data type, array length (if applicable), status, and associated tags.
+    tags:
+      - Custom Attributes
   - name: <a href='/docs/api/endpoints/export/custom_events/get_custom_events_analytics/'>/events/data_series</a>
     description: Retrieve a series of the number of occurrences of a custom event in your app over a designated time period.
     tags:
       - Custom Events
+  - name: <a href='/docs/api/endpoints/export/custom_events/get_custom_events_data/'>/events</a>
+    description: Export a list of custom events including the name, description, status, associated tags, and analytics report inclusion.
+    tags:
+      - Custom Events
   - name: <a href='/docs/api/endpoints/export/custom_events/get_custom_events/'>/events/list</a>
-    description: Export a list of custom events that have been recorded for your app.
+    description: Export a list of names of custom events that have been recorded for your app.
     tags:
       - Custom Events
   - name: <a href='/docs/api/endpoints/templates/content_blocks_templates/post_create_email_content_block/'>/content_blocks/create</a>

_docs/_user_guide/administrative/app_settings/tags.md

@@ -36,6 +36,14 @@ To filter by a tag, select the tag name from the list of tags or search for the
 You can add up to 175 tags to a campaign, Canvas, or segment.
 {% endalert %}
 
+## Custom data tags
+
+Tags may also be added to custom data when managing [custom attributes]({{site.baseurl}}/user_guide/data_and_analytics/custom_data/custom_attributes/#managing-custom-attributes) and [custom events]({{site.baseurl}}/user_guide/data_and_analytics/custom_data/custom_events/#managing-custom-events). 
+
+{% alert important %}
+This feature is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
+{% endalert %}
+
 ## Best practices {#tags-best-practices}
 
 Tags can be a useful organizational tool for keeping track of engagement tactics. You can link segments and campaigns to business objectives, funnel stages, and the like.

_docs/_user_guide/data_and_analytics/custom_data/custom_attributes.md

@@ -31,10 +31,18 @@ Custom attributes can be blocklisted individually via the actions menu, or up to
 
 Admins can also create custom attributes and mark them as PII from this page. These attributes will only be visible to admins and dashboard users with the “View Custom Attributes Marked as PII” permission.
 
-### Adding description
+### Adding descriptions
 
 You can add a description to a custom attribute after it's created if you have the `Manage Events, Attributes, Purchases` [user permission]({{site.baseurl}}/user_guide/administrative/app_settings/manage_your_braze_users/user_permissions/). Edit the custom attribute and input whatever you like, such as a note for your team.
 
+### Adding tags
+
+You can add tags to a custom attribute after it's created if you have the "Manage Events, Attributes, Purchases" [user permission]({{site.baseurl}}/user_guide/administrative/app_settings/manage_your_braze_users/user_permissions/). The tags can then be used to filter the list of attributes. 
+
+{% alert important %}
+This feature is currently in early access. Contact your customer success manager if you're interested in participating in this early access.
+{% endalert %}
+
 ### Removing custom attributes
 
 To remove custom attributes from user profiles, set the value to "null" in your API request to the [`/users/track` endpoint]({{site.baseurl}}/api/endpoints/user_data/post_user_track#user-track).
@@ -45,6 +53,14 @@ The usage report lists all the Canvases, campaigns, and segments using a specifi
 
 You can view up to 10 usage reports at a time by selecting the checkboxes next to the respective custom attributes and then selecting **View usage report**.
 
+### Exporting data
+
+To export the list of custom attributes as a CSV file, select **Export all** at the top of the page. The CSV file will be generated, and a download link will be emailed to you. 
+
+{% alert important %}
+This feature is currently available in early access. Contact your customer success manager if you're interested in participating in this early access.
+{% endalert %}
+
 ## Setting custom attributes
 
 The following lists methods across various platforms that are used to set custom attributes.

_docs/_user_guide/data_and_analytics/custom_data/custom_events.md

@@ -44,12 +44,20 @@ Custom events can be blocklisted individually via the actions menu, or up to 10
 
 You can add a description to a custom event after it's created if you have the `Manage Events, Attributes, Purchases` [user permission]({{site.baseurl}}/user_guide/administrative/app_settings/manage_your_braze_users/user_permissions/). Select **Edit description** for the custom event and input whatever you like, such as a note for your team.
 
+### Adding tags
+
+You can add tags to a custom event after it's created if you have the `Manage Events, Attributes, Purchases` [user permission]({{site.baseurl}}/user_guide/administrative/app_settings/manage_your_braze_users/user_permissions/). The tags can then be used to filter the list of events. (This feature is currently in early access. Contact your customer success manager if you're interested in participating in this early access.)
+
 #### Viewing usage reports
 
 The usage report lists all the Canvases, campaigns, and segments using a specific custom event. This list does not include uses of Liquid. 
 
 You can view up to 10 usage reports at a time by selecting the checkboxes next to the respective custom events and then selecting **View usage report**.
 
+### Exporting data ###
+
+To export the list of custom events as a CSV file, click the "Export all" button at the top of the page. The CSV file will be generated and a download link will be emailed to you. (This feature is currently available in early access. Contact your customer success manager if you're interested in participating in this early access.)
+
 ### Logging custom events
 
 Custom events require additional setup. The following lists the methods across various platforms that are used to log custom events. Within these pages, you will also be able to find documentation on how to add properties and quantities to your custom events.

_includes/rate_limits.md

@@ -72,15 +72,25 @@ For customers who onboarded with Braze on or after September 16, 2021, we apply
 {% elsif include.endpoint == "users merge" %}
 For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 20,000 requests per minute to this endpoint. This rate limit is shared with the `/users/delete`, `/users/alias/new`, `/users/identify`, and `/users/alias/update` endpoints, as documented in [API rate limits]({{site.baseurl}}/api/api_limits/).
 
+<!---/custom_attributes-->
+
+{% elsif include.endpoint == "custom_attributes" %}
+For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the `/events`, `/events/list`, and `/purchases/product_list` endpoints, as documented in [API rate limits]({{site.baseurl}}/api/api_limits/).
+
+<!---/events-->
+
+{% elsif include.endpoint == "events" %}
+For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the `/custom_attributes`, `/events/list`, and `/purchases/product_list` endpoints, as documented in [API rate limits]({{site.baseurl}}/api/api_limits/).
+
 <!---/events/list-->
 
 {% elsif include.endpoint == "events list" %}
-For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the `/purchases/product_list` endpoint, as documented in [API rate limits]({{site.baseurl}}/api/api_limits/).
+For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the `/custom_attributes`, `/events`, and `/purchases/product_list` endpoints, as documented in [API rate limits]({{site.baseurl}}/api/api_limits/).
 
 <!---/purchases/product_list-->
 
 {% elsif include.endpoint == "purchases product list" %}
-For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the `/events/list` endpoint, as documented in [API rate limits]({{site.baseurl}}/api/api_limits/).
+For customers who onboarded with Braze on or after September 16, 2021, we apply a shared rate limit of 1,000 requests per hour to this endpoint. This rate limit is shared with the `/custom_attributes`, `/events`, and `/events/list` endpoints, as documented in [API rate limits]({{site.baseurl}}/api/api_limits/).
 
 <!---/messages/send-->
 <!---/campaigns/trigger/send-->