16 November: Feedback scoring overhaul in the API

We’ve revised how feedback scores are calculated in the Insights API

Breaking: changing feedback score computation logic

We’ve changed the way we compute the feedback score based on user ratings which is affecting the following endpoint: /v1/spaces/:id/insights/content

  • [Updated] score is now calculated this wayscore=positives0.5intermediates2negativesscore = positives - 0.5 * intermediates - 2*negatives. This is done to reinforce negative ratings and help surfacing content that may require updates.

  • [Updated] rating is now computed this way

    • 'good' whenever the score is > 0

    • 'ok' whenever the score is 0

    • 'bad' whenever the score is < 0

  • [Added] ponderedScore is computed by multiplying the score by the total amount of ratings given by visitors.

Note: The GitBook app is displaying ponderedScore inside of the Insights section.

Last updated

Was this helpful?