Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"mode": {
"enum": [
"all",
"service",
"product",
"nps"
],
"type": "string",
"default": "all"
},
"page": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "Page number (default 1)"
},
"tags": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Sales tag filter (comma-separated)"
},
"media": {
"enum": [
"include",
"exclude",
"only",
"video",
"photo"
],
"type": "string",
"description": "Photo/video reviews filter"
},
"origin": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Origin/domain (needed when several domains share the feed)"
},
"rating": {
"type": "integer",
"maximum": 10,
"minimum": 0,
"description": "Only reviews with this rating: 1-5 stars; for mode=nps the 0-10 score"
},
"page_size": {
"type": "integer",
"maximum": 100,
"minimum": 1,
"description": "Reviews per page (default 20, max 100)"
},
"full_thread": {
"type": "boolean",
"description": "Include the full exchange (replies, rating changes) on each review"
},
"product_sku": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Product SKU (required for mode=product unless parent_product_sku is set). Comma-separated list allowed."
},
"since_period": {
"enum": [
"month",
"year",
"all"
],
"type": "string",
"description": "Reviews created within this period (Feefo default: year). Use 'all' for the whole history."
},
"order_reference": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only the review(s) for this order reference (needs the App Key)"
},
"enhanced_insight": {
"type": "boolean",
"description": "Include sentiment features/snippets (needs Smart Themes)"
},
"customer_reference": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Only reviews for this customer reference (needs the App Key)"
},
"parent_product_sku": {
"type": "string",
"maxLength": 200,
"minLength": 1,
"description": "Parent product SKU (all its variants)"
},
"unanswered_feedback": {
"enum": [
"include",
"exclude",
"exclude_negative"
],
"type": "string",
"description": "Whether unanswered low-rated feedback from the last 48 hours is included (Feefo default: include)"
},
"since_updated_period": {
"enum": [
"month",
"year",
"all"
],
"type": "string",
"description": "Reviews updated within this period"
},
"empty_product_comments": {
"enum": [
"include",
"default",
"exclude"
],
"type": "string",
"description": "Whether product reviews with no text comment are included"
}
}
}