Public API
The Segment Public API helps you manage your Segment workspaces and its resources. You can use the API to perform CRUD (create, read, update, and delete) operations at no extra charge. This includes working with resources such as Sources, Destinations, Warehouses, Tracking Plans, and the Segment Destinations and Sources Catalogs. The Public API is available to Team and Business Tier customers.
All CRUD endpoints in the API follow REST conventions and use standard HTTP methods. Different URL endpoints represent different resources in a workspace.
Getting started with the Public API
If your application is built in JavaScript, Typescript, Go, Java, Swift, or C#, check out Segment's Public API SDKs.
The Public API includes the following benefits over the Config API:
| Benefit | Details | |
|---|---|---|
| Future Enhancements | Future improvements will be added to the Public API only. | |
| Improved error handling | The Public API offers more specific error messages, for faster issue resolution. | |
| Versioning | Each endpoint on the Public API can have multiple versions. Stable versions can coexist with beta or alpha versions. | |
| Higher rate limits | The Public API can offer higher rate limits when needed or different rate limits per endpoint or token. | |
| Improved architecture | The Public API is built with improved security, checks for authentication, authorization, input validation, HTTPS exposed services, auto-scaling, and more in mind. | |
| Cleaner mapping | The Public API uses unique IDs for reference, in place of slugs in the Config API. Unique IDs are, by design, unique. | |
| Available in Europe | The Public API is accessible to both US and EU-based workspaces. | |
| Increased reliability | The Public API features more stable endpoints, and a 99.8% success rate. |
Only Workspace Owners can create a Public API token
Only users with the Workspace Owner role can create a Public API token. For more information about roles, see Segment's Roles documentation.
To create a Public API token in your Segment workspace:
- Navigate to Settings > Workspace settings > Access Management > Tokens.
- Click + Create Token.
- Create a description for the token and assign it either Workspace Owner or Workspace Member access.
- Click Create.
- Copy your workspace token somewhere secure and click Done.
To begin sending requests to the Public API, include the Public API Token in your HTTP requests. Configure the Authorization Header as a Bearer Token with the value of the newly generated Public API token.
To enhance API token security, Segment partners with GitHub to prevent fraudulent use of exposed API tokens found in public git repositories. This helps to prevent malicious actors from using exposed tokens to perform unauthorized actions in your Segment workspace.
Within seconds, GitHub scans each commit in public repositories for Public API tokens, and sends detected tokens to Segment. Valid tokens are automatically revoked and workspace owners are notified.
Learn more about GitHub's secret scanning program.
In most cases, identifying and revoking an exposed token takes seconds. We recommend that you check the audit trail to ensure no unauthorized actions were taken with the token.
Developers can accidentally commit tokens to public repositories, exposing them to the public. This can happen when developers use a token in a local development environment and forget to remove it before committing their code.
By automatically revoking the exposed token, Segment helps keep your workspace secure and prevents potential abuse of the token.
This feature is automatically enabled for all workspaces on Team or Business tier plans.
If you see a CORS error, this means you're attempting to make a request to the Public API on the front-end. The Public API is used for server-side only. To get rid of the error, move all Public API requests to a server.
Only users that have a Workspace Owner role can create Public API Tokens.
When you don't have a source to forward violations or blocked events to, then exclude the fields forwardingViolationsTo or forwardingBlockedEventsTo entirely from the request and the setting will be disabled.
PATCH endpoint : https://api.segmentapis.com/sources/{sourceId}/settings
1{2"group": {3"allowTraitsOnViolations": false,4"allowUnplannedTraits": false,5"commonEventOnViolations": "ALLOW"6},7"identify": {8"allowTraitsOnViolations": true,9"allowUnplannedTraits": true,10"commonEventOnViolations": "Block"11},12"track": {13"allowEventOnViolations": false,14"allowPropertiesOnViolations": false,15"allowUnplannedEventProperties": false,16"allowUnplannedEvents": false,17"commonEventOnViolations": "OMIT_PROPERTIES"18}19}
The destination's Instance ID is specific to a single destination within your workspace. The destination's Meta ID, which is returned by the delivery metrics endpoint, identifies which integration you've set up. For example, if you had a dev Mixpanel (Actions) destination and a prod Mixpanel (Actions) destination, they would have the same Meta ID but two different Instance IDs.