Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
105 commits
Select commit Hold shift + click to select a range
ed0472e
zigpoll source documentation
JasonZigelbaum Aug 27, 2025
8dcd25d
initial catches
pwseg Aug 28, 2025
e2fbcc2
more cleanup plus directional language
pwseg Aug 28, 2025
c814602
eliminate redundancy
pwseg Aug 28, 2025
a94e13f
Step 2 cleanup
pwseg Aug 28, 2025
0d9f291
a bunch more cleanup and simplification
pwseg Aug 28, 2025
90465bb
clean up Step 4
pwseg Aug 28, 2025
a343a08
final cleanup [netlify-build]
pwseg Aug 28, 2025
fd822ce
Audit edits [DOC-1212]
stayseesong Aug 28, 2025
7aabfc8
Alt text of images updated
sade-wusi Sep 3, 2025
4e00101
updates to ecommerce-v2
rchinn1 Sep 3, 2025
6269aa6
Build preview [netlify-build]
rchinn1 Sep 3, 2025
c7e388d
quick fixes
rchinn1 Sep 3, 2025
8b7587b
add Engage Premier EOL banner [netlify-build]
pwseg Sep 3, 2025
2cc34d4
Identity resolution page review
sade-wusi Sep 4, 2025
a9aa9f1
typo fix!
sade-wusi Sep 4, 2025
790facb
update retl usage documentation
gilsegment Sep 4, 2025
2e7d158
Update src/connections/reverse-etl/system.md
gilsegment Sep 4, 2025
68f3d11
Update src/connections/reverse-etl/system.md
gilsegment Sep 4, 2025
9c1d777
rm addtl references to "limits"
forstisabella Sep 5, 2025
8131c20
Merge pull request #7887 from segmentio/updateRetlUsage
gilsegment Sep 5, 2025
fa11ea7
edits to destination functions
rchinn1 Sep 5, 2025
16c3f22
Merge pull request #7875 from segmentio/ecommerce-v2-audit
rchinn1 Sep 5, 2025
24d04e7
edits to getting started
rchinn1 Sep 5, 2025
380df42
quick fix
rchinn1 Sep 5, 2025
4ff1a36
Functions overview review [DOC-1206]
sade-wusi Sep 5, 2025
be560bc
Journeys overview review [DOC-1207]
sade-wusi Sep 5, 2025
20e7878
edits to node.js
rchinn1 Sep 5, 2025
1702678
edits
stayseesong Sep 5, 2025
3d76f6c
Merge pull request #7891 from segmentio/what-is-segment-edits
rchinn1 Sep 5, 2025
66ed4f8
FAQ to FAQs
sade-wusi Sep 5, 2025
0b9ca56
[netlify-build]
sade-wusi Sep 5, 2025
7968df3
Merge pull request #7892 from segmentio/functions-audit
sade-wusi Sep 5, 2025
e945a7a
aria label for video [netlify-build]
sade-wusi Sep 5, 2025
a944ae1
initial edits to mobile and predictions
rchinn1 Sep 5, 2025
ae1fb9a
edits
stayseesong Sep 5, 2025
137f518
Predictions-edits
rchinn1 Sep 5, 2025
d215832
formatting fix
rchinn1 Sep 5, 2025
310c66a
edits
stayseesong Sep 5, 2025
5249045
Merge pull request #7894 from segmentio/analytics-for-node.js
rchinn1 Sep 5, 2025
13a1634
another batch of edits
rchinn1 Sep 5, 2025
54eef28
Custom Traits edit
sade-wusi Sep 8, 2025
1dfe3d2
Warehouses overview edit
sade-wusi Sep 8, 2025
d146948
Unify onboarding edits
sade-wusi Sep 8, 2025
9bbc54f
[netlify-build]
sade-wusi Sep 8, 2025
b0d3a0a
de-chunkifying the text [netlify-build]
sade-wusi Sep 8, 2025
415efab
mailing lists update
forstisabella Sep 8, 2025
2bbe922
Apply suggestions from code review
forstisabella Sep 8, 2025
44db471
Update src/connections/storage/warehouses/index.md
sade-wusi Sep 8, 2025
fa07eb0
typo oops
sade-wusi Sep 8, 2025
2e50e39
Merge pull request #7900 from segmentio/data-retention-policy
rchinn1 Sep 8, 2025
aebe491
Merge pull request #7907 from segmentio/doc-1233
forstisabella Sep 8, 2025
e6c6c09
edits to Segment Custom Domain
stayseesong Sep 8, 2025
7575855
Using Engage Data rewrite
forstisabella Sep 8, 2025
9cde989
Edits to profiles sync and more
rchinn1 Sep 8, 2025
1675cb1
Linked Events refresh
forstisabella Sep 8, 2025
623a671
Linked Audiences reivew
forstisabella Sep 8, 2025
ebfcc60
config-api edits
rchinn1 Sep 8, 2025
6fe8287
edits to Consent Management
stayseesong Sep 8, 2025
69ebd8d
Update typewriter.md
forstisabella Sep 8, 2025
f239f9c
Update src/privacy/consent-management/configure-consent-management.md
stayseesong Sep 8, 2025
739c777
Merge pull request #7860 from segmentio/DOC-1212
stayseesong Sep 8, 2025
44cc7f2
Merge pull request #7895 from segmentio/DOC-1224
stayseesong Sep 8, 2025
91f5758
Merge pull request #7896 from segmentio/DOC-1214
stayseesong Sep 8, 2025
1b9bdee
Merge pull request #7899 from segmentio/DOC-1218
stayseesong Sep 8, 2025
db1a89b
Merge pull request #7910 from segmentio/DOC-1221
stayseesong Sep 8, 2025
23ac62d
Merge pull request #7914 from segmentio/DOC-1222
stayseesong Sep 8, 2025
ebe0fcb
Merge pull request #7905 from segmentio/warehouses-cleanup
sade-wusi Sep 8, 2025
e658548
sentence casing
sade-wusi Sep 8, 2025
d69b555
casing
sade-wusi Sep 8, 2025
05fa364
word change + casing
sade-wusi Sep 8, 2025
ea93e0b
Apply suggestions from code review
rchinn1 Sep 9, 2025
c22542e
Merge pull request #7906 from segmentio/unify-quickstart
sade-wusi Sep 9, 2025
a274a0c
Merge pull request #7911 from segmentio/DOC-1189
forstisabella Sep 9, 2025
550c887
Merge pull request #7912 from segmentio/DOC-1188
forstisabella Sep 9, 2025
5d8a70a
Merge pull request #7848 from JasonZigelbaum/zigpoll/source
forstisabella Sep 9, 2025
476c3ff
Merge pull request #7919 from segmentio/master
forstisabella Sep 9, 2025
43a82b7
Merge pull request #7915 from segmentio/config-api
rchinn1 Sep 9, 2025
eccf20b
Merge pull request #7913 from segmentio/profiles-sync-audit
rchinn1 Sep 9, 2025
e85e54e
initial edits to testing and debugging
rchinn1 Sep 9, 2025
69fe19f
preview [netlify-build]
rchinn1 Sep 9, 2025
9c45503
more edits
rchinn1 Sep 9, 2025
52f66a5
quick fix
rchinn1 Sep 9, 2025
6b860e2
Merge pull request #7876 from segmentio/engage-premier-eol
pwseg Sep 9, 2025
cb545a0
initial cleanup
pwseg Sep 9, 2025
c018df0
some more changes
pwseg Sep 9, 2025
f05d85f
Apply suggestions from code review
rchinn1 Sep 9, 2025
abef42d
Merge pull request #7890 from segmentio/destination-functions
rchinn1 Sep 9, 2025
1a2869d
link fixes etc
pwseg Sep 9, 2025
561d0ba
even more
pwseg Sep 9, 2025
b5d9cc6
the end is in sight
pwseg Sep 9, 2025
c2a3e94
last cleanup
pwseg Sep 9, 2025
2c846b0
Merge pull request #7921 from segmentio/testing-and-debugging
rchinn1 Sep 9, 2025
2a603fa
Apply suggestions from code review
forstisabella Sep 9, 2025
074d8e4
Merge pull request #7922 from segmentio/filtering-data-audit-updates
pwseg Sep 9, 2025
cec5b3e
Update src/unify/profiles-sync/profiles-sync-setup/index.md
pwseg Sep 9, 2025
9d0bf52
Update src/unify/profiles-sync/profiles-sync-setup/index.md
pwseg Sep 9, 2025
4de90b9
oops
pwseg Sep 9, 2025
d1e8244
Merge pull request #7904 from segmentio/custom-traits-overview-review
pwseg Sep 9, 2025
4cf1bd7
Merge pull request #7852 from segmentio/profiles-sync-setup-content-a…
pwseg Sep 9, 2025
ab6c256
Merge pull request #7916 from segmentio/DOC-1192
forstisabella Sep 9, 2025
6f9923d
Merge pull request #7897 from segmentio/Predictions-edits-
rchinn1 Sep 9, 2025
90758e2
Merge pull request #7893 from segmentio/journeys-audit
pwseg Sep 9, 2025
d13796b
Merge pull request #7877 from segmentio/Id-resolution-audit
pwseg Sep 9, 2025
07eb7fa
Merge pull request #7871 from segmentio/batch-alt-text-fix
sade-wusi Sep 9, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 37 additions & 46 deletions src/api/config-api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,72 +6,63 @@ redirect_from:

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

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

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

