Analytics API

Rishabh edited this page Apr 8, 2015 · 6 revisions

The analytics API is the one stop shop for running all kinds of analytics on the data present in foxtrot. Currently supported analytic functions are:

All of these are run using the same endpoint. The system introspects the opcode field in the request body to determine which operation to run. This has been chosen so that it's easier to quickly expose more and more analytics functions to the end-user without having the need to change the API contract.

Endpoint: /foxtrot/v1/analytics

HTTP Method: POST

Content-type: application/json

Returns: HTTP 200/OK if the analytics ran successfully. HTTP 400/Bad request in-case a request constraint has not been met. HTTP 500/Server Error otherwise.

Check the pages linked above for request/response formats of individual analytic functions.