This section details Split's admin API. The Split API uses resource-oriented URLs, uses status codes to indicate the success or failure of requests and returns JSON from all requests. You can use the Split API to push data into Split, get data out of Split, build custom integrations, or integrate Split with the tools your team uses.
If you're just getting started with Split, we encourage your to read our main documentation site. You'll learn how to set up our SDKs and release a feature without re-deploying your application.
All requests to Split's API must be authenticated by requiring an API key.
An Authorization header must be added containing your API for the request.
To access the Split API, you must create a key with type admin. The admin key type provides private and universal access to current and future admin APIs. Creating an API key is simple and can be done in the APIs section of settings.
Authorization: Bearer ADMIN_API_KEY
Learn more about API keys
To best familiarize yourself with using API keys in Split, visit our main documentation for more details.
Split allows you to segment your customer base and use these segments in your release process.
Segments are groups of customers that can be used in feature splits. When viewing a particular segment, you can easily add, remove, or import customers via CSV or via API.
As you think about feature releases it’s good to take a step back and acknowledge all of the things that segmentation helps you do better. Your segments should be used to:
- Ensure quality testing. (Example: you may want to release to your internal or outsourced QA team - create segment
- Target employees for internal testing. (Example: you may want to release to your entire company to test the feature or gather feedback - create segment
- Plan your release strategy. (Example: you may want to release to a group of customers who have expressed interest in a particular feature - create segment
These are just a few examples that engineering and product development teams should think about. There are a lot more ways that you can apply segmentation to drive better results and ensure a successful and safe release.
Learn more about segments
To best familiarize yourself with using Segments in your deployment and rollout strategy, visit our main documentation for more details.
Split lets you take a feature to production, but be targeted about which of your customers are exposed to that feature. Split lets you be as granular in your targeting as you want: you can target individual, segments or percentages of customers. This granular targeting is achieved by creating a 'Split' in the web console.
Learn more about Splits
To best familiarize yourself with using Splits in your deployment and rollout strategy, visit our main documentation for more details.