19 Sep 2017

OpenAPI and Transparent Process

At LaunchDarkly, we’ve put a bunch of time into making our console fast and usable, and we’re pretty proud of it.

However, we’re aware there are lots of reasons people would want to use an API to create and manage feature flags. Since we are using our API to drive the dashboard, it’s easy for us to keep everything in sync if we make changes to the API. And we wanted to make it easy for our customers to do the same.

We started out with ReadMe, which is an excellent industry standard. That let us get our documents published and dynamic. For further refinements, we went to Swagger/OpenAPI. We liked it because:

  • It’s a well-known and widely-used format
  • It allows us to generate usable code snippets and examples in many languages automatically
  • It’s easy to add context and documentation to as we go.
  • We can host it on readme.io or other places, depending on our traffic needs.

We created our REST specification using OpenAPI, and you can find our documents here: LaunchDarkly OpenAPI.

We’re still working on adding examples, descriptions, and context, but we think that the documentation is stronger and more usable already.

As always, if you have any comments, you can contact us here, or make comments directly in the repository.

29 Jun 2016

Launched: Event Stream API

One of LaunchDarkly’s core strengths is that the entire product is driven by a REST API.  This means that everything in the app can be accessed programmatically– including modifying feature flags, goals, accessing A/B test results, and more.

There was one notable exception to this— we did not provide a way for customers to access their raw analytics events. This can be a huge amount of data, so a normal queryable REST API is not the most reasonable solution.

Real-Time Event Stream API

To fill this gap, we have launched an event stream API that provides a real-time stream of raw analytics data.  These events include feature flag requests, analytics events, custom events, and more.

LaunchDarkly Event Stream API A/B Testing Analytics and Data

Benefits

Customers can harness the event stream API for their own internal analytics platforms or build custom integrations tailored to their specific needs.  You can then leverage user data to analyze metrics like conversions, revenue, and application performance.

Connecting to the stream

Accessing the API is simple. This is how to do it with curl:

Check out the documentation for more information.