Important Announcement on API Versioning

Richard Caudle | 6th November 2015

As the DataSift platform continues to develop so does inevitably our API. As we have a full roadmap of new products and features coming up this feels like a good time to clarify how we version our API and how you can best keep up with the changes.

You'll see below that we're planning to deprecate a couple of API versions over the coming months, so please take a moment to read about the changes.

Developer resources

We've created some new resources to help you stay up-to-date.


The first thing to do is make sure that you're subscribed to our announcements on our community site. Here we'll announce any changes to the API including new versions and endpoints, and notices of version deprecation.

API versioning & deprecation policy

The API Versioning & Deprecation Policy sets out when we will up the API version number and for how long we will support legacy API versions.

In essence we will up the API version when we introduce a breaking change and give you 3 months notice before we deprecate an API version, but read the policy for full details.

API changelog

The API Changelog summarizes each change to the API over time. For each version the changes are listed and you can click through to endpoint pages for full details.

Client libraries

The best way to keep your application up-to-date with API changes is to make use of our client libraries. We keep these libraries aligned with the latest changes and announce new releases on the announcements category of our community site.

All latest releases of our client libraries point to version 1.2 of the API.

Deprecation timeline

Due to the overhead of supporting multiple API versions we are planning to deprecate API versions as follows:

Version Path Deprecation Date Notes
(default) /{endpoint} 1st March 2016 If you do not specify a version in your path you will be using this API, which is an alias for v1.0.
v1.0 /v1/{endpoint} 1st April 2016 This version will soon be deprecated.
v1.1 /v1.1/{endpoint} 1st May 2016 This version will soon be deprecated.
v1.2 /v1.2/{endpoint} 1st March 2017 We recommend you move to version 1.3.
v1.3 /v1.3/{endpoint} -- not currently planned -- Recommended version

We're sorry for any inconvenience this may cause, but we believe that tightening up our API versions will help clear up any confusion in future and make your life easier in the long run!

Previous post: Validating Interaction Filters with Facebook Super Public Text Samples

Next post: Investigating Audience Snacking Habits with Facebook Topic Data