API documentation

Introduction

The quintly API is made for you to access all data points you already know from our tool. You need to have a quintly business account in order to access this API. Please get in touch with us if you like to get access.

Authentication

For authentication we use Basic Auth via HTTPS. For the username you have to send your quintly client id and for the password your API secret. If you don't have these details yet, please get in touch with our support.

Fetching data

The are two ways of fetching data. Either by asking for one of our predefined metrics, or by specifying a completely customized query by using QQL (Quintly Query Language).

For both ways you need to specify the following mandatory parameters:

In addition to this, you have to set the metric parameter to fetch a predefined metric (see the list of predefined metrics here) or the qqlQuery parameter to fetch data for a customized query written in QQL. At least one of those parameter has to be set.

Example requests

Fetching the predefined fanCount metric (total fan numbers)

Fetching data by using a custom query written in QQL to get the total fan numbers

Response format

The response will be sent in JSON format. Here is a sample response for the second example above:

If something goes wrong, errors will always be returned in the following structure:

Predefined metrics

Rate limits

So far rate limits have been set very loose and you should not hit any limits at all.