---
updatedAt: 2025-05-12T20:04:36.000Z
agentTools:
  projectIndex: https://feefo.readme.io/llms.txt
---

# Reviews Summary API Request

## Introduction

Here we'll take a closer look at the available parameters and values for the Review API endpoint that retrieves summary information such as counts and average scores (no detailed review content is included). The parameters for detailed content are listed.

There are four possible modes for this endpoint:

|                                                          |                                                                                                              |
| :------------------------------------------------------- | :----------------------------------------------------------------------------------------------------------- |
| <<https://api.feefo.com/api/20/reviews/summary/all>>     | Creates a summary for both your service and product reviews. Authentication is not required.                 |
| <<https://api.feefo.com/api/20/reviews/summary/service>> | Creates a summary of your service reviews. Authentication is not required.                                   |
| <<https://api.feefo.com/api/20/reviews/summary/product>> | Creates a summary of your product reviews. Authentication is not required.                                   |
| <<https://api.feefo.com/api/20/reviews/summary/nps>>     | Creates a summary of your NPS feedback. Authentication is required. See API Authentication for more details. |

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "reviews-summary",
    "version": "2.0"
  },
  "servers": [
    {
      "url": "https://api.feefo.com/api/20/reviews/summary/"
    }
  ],
  "components": {
    "securitySchemes": {
      "sec0": {
        "type": "oauth2",
        "flows": {}
      }
    }
  },
  "security": [
    {
      "sec0": []
    }
  ],
  "paths": {
    "/{mode_choice}": {
      "get": {
        "summary": "Reviews Summary API Request",
        "description": "",
        "operationId": "review-summary-api-request",
        "parameters": [
          {
            "name": "mode_choice",
            "in": "path",
            "schema": {
              "type": "string",
              "enum": [
                "service",
                "product",
                "nps",
                "all"
              ],
              "default": "all"
            },
            "required": true
          },
          {
            "name": "merchant_identifier",
            "in": "query",
            "description": "Unique identifier for the merchant account.",
            "schema": {
              "type": "string"
            }
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "tags": {
                    "type": "string",
                    "description": "Filter for reviews with corresponding tags."
                  },
                  "date_time": {
                    "type": "string",
                    "description": "Filter reviews to those created on a specified UTC date / time."
                  },
                  "updated_date_time": {
                    "type": "string",
                    "description": "Filter reviews to those updated on a specified UTC date / time."
                  },
                  "since_period": {
                    "type": "string",
                    "description": "Filter reviews to those created during the specified period.",
                    "default": "year",
                    "enum": [
                      "month",
                      "year",
                      "all"
                    ]
                  },
                  "since_updated_period": {
                    "type": "string",
                    "description": "Filter reviews to those updated during the specified period.",
                    "default": "year",
                    "enum": [
                      "month",
                      "year",
                      "all"
                    ]
                  },
                  "origin": {
                    "type": "string",
                    "description": "Defines the domain name of the web page calling the Reviews API feed."
                  },
                  "id": {
                    "type": "string",
                    "description": "Filter reviews based on the feedback id."
                  },
                  "parent_product_sku": {
                    "type": "string",
                    "description": "Filter for product reviews assigned to the specified parent product search code."
                  },
                  "moderation_status": {
                    "type": "string",
                    "description": "Filter reviews to include reviews in a status of moderation",
                    "default": "all",
                    "enum": [
                      "rejected",
                      "pending",
                      "published",
                      "all"
                    ]
                  },
                  "product_sku": {
                    "type": "string",
                    "description": "Filter for product reviews assigned to the specified product search code."
                  },
                  "customer_reference": {
                    "type": "string",
                    "description": "Filter for reviews from a specific customer based on a unique customer reference."
                  },
                  "customer_email": {
                    "type": "string",
                    "description": "Filter for reviews from a specific customer email."
                  },
                  "order_reference": {
                    "type": "string",
                    "description": "Retrieve the feedback relating to a specific order."
                  },
                  "rating": {
                    "type": "string",
                    "description": "Defines the number of stars or the NPS score that the reviews should have to be included in the feed."
                  },
                  "children": {
                    "type": "string",
                    "description": "Specified if feedback from child account should be included in the result set.",
                    "default": "include",
                    "enum": [
                      "include",
                      "exclude"
                    ]
                  },
                  "media": {
                    "type": "string",
                    "description": "Specifies filters applied to feedback with associated media.",
                    "default": "include",
                    "enum": [
                      "include",
                      "exclude",
                      "only",
                      "video",
                      "photo"
                    ]
                  },
                  "empty_product_comments": {
                    "type": "string",
                    "description": "Specifies how product reviews with no comments should be handled.",
                    "default": "include",
                    "enum": [
                      "include",
                      "exclude"
                    ]
                  },
                  "Unanswered_feedback": {
                    "type": "string",
                    "description": "Specifies the filter to be applied to unanswered feedback rated 1 or 2 stars during the first 48 hours.",
                    "default": "include",
                    "enum": [
                      "include",
                      "exclude",
                      "exclude_negative"
                    ]
                  },
                  "enhanced_insight": {
                    "type": "string",
                    "description": "Only functional if the account has Smart Themes enabled. Specifies if enhanced insight data should be included in the API response.",
                    "default": "exclude",
                    "enum": [
                      "include",
                      "exclude"
                    ]
                  },
                  "feature": {
                    "type": "string",
                    "description": "Only functional if the account has Smart Themes enabled and the API call includes the enhanced_insight parameter. Filter reviews to those that include the associated feature."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "100": {
            "description": "100",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": ""
                  }
                }
              }
            }
          },
          "200": {
            "description": "200",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": ""
                  }
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "text/plain": {
                "examples": {
                  "Result": {
                    "value": ""
                  }
                }
              }
            }
          }
        },
        "deprecated": false
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```