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 our support 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.

Managing your profiles

There is full support to list, add and remove profiles within your account via the API.

Please use the following endpoint for listing all profiles within your account. Here you can also obtain the profile ids necessary to fetch data later on.

For adding profiles, please specify the space id (which you'll get from our support team once access to our API is granted), and a unique URL for the profile to be added. Usually you will use the search endpoint described below to identify the unique URL of a profile.

To remove an existing profile from your account, just provide the space id and the profile id (which can be obtained via the list-profiles endpoint described above).

Usually before adding a new profile you will need to uniquely identify a profile. For this use case and also to search profiles via all the search endpoints of the networks itself, you can use the following endpoint for search.

Fetching data

Loading data is handled via the qql endpoint and the following parameters have to be provided. Please find further information on how to write QQL queries in our knowledge base.

  • qqlQuery: The QQL query describing the data to be loaded.
  • startTime: The beginning of the period you want to get the data for in format YYYY-MM-DD
  • endTime: The end of the period you want to get the data for in format YYYY-MM-DD
  • interval: The aggregation interval used for the analysis (daily, weekly, monthly, yearly, total)
  • timezone (optional): By default our API does fetch and aggregate data using the timezone setting of the admin user of your quintly account. Optionally you can set a specific timezone. The list of supported timezones can be found here. E.g. for fetching data in UTC timezone just use "UTC" here.
  • profileIds: A comma-separated list of profile ids (you can find the id of a profile by using the list-profiles endpoint described above). You can only fetch data for profiles added to your quintly account.

The following is an example for fetching the number of Page Likes for Facebook Pages

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

Authenticate profiles with Insights via quintly API

Please follow the documentation in our knowledge base

Error Handling

If something goes wrong, the HTTP status code returned will be unequal to 200, using 4xx for client-side errors, 5xx for server-side errors. Beside the status code the following JSON response will be sent. If success is equal to false you can always expect error and error->message to be set.

Rate limits

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