- List all your workspace sources and destinations to see how data flows through Segment.
- Create new destinations - or delete them - with a few lines of code.
- Create new users and assign them to scoped roles.
- Configure, disable, or view sources and manage connected destinations.
- Get a complete view of all the sources and destinations available in Segment's catalog.
- Configure a Tracking Plan to see how data conforms to your expected schema.
- Query Event Delivery metrics to build custom dashboards and alerts to monitor delivery of your events to destinations.
- Filter entire events or individual fields from reaching specific destinations.

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

| Service | Description |
| --------------------------- | ------------------------------------------------------ |
| [Access Tokens][1] | Manage access tokens |
| [Source Catalog][2] | Get info about all event and cloud sources |
| [Destination Catalog][3] | Get info about all destinations |
| [Workspaces][4] | Get info about workspaces |
| [Sources][5] | Manage workspace sources |
| [Destinations][6] | Manage workspace destinations |
| [Tracking Plans][7] | Manage workspace tracking plans |
| [Event Delivery Metrics][8] | Get event delivery metrics for cloud-mode destinations |
| [Destination Filters][9] | Manage destination filters |
| [IAM][10] | Manage workspace users and roles |
| [Functions][11] | Manage Functions |

[1]: https://reference.segmentapis.com/#cd642f96-0fca-42a1-a727-e16fd33c7e8f
[2]: https://reference.segmentapis.com/#7a63ac88-43af-43db-a987-7ed7d677a8c8
[3]: https://reference.segmentapis.com/#361ed478-5e53-4835-ab7e-7dbff736524f
[4]: https://reference.segmentapis.com/#7ed2968b-c4a5-4cfb-b4bf-7d28c7b38bd2
[5]: https://reference.segmentapis.com/#5a852761-54d5-46da-8437-6e14e63449f3
[6]: https://reference.segmentapis.com/#39ce0439-0969-48c3-ba49-b22a46c41060
[7]: https://reference.segmentapis.com/#c4647e3c-fe1b-4e2f-88b9-6634841eb4e5
[8]: https://reference.segmentapis.com/#51d89077-efd7-429b-85d4-155ac2cd07aa
[9]: https://reference.segmentapis.com/#6c12fbe8-9f84-4a6c-848e-76a2325cb3c5
[10]: https://reference.segmentapis.com/?version=latest#c4b14304-9112-4803-aa26-c08678cbe26a
[11]: https://reference.segmentapis.com/?version=latest#c0866f35-2f39-4dfd-9fd3-26a0003ae74c

