Birdeye · Schema

Get Reviews Request

Reputation ManagementReviewsCustomer ExperienceSurveysMessagingMulti-LocationAI

Properties

Name Type Description
fromDate string
toDate string
fromTimestamp number
toTimestamp number
updateFromDate string
updateToDate string
sources string
ratings array
searchStr string
subBusinessIds array
statuses array
allChild boolean
tags array
fetchExtraParams boolean
needCustomerInfo boolean
fetchAssitedByDetails boolean
View JSON Schema on GitHub

JSON Schema

get-reviews-request.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/birdeye/refs/heads/main/json-schema/get-reviews-request.json",
  "title": "Get Reviews Request",
  "type": "object",
  "properties": {
    "fromDate": {
      "type": "string"
    },
    "toDate": {
      "type": "string"
    },
    "fromTimestamp": {
      "type": "number"
    },
    "toTimestamp": {
      "type": "number"
    },
    "updateFromDate": {
      "type": "string"
    },
    "updateToDate": {
      "type": "string"
    },
    "sources": {
      "type": "string"
    },
    "ratings": {
      "type": "array"
    },
    "searchStr": {
      "type": "string"
    },
    "subBusinessIds": {
      "type": "array"
    },
    "statuses": {
      "type": "array"
    },
    "allChild": {
      "type": "boolean"
    },
    "tags": {
      "type": "array"
    },
    "fetchExtraParams": {
      "type": "boolean"
    },
    "needCustomerInfo": {
      "type": "boolean"
    },
    "fetchAssitedByDetails": {
      "type": "boolean"
    }
  }
}