ProductReviewSearchResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/gtm/main/json-schema/gtm-product-review-search-response-schema.json",
  "title": "ProductReviewSearchResponse",
  "description": "Search response body for ProductReview.",
  "x-generated": "2026-10-20",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/gtm-vertical-datasets-api-v1-api-openapi.yml#/components/schemas/ProductReviewSearchResponse",
  "type": "object",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "$ref": "#/$defs/ProductReview"
      },
      "description": "The primary data of the document"
    },
    "meta": {
      "allOf": [
        {
          "$ref": "#/$defs/ResultMeta"
        }
      ],
      "description": "Non-standard meta information about the document"
    },
    "links": {
      "allOf": [
        {
          "$ref": "#/$defs/Links"
        }
      ],
      "description": "Links related to the primary data"
    }
  },
  "$defs": {
    "Links": {
      "type": "object",
      "properties": {
        "first": {
          "type": "string",
          "format": "uri",
          "description": "A link to the first page of data"
        },
        "last": {
          "type": "string",
          "format": "uri",
          "description": "A link to the last page of data"
        },
        "prev": {
          "type": "string",
          "format": "uri",
          "description": "A link to the previous page of data"
        },
        "next": {
          "type": "string",
          "format": "uri",
          "description": "A link to the next page of data"
        }
      },
      "description": "Helpful links for fetching different pages of data from the current result set."
    },
    "Page": {
      "type": "object",
      "required": [
        "total",
        "number"
      ],
      "properties": {
        "total": {
          "type": "integer",
          "format": "uint32",
          "description": "The total number of pages within the current result set"
        },
        "number": {
          "type": "integer",
          "format": "uint32",
          "description": "The current page number of the results"
        }
      },
      "description": "Meta information related to the current page and total number of pages"
    },
    "ProductReview": {
      "type": "object",
      "required": [
        "id",
        "type",
        "attributes"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for the resource"
        },
        "type": {
          "type": "string",
          "description": "The type of the resource",
          "default": "ProductReview",
          "pattern": "ProductReview"
        },
        "attributes": {
          "allOf": [
            {
              "$ref": "#/$defs/ProductReviewSearchResponseAttributes"
            }
          ],
          "description": "The attributes defining the resource"
        }
      },
      "description": "ProductReview record resource."
    },
    "ProductReviewSearchResponseAttributes": {
      "type": "object",
      "properties": {
        "reviewedZiCompany": {
          "allOf": [
            {
              "$ref": "#/$defs/ZiCompanySearch"
            }
          ],
          "description": "Compact ZiCompany details returned with the record when available."
        },
        "reviewerZiPersonId": {
          "type": "integer",
          "format": "int64",
          "description": "ZI Person ID of the Reviewer."
        },
        "reviewerZiCompany": {
          "allOf": [
            {
              "$ref": "#/$defs/ZiCompanySearch"
            }
          ],
          "description": "Compact ZiCompany details returned with the record when available."
        },
        "productId": {
          "type": "string",
          "description": "A unique identifier for the product being reviewed."
        },
        "answers": {
          "type": "integer",
          "format": "int64",
          "description": "The total number of responses provided in a product review."
        },
        "avgRating": {
          "type": "number",
          "format": "double",
          "description": "The overall numerical rating given by users, calculated as an average across all reviews."
        },
        "avgStarRating": {
          "type": "number",
          "format": "double",
          "description": "The average rating displayed in a 5-star format."
        },
        "benefits": {
          "type": "string",
          "description": "A summary of the most valuable aspects of the product, as described by users."
        },
        "benefitsText": {
          "type": "string",
          "description": "The survey question asking users what business problems the product helps solve."
        },
        "categories": {
          "type": "string",
          "description": "A numeric identifier for the product's category."
        },
        "hasComment": {
          "type": "boolean",
          "description": "Indicates whether a review includes a written comment."
        },
        "country": {
          "type": "string",
          "description": "The country where the reviewer is located."
        },
        "sourceCreatedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the review was submitted in the source system."
        },
        "defaultSortOrder": {
          "type": "number",
          "format": "double",
          "description": "The ranking score used to order reviews by default."
        },
        "productUrl": {
          "type": "string",
          "description": "The web link to the product's page on the review site."
        },
        "writeReviewUrl": {
          "type": "string",
          "description": "The web link for users to submit a review for the product."
        },
        "downsides": {
          "type": "string",
          "description": "A description of what users find least helpful about the product."
        },
        "downsidesText": {
          "type": "string",
          "description": "The survey question asking users about the product's drawbacks."
        },
        "isIncentivized": {
          "type": "boolean",
          "description": "Indicates whether the review was written in exchange for an incentive."
        },
        "isPublic": {
          "type": "boolean",
          "description": "Indicates whether the review is visible to the public."
        },
        "upsides": {
          "type": "string",
          "description": "A description of what users find most helpful about the product."
        },
        "upsidesText": {
          "type": "string",
          "description": "The survey question asking users about the product's advantages."
        },
        "hasOfficialResponse": {
          "type": "boolean",
          "description": "Indicates whether the company has responded to the review."
        },
        "completionRate": {
          "type": "number",
          "format": "double",
          "description": "The percentage of the review form completed by the user."
        },
        "productDescription": {
          "type": "string",
          "description": "A brief overview of the product and its key features."
        },
        "productDomain": {
          "type": "string",
          "description": "The official domain name of the product."
        },
        "productImageUrl": {
          "type": "string",
          "description": "A link to an image representing the product."
        },
        "productName": {
          "type": "string",
          "description": "The official name of the product."
        },
        "productSlug": {
          "type": "string",
          "description": "A URL-friendly identifier for the product."
        },
        "productType": {
          "type": "string",
          "description": "The category of product, such as software, hardware, or suite."
        },
        "region": {
          "type": "string",
          "description": "The geographic region where the reviewer is located."
        },
        "reviewCount": {
          "type": "integer",
          "format": "int64",
          "description": "The total number of reviews submitted for the product."
        },
        "reviewLink": {
          "type": "string",
          "description": "A direct link to the user's review."
        },
        "source": {
          "type": "string",
          "description": "The source or method through which the review was collected."
        },
        "starRating": {
          "type": "number",
          "format": "double",
          "description": "The number of stars the user gave in their review."
        },
        "submittedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the review was completed."
        },
        "surveyId": {
          "type": "string",
          "description": "A unique identifier for the review survey submission."
        },
        "title": {
          "type": "string",
          "description": "The title of the review, usually summarizing the user's opinion."
        },
        "reviewerCompany": {
          "type": "string",
          "description": "The name of the reviewer's employer."
        },
        "reviewerCompanySegment": {
          "type": "string",
          "description": "The business size segment of the reviewer's company."
        },
        "reviewerIsCurrentUser": {
          "type": "boolean",
          "description": "Indicates if the reviewer is a current user of the product."
        },
        "reviewerFirstName": {
          "type": "string",
          "description": "The first name of the reviewer."
        },
        "reviewerImageUrl": {
          "type": "string",
          "description": "A URL linking to the reviewer's profile picture."
        },
        "reviewerLastName": {
          "type": "string",
          "description": "The last initial of the reviewer's name."
        },
        "reviewerTitle": {
          "type": "string",
          "description": "The job title of the reviewer."
        },
        "reviewerUpdatedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The timestamp when the user's information was last updated."
        }
      },
      "description": "ProductReview Search Response Attributes.",
      "x-class-extra-annotation": "@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"
    },
    "ResultMeta": {
      "type": "object",
      "required": [
        "totalResults",
        "page"
      ],
      "properties": {
        "totalResults": {
          "type": "integer",
          "format": "uint32",
          "description": "The total number of results based on the specified filters"
        },
        "page": {
          "allOf": [
            {
              "$ref": "#/$defs/Page"
            }
          ],
          "description": "Paging information for the current result set"
        }
      },
      "description": "Metadata including paging information and the total number of records in the result set"
    },
    "ZiCompanySearch": {
      "type": "object",
      "properties": {
        "id": {
          "type": "integer",
          "format": "int64",
          "description": "ID."
        },
        "name": {
          "type": "string",
          "description": "name."
        },
        "industry": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "industry."
        },
        "headquartersPhone": {
          "type": "string",
          "description": "headquarters Phone."
        },
        "headquartersStreet": {
          "type": "string",
          "description": "headquarters Street."
        },
        "employees": {
          "type": "integer",
          "format": "int32",
          "description": "employees."
        },
        "revenue": {
          "type": "integer",
          "format": "int32",
          "description": "revenue."
        },
        "city": {
          "type": "string",
          "description": "city."
        },
        "country": {
          "type": "string",
          "description": "country."
        },
        "postalCode": {
          "type": "string",
          "description": "postal Code."
        },
        "state": {
          "type": "string",
          "description": "state."
        }
      },
      "description": "Compact company details returned with Form 5500 records when available."
    }
  }
}