API Documentation

General Information

This documentation describes the RESTful web API exposed by the Facette back-end and used by the web front-end.

Unless otherwise stated, all requests and responses bodies use application/json as Content-Type. The format is described in the RFC 4627 document.

Dates and Times

The dates returned by the API are using the RFC 3399 timestamp format.

Some of the API calls can specify a range parameter accepting the format [-]<number>{y,mo,d,h,m,s}. For example, the last day can be expressed with the following expressions:

It is also possible to combine multiple units, such as -1h30m.

Filter Patterns

Some of the API calls can take a filter as optional parameter, those filters can be:

Message Responses

When the API is unable to handle the received request or if an error occurred during its processing, a JSON message response is sent along with an HTTP status code.

For example, if an unknown resource (e.g. origin, source…) is requested upon the API, with an HTTP status code being 404 Not Found, the response would look like:

{
   "message": "Unable to find requested resource"
}

Documents

Table of Contents