Help Center

Explore our knowledge base

REST API results processing

The exploitation and post-processing of REST API responses.

1/ Convert to CSV format

The results provided by the REST API are returned into JSON format.

It is sometimes easier to reprocess the data in another format such as the CSV format for example.

There are many online converters and free software that allow you to convert the JSON format to CSV format.


2/ Cross-reference data from separate queries

You will sometimes need to cross-reference information and, therefore, make several queries and consolidate them using a B.I. or spreadsheet tool.

You can refer to the following diagram to understand how the common elements gather your results.


3/ An example of data cross-checking

For the period from 12/02/2018 at 9 am to 13/02/2018 at 9 am you would like to know :

The number of contacts, satisfaction and conversion rate, all sorted by targeting rule.



1st query : get the information grouped by rule_ID[website_id]=XXXX&key=xxxxxxxxxxxxxxxx&filters[channel]=chat&filters[resource]=rule&full=true&filters[indicators]=contact_number,satisfaction_global_rate,conversion_rate&filters[from]=2019-02-12 09:00:00&filters[to]=2019-03-12 09:00:00

Response to the first query :



2nd query : get the information for each rule_ID including the rule's name[website_id]=XXXX&key=xxxxxxxxxxxxxxxx&filters[channel]=chat&filters[resource]=rule&filters[indicators]=contact_number,satisfaction_global_rate,conversion_rate&filters[from]=2019-02-12 09:00:00&filters[to]=2019-03-12 09:00:00&full=true

Response to the second query :



Thanks to your queries, you got the following information :

  • The 237735 ID rule generated 1,001 contacts (response to your first query)
  • The 237735 ID rule is named "Product sheet - BFL - Desktop" (answer to your second query)

Now, you can use your business intelligence tool (e.g. Microsoft power BI, Tableau server, Excel) to cross-reference the information using the rule's ID as a common identifier.

Once cross-references are made, you can say that the "Product sheet - BFL - Desktop" generated 1,001 contacts.