Skip to content

Commit 91d4964

Browse files
pwsegpwseg
authored
Merge pull request #7923 from segmentio/develop
Release 25.37.1
2 parents 7b192a8 + 07eb7fa commit 91d4964

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+787
-766
lines changed

‎src/api/config-api/index.md‎

Lines changed: 37 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -6,72 +6,63 @@ redirect_from:
66

77
{% include content/papi-ga.html %}
88

9-
The Config API enables you to programmatically manage Segment workspaces, sources, destinations and more. With the API you can:
9+
The Config API lets you programmatically manage Segment workspaces, sources, destinations, and more.
1010

11-
* List all your workspace Sources and Destinations to see how data flows through Segment
12-
* Create new Destinations - or delete them - with a few lines of code
13-
* Create new users and assign them to scoped roles
14-
* Configure, disable, or view Sources and manage connected Destinations
15-
* Get a complete view of all the Sources and Destinations available in Segment's catalog
16-
* Configure a Tracking Plan to see how data conforms to your expected schema
17-
* Query Event Delivery metrics to build custom dashboards and alerts to monitor delivery of your events to destinations
18-
* Filter entire events or individual fields from reaching specific destinations
11+
With the Config API, you can:
12+
13+
- List all your workspace sources and destinations to see how data flows through Segment.
14+
- Create new destinations - or delete them - with a few lines of code.
15+
- Create new users and assign them to scoped roles.
16+
- Configure, disable, or view sources and manage connected destinations.
17+
- Get a complete view of all the sources and destinations available in Segment's catalog.
18+
- Configure a Tracking Plan to see how data conforms to your expected schema.
19+
- Query Event Delivery metrics to build custom dashboards and alerts to monitor delivery of your events to destinations.
20+
- Filter entire events or individual fields from reaching specific destinations.
1921

2022
The Config API is a set of REST services under segmentapis.com:
2123

