Like what you see? Have a play with our trial version.

Overview

When new functionality is added to the Javascript API, the version number will be increased. Clients can include a version number in an API request. As long as the server supports the requested version, it will return a response that the client can understand.

Minor version changes are intended to be backwards compatible, and the server may respond with a later version than the client requests. For example, if the client requests version 2.0, the server may send a response with the version set to 2.1.

Any major API changes will be reflected by a major version number change. The server will always send back a response using the same major version number that the client requested. If the server cannot sent a response using the same major version number, an error will be returned.

Version

Description

1.0

Initial Release of the Javascript API. Includes support for unsecure reports only, with no user authentication.
Released with Yellowfin 5.1, December 2010.
Supported in Yellowfin versions 5.1 and 5.2.

1.1

Update to include user authentication.
Released with Yellowfin 5.1, April 2011.
Supported in Yellowfin versions 5.1 and 5.2.

2.0

Major updates to the Javascript API. Includes support for embedding dashboards, enhanced filtering on reports and dashboards, and a lot of usability and UI enhancements.
Released with Yellowfin 6, December 2011.

2.1

Update to support loading reports and filters by universal identifiers.
Users can be authenticated using a web services login token.
Backwards compatible with version 2.0.
Released with Yellowfin 6.1, May 2012.