Centre d'aide

Explorer notre base de connaissance
article

Exemple de requêtes à l'API REST et éléments de syntaxe.

1/ Exemples de requêtes.

Rappel : l'intégralité des ressources accessibles depuis l'API REST sont listées ici.

Obtenez le nombre de contacts pour mars 2017 pour le canal Chat :

https://ha.iadvize.com/api/2/statistic?filters[website_id]=XXXX&key=xxxxxxxxxxxx&filters[indicators]=contact_number&filters[from]=2017-03-01&filters[to]=2017-03-30&filters[channel]=chat

 

Obtenez le chiffre d’affaire associé à chaque transaction suite à un chat pour mars 2017 pour le canal Chat :

'https://ha.iadvize.com/api/2/transaction?filters[website_id]=XXXX&key=xxxxxxxxxxxx&filters[from]=2017-03-01&filters[to]=2017-03-30&filters[channel]=chat&filters[conversation_id]=!null

 

Obtenez le chiffre d'affaires généré après contact par jour pour le canal Chat sur le mois de Mars 2017 :

https://ha.iadvize.com/api/2/statistic?filters[website_id]=XXXX&key=xxxxxxxxxxxx&filters[from]=2017-03-01&filters[to]=2017-03-31&filters[granularity]=day&filters[indicators]=transaction_after_contact_amount&filters[channel]=chat

 

Trouver la correspondance entre l’ID et le nom de mes agents :

https://ha.iadvize.com/api/2/operator?filters[website_id]=XXXX&key=xxxxxxxxxxxx&filters[from]=2017-03-01&filters[to]=2017-03-31&full=true

 

Trouver la correspondance entre l’ID d’un type de conversation et son nom :

https://ha.iadvize.com/api/2/tag?filters[website_id]=XXXX&key=xxxxxxxxxx&filters[from]=2019-04-01&filters[to]=2019-04-15&full=true

 

Trouver les dates et horaires des créneaux de callmeeting ayant été réservés :

https://ha.iadvize.com/api/2/callmeeting?filters[website_id]=XXXX&filters[channel]=chat&filters[from]=2019-06-01&filters[to]=2019-06-15&key=xxxxxxxxxxxfull=true&limit=100&page=XX

 

2/ Elements de syntaxes utiles.

Afficher le maximum de détail dans les réponses.

Rajouter &full=true permet de déployer tous les enfants d’un objet parent et accéder ainsi au niveau maximum de détail.

 

Pagination.

Pour des raisons de performances, les résultats fournis par notre API sont paginés, cette pagination est détaillée à la fin de la réponse fournie par notre API.

   "pagination": {

       "page": 1,

       "pages": 4,

       "limit": 20,

       "count": 79

   }

  • "page":  numéro de la page de résultat affichée, si plusieurs pages il faudra donc faire autant de requêtes qu’il existe de pages en ajoutant en fin de requête &page=2, &page=3 etc...
  • "pages": nombre total de pages de résultats pour la requête formulée
  • "limit": nombre de résultats par page, cette limite est modifiable (maximum 100) en ajoutant par exemple &limit=50 dans vos filtres
  • "count": nombre total de d'occurrence de réponse à la requête envoyé.

Dans l’exemple nous avons 79 résultats qui se répartissent donc sur 4 pages contenant chacune 20 résultats au maximum (3 pages de 20 résultats et une page de 19 résultats précisément).

 

Filtrer les transactions pour n’obtenir que celles suivant un chat.

Le tag de transaction iAdvize remonte l’intégralité des transactions effectuées sur votre site. Pour n’obtenir des informations que sur celles suivant une conversation, vous devez rajouter un filtre s’assurant que les transactions affichées ont bien un conversation_id associé.

Pour cela vous devez ajouter à la fin de votre requête &filters[conversation_id]=!null (voir dans les exemples ci dessus celui concernant les transactions).

Commentaires