2224
| Service | Description |
2325
| --------------------------- | ------------------------------------------------------ |
24-
| [Access Tokens][1] | Manage access tokens |
25-
| [Source Catalog][2] | Get info about all event and cloud sources |
26-
| [Destination Catalog][3] | Get info about all destinations |
27-
| [Workspaces][4] | Get info about workspaces |
28-
| [Sources][5] | Manage workspace sources |
29-
| [Destinations][6] | Manage workspace destinations |
30-
| [Tracking Plans][7] | Manage workspace tracking plans |
31-
| [Event Delivery Metrics][8] | Get event delivery metrics for cloud-mode destinations |
32-
| [Destination Filters][9] | Manage destination filters |
33-
| [IAM][10] | Manage workspace users and roles |
34-
| [Functions][11] | Manage Functions |
35-
36-
[1]: https://reference.segmentapis.com/#cd642f96-0fca-42a1-a727-e16fd33c7e8f
37-
[2]: https://reference.segmentapis.com/#7a63ac88-43af-43db-a987-7ed7d677a8c8
38-
[3]: https://reference.segmentapis.com/#361ed478-5e53-4835-ab7e-7dbff736524f
39-
[4]: https://reference.segmentapis.com/#7ed2968b-c4a5-4cfb-b4bf-7d28c7b38bd2
40-
[5]: https://reference.segmentapis.com/#5a852761-54d5-46da-8437-6e14e63449f3
41-
[6]: https://reference.segmentapis.com/#39ce0439-0969-48c3-ba49-b22a46c41060
42-
[7]: https://reference.segmentapis.com/#c4647e3c-fe1b-4e2f-88b9-6634841eb4e5
43-
[8]: https://reference.segmentapis.com/#51d89077-efd7-429b-85d4-155ac2cd07aa
44-
[9]: https://reference.segmentapis.com/#6c12fbe8-9f84-4a6c-848e-76a2325cb3c5
45-
[10]: https://reference.segmentapis.com/?version=latest#c4b14304-9112-4803-aa26-c08678cbe26a
46-
[11]: https://reference.segmentapis.com/?version=latest#c0866f35-2f39-4dfd-9fd3-26a0003ae74c
47-
48-
To see all the API methods and models see the [Segment Config API Reference](https://reference.segmentapis.com/).
49-
50-
At this time there are no language-specific clients. However the [API Reference](https://reference.segmentapis.com/) also contains example code snippets for cURL, Go, Node, Python and more.
51-
52-
## Quick Start
53-
54-
You can interact with the API from the command line. First install the `curl` tool.
26+
| [Access Tokens](https://reference.segmentapis.com/#cd642f96-0fca-42a1-a727-e16fd33c7e8f){:target="_blank"} | Manage access tokens |
27+
| [Source Catalog](https://reference.segmentapis.com/#7a63ac88-43af-43db-a987-7ed7d677a8c8){:target="_blank"} | Get info about all event and cloud sources |
28+
| [Destination Catalog](https://reference.segmentapis.com/#361ed478-5e53-4835-ab7e-7dbff736524f){:target="_blank"} | Get info about all destinations |
29+
| [Workspaces](https://reference.segmentapis.com/#7ed2968b-c4a5-4cfb-b4bf-7d28c7b38bd2){:target="_blank"} | Get info about workspaces |
30+
| [Sources](https://reference.segmentapis.com/#5a852761-54d5-46da-8437-6e14e63449f3){:target="_blank"} | Manage workspace sources |
31+
| [Destinations](https://reference.segmentapis.com/#39ce0439-0969-48c3-ba49-b22a46c41060){:target="_blank"} | Manage workspace destinations |
32+
| [Tracking Plans](https://reference.segmentapis.com/#c4647e3c-fe1b-4e2f-88b9-6634841eb4e5){:target="_blank"} | Manage workspace tracking plans |
33+
| [Event Delivery Metrics](https://reference.segmentapis.com/#51d89077-efd7-429b-85d4-155ac2cd07aa){:target="_blank"} | Get event delivery metrics for cloud-mode destinations |
34+
| [Destination Filters](https://reference.segmentapis.com/#6c12fbe8-9f84-4a6c-848e-76a2325cb3c5){:target="_blank"} | Manage destination filters |
35+
| [IAM](https://reference.segmentapis.com/?version=latest#c4b14304-9112-4803-aa26-c08678cbe26a){:target="_blank"} | Manage workspace users and roles |
36+
| [Functions](https://reference.segmentapis.com/?version=latest#c0866f35-2f39-4dfd-9fd3-26a0003ae74c){:target="_blank"} | Manage Functions |
37+
38+
39+
To see all the API methods and models see the [Segment Config API Reference](https://reference.segmentapis.com/){:target="_blank"}.
40+
41+
At this time there are no language-specific clients. However the [API Reference](https://reference.segmentapis.com/){:target="_blank"} also contains example code snippets for cURL, Go, Node, Python, and more.
42+
43+
## Quick start
44+
45+
You can call the API from the command line. First, install `curl`:
5546

5647
```shell
5748
$ brew install curl
5849
```
5950

60-
### Access Tokens
51+
### Access tokens
6152

62-
You can use the Config API with an access token to programmatically access Segment resources that the token can access. Access tokens are created by workspace owners using the Access Management page, and can only access resources that the token has permission to.
53+
You can use the Config API with an access token to programmatically access Segment resources that the token can access. Access tokens are created by workspace owners using the **Access Management** page, and can only access resources that the token has permission to.
6354

6455
These are currently only suitable for first party, trusted applications, such as your personal local scripts and server side programs. Partners should not prompt Segment users for their username and password and save an access token as a way to delegate access. See the [Authentication](/docs/api/config-api/authentication/) doc for more information.
6556

6657
When you create an access token, you'll give it a description, a workspace, and determine whether it has workspace owner or member access.
6758

68-
> warning "Secret Token"
59+
> warning "Secret token"
6960
> You can not retrieve the plain-text `token` later, so you should save it in a secret manager. If you lose the `token` you can generate a new one.
7061
71-
> info
72-
> As of February 1, 2024, new Config API tokens cannot be created in the app as Segment moves toward exclusive support for the [Public API](/docs/api/public-api/). [Migrate your implementation to the Public API](https://docs.segmentapis.com/tag/Migration){:target="_blank”} to access the latest features and available endpoints. To create a new Config API token, reach out to [email protected] for support.
62+
> info ""
63+
> As of February 1, 2024, new Config API tokens cannot be created in the app as Segment moves toward exclusive support for the [Public API](/docs/api/public-api/). [Migrate your implementation to the Public API](https://docs.segmentapis.com/tag/Migration){:target="_blank”} to access the latest features and available endpoints. To create a new Config API token, [contact Segment](mailto:[email protected]) for support.
7364
74-
### API Requests
65+
### API requests
7566

7667
Now that you have an access token, you can use this token to access the rest of the Config API by setting it in the `Authorization` header of your requests, for example:
7768

‎src/connections/destinations/catalog/actions-batch/index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This destination is maintained by Batch. For any issues, [contact Batch Support]
1818
5. Paste the **Project Key** and **REST API Key** into the Batch destination settings in Segment.
1919
6. Toggle **Enable Destination**. Segment will start sending data to Batch according to your **Mappings**.
2020

21-
![Basic settings destination](./images/basic_settings_destination.png "Basic settings destination")
21+
![Screenshot of the Braze destination Basic Settings page in Segment app.](./images/basic_settings_destination.png "Basic settings destination")
2222

2323
{% include components/actions-fields.html %}
2424

@@ -100,9 +100,9 @@ To map additional traits into Batch profile attributes:
100100
1. Open your destination → **Mappings** → **Edit Mapping**.
101101
2. Go to **Profile attributes** → **Add Mapping Field**.
102102
3. Choose a **source** (for example, `traits.plan`) and set a **target** under `attributes` (for example, `attributes.plan`).
103-
![Attributes mapping](./images/attributes_mapping.png "Attributes mapping")
103+
![Screenshot of mappings setup screen in Segment app with example fields.](./images/attributes_mapping.png "Attributes mapping")
104104
4. In **Step 4 – Send test record**, you can test your mapping before saving.
105-
![Test record](./images/test_record.png "Test record")
105+
![Screenshot of Send test record screen.](./images/test_record.png "Test record")
106106
5. **Save** and enable the mapping.
107107

108108
> info "Supported types"
@@ -171,7 +171,7 @@ analytics.track("User Registered", {
171171

172172
Events are sent to Batch in near real time according to your destination mappings, and all event `properties` are included under `event.attributes`.
173173

174-
![Events mapping](./images/events_mapping.png "Events mapping")
174+
![Partial screenshot of event mappings settings in the Segment app.](./images/events_mapping.png "Events mapping")
175175

176176
## Validation checklist
177177

0 commit comments

Comments
 (0)