To see all the API methods and models see the [Segment Config API Reference](https://reference.segmentapis.com/).

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.

## Quick Start

You can interact with the API from the command line. First install the `curl` tool.
| [Access Tokens](https://reference.segmentapis.com/#cd642f96-0fca-42a1-a727-e16fd33c7e8f){:target="_blank"} | Manage access tokens |
| [Source Catalog](https://reference.segmentapis.com/#7a63ac88-43af-43db-a987-7ed7d677a8c8){:target="_blank"} | Get info about all event and cloud sources |
| [Destination Catalog](https://reference.segmentapis.com/#361ed478-5e53-4835-ab7e-7dbff736524f){:target="_blank"} | Get info about all destinations |
| [Workspaces](https://reference.segmentapis.com/#7ed2968b-c4a5-4cfb-b4bf-7d28c7b38bd2){:target="_blank"} | Get info about workspaces |
| [Sources](https://reference.segmentapis.com/#5a852761-54d5-46da-8437-6e14e63449f3){:target="_blank"} | Manage workspace sources |
| [Destinations](https://reference.segmentapis.com/#39ce0439-0969-48c3-ba49-b22a46c41060){:target="_blank"} | Manage workspace destinations |
| [Tracking Plans](https://reference.segmentapis.com/#c4647e3c-fe1b-4e2f-88b9-6634841eb4e5){:target="_blank"} | Manage workspace tracking plans |
| [Event Delivery Metrics](https://reference.segmentapis.com/#51d89077-efd7-429b-85d4-155ac2cd07aa){:target="_blank"} | Get event delivery metrics for cloud-mode destinations |
| [Destination Filters](https://reference.segmentapis.com/#6c12fbe8-9f84-4a6c-848e-76a2325cb3c5){:target="_blank"} | Manage destination filters |
| [IAM](https://reference.segmentapis.com/?version=latest#c4b14304-9112-4803-aa26-c08678cbe26a){:target="_blank"} | Manage workspace users and roles |
| [Functions](https://reference.segmentapis.com/?version=latest#c0866f35-2f39-4dfd-9fd3-26a0003ae74c){:target="_blank"} | Manage Functions |


To see all the API methods and models see the [Segment Config API Reference](https://reference.segmentapis.com/){:target="_blank"}.

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.

## Quick start

You can call the API from the command line. First, install `curl`:

```shell
$ brew install curl
```

### Access Tokens
### Access tokens

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.
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.

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.

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

> warning "Secret Token"
> warning "Secret token"
> 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.

> info
> 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.
> info ""
> 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.

### API Requests
### API requests

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:

Expand Down
8 changes: 4 additions & 4 deletions src/connections/destinations/catalog/actions-batch/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ This destination is maintained by Batch. For any issues, [contact Batch Support]
5. Paste the **Project Key** and **REST API Key** into the Batch destination settings in Segment.
6. Toggle **Enable Destination**. Segment will start sending data to Batch according to your **Mappings**.

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

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

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

> info "Supported types"
Expand Down Expand Up @@ -171,7 +171,7 @@ analytics.track("User Registered", {

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

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

## Validation checklist

Expand Down
Loading