Evaluation détaillée d’une fiche

Cette méthode permet de récupérer l’évaluation détaillée d’une fiche. Une évaluation détaillée contient les champs nps, questions et criterias en plus d’une évaluation simplifiée.

Par défaut, l’API offre une réponse au format JSON. Pour bénéficier d’une réponse en XML, vous devez placer dans votre requête un header de type « Accept » avec la valeur « application/xml ».

GET https://api.monaviscompte.fr/detailed_ratings/:id?private_key=:private_key

 

Exemple : https://api.monaviscompte.fr/detailed_ratings/794173?private_key=efr9-kk7p-ah68-j9nw

nom requis type description
id oui int identifiant de la fiche
private_key oui string clé d’authentification privée
nom type description
grade float la note de la fiche entre 0 et 5
all_reviews_count int le nombre d’avis déposés sur la fiche
click_to_review string le lien (relatif) permettant le dépôt d’avis express depuis votre site, les réseaux sociaux, une campagne emailing.
nps int le net promoter score entre -100 et +100
criterias list questions du propriétaire de la fiche
questions list questions du questionnaire de la fiche

 

Les éléments Criteria sont composés des valeurs suivantes :

nom type description
id int identifiant unique de la question
title string titre de la question
grade float note de la fiche sur cette question entre 0 et 5
reviews_count int le nombre de réponse à cette question pour cette fiche

 

Les éléments Question sont composés des valeurs suivantes :

nom type description
id int identifiant unique de la question
title string titre de la question, peut être null pour les questions les plus anciennes
content string texte de la question
grade float note de la fiche sur cette question entre 0 et 5
code de retour raison
HTTP 200 succès
HTTP 401 authentification échouée
HTTP 404 la fiche n’existe pas
{
    "criterias": [
        {
            "id": 322,
            "title": "Nouvelle organisation du magasin",
            "grade": 4.4,
            "reviews_count": 72
        },
        {
            "id": 323,
            "title": "Offres de l'été",
            "grade": 3.7,
            "reviews_count": 71
        }
    ],
    "questions": [
        {
            "id": 322,
            "title": "Rapport qualité/prix",
            "content": "Le rapport qualité/prix",
            "grade": 4.4
        },
        {
            "id": 323,
            "title": "Accueil en magasin",
            "title": "L'accueil dans notre magasin",
            "grade": 3.7
        }
    ],
    "nps": 53,
    "grade": 3.9,
    "all_reviews_count": 329,
    "click_to_review": "depot-express-avis/a22k-hjq9-hkp5-32cb/1082"
}
<detailed_rating>
  <all_reviews_count>329</all_reviews_count>
  <click_to_review>depot-express-avis/a22k-hjq9-hkp5-32cb/1082</click_to_review>
  <grade>3.9</grade>
  <criterias>
    <criteria>
      <grade>4.4</grade>
      <id>322</id>
      <reviews_count>72</reviews_count>
      <title>Nouvelle organisation du magasin</title>
    </criteria>
    <criteria>
      <grade>3.7</grade>
      <id>323</id>
      <reviews_count>71</reviews_count>
      <title>Offres de l'été</title>
    </criteria>
  <criterias> 
  <questions>
    <question>
      <grade>4.4</grade>
      <id>322</id>
      <title>Rapport qualité/prix</title>
      <content>Le rapport qualité/prix</content>
    </question>
    <question>
      <grade>3.7</grade>
      <id>323</id>
      <title>Accueil en magasin</title>
      <content>L'accueil dans notre magasin</content>
    </question>
  <questions>
  <nps>53</nps>
</detailed_rating>