.. index:: User, UserReviews

.. _user_reviews:

User reviews
============

The user reviews entity returns user reviews. This includes reviews in our own system, or external providers. The type of review is indicated with the review. Reviews of external parties
like Tevreden.nl and Klantenvertellen.nl are only shown when the user has bought the
feature *Klantscore* . Information on buying features can be found at :ref:`buy-feature <buy_user_feature>`.


.. _user-review-fields:

Fields
------

.. apifields::
    .. apifield::
        :name: numberOfReviews
        :type: number (integer)
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The number of reviews for this user.
    .. apifield::
        :name: averageScore
        :type: number (float)
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The average score of the reviews.
    .. apifield::
        :name: averageSubScores
        :type: array(object)
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The subscores for the various parts on which a user can get individual scores.
    .. apifield::
        :name: averageSubScores.description
        :type: string
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The description of the subscore
    .. apifield::
        :name: averageSubScores.score
        :type: number (float)
        :constraints: -
        :required: false
        :updateable: false
        :writable: false
        :description: The score of an individual item on which the user get rated

Reference
---------

.. endpoint:: GET /v1/users/{userId}/reviews

Get user reviews


Examples
--------

.. include:: examples/get-user-reviews-example.rst