{"openapi":"3.0.0","info":{"title":"Vertical Datasets API V1","version":"1.0","contact":{"name":"ZoomInfo Customer Support","email":"help@zoominfo.com"},"description":"The Vertical Dataset API"},"tags":[{"name":"FinancialFilings"},{"name":"JobPosts"},{"name":"LoanStatements"},{"name":"ProductReviews"}],"paths":{"/vertical-datasets/v1/financial-filings/search":{"post":{"operationId":"FinancialFilingsInterface_searchFinancialFiling","summary":"Search Financial Filings","description":"Returns a list of Financial Filings that meet the specified search criteria.","parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page of results to retrieve.","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return per page. Valid values: 1–100.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"sort","in":"query","required":false,"description":"Sort results by the specified output field. Prefix with '-' for descending order. Sortable fields: title, formNumber, isAmendment, periodEndDate, releaseDate, ticker, exchange, filingSummary.","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/FinancialFilingSearchResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["FinancialFilings"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/FinancialFilingSearchRequest"}}},"description":"The request body containing FinancialFiling search criteria."},"security":[{"OAuth2Auth":["api:vertical-datasets:read"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/vertical-datasets/v1/job-posts/search":{"post":{"operationId":"JobPostsInterface_searchJobPost","summary":"Search Job Posts","description":"Returns a list of Job Posts that meet the specified search criteria.","parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page of results to retrieve.","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return per page. Valid values: 1–100.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"sort","in":"query","required":false,"description":"Sort results by the specified output field. Prefix with '-' for descending order. Sortable fields: firstSeen, companyName, websiteDomain, jobTitle, jobUrl, lastSeen, managementLevel, normalizedAddressCity, normalizedAddressState, normalizedAddressCountry, normalizedJobTitle, jobPostClosed, description.","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JobPostSearchResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["JobPosts"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/JobPostSearchRequest"}}},"description":"The request body containing JobPost search criteria."},"security":[{"OAuth2Auth":["api:vertical-datasets:read"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/vertical-datasets/v1/loan-statements/search":{"post":{"operationId":"LoanStatementsInterface_searchLoanStatement","summary":"Search Loan Statements","description":"Returns a list of Loan Statements that meet the specified search criteria.","parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page of results to retrieve.","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return per page. Valid values: 1–100.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"sort","in":"query","required":false,"description":"Sort results by the specified output field. Prefix with '-' for descending order. Sortable fields: filingNumber, filingState, filingDate, actionCode, creditorType, debtorCompanyName, debtorCompanyDomain, creditorCompanyName, uccFilingChainNumber, uccCollateralCodes, filingChainDate.","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/LoanStatementSearchResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["LoanStatements"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/LoanStatementSearchRequest"}}},"description":"The request body containing LoanStatement search criteria."},"security":[{"OAuth2Auth":["api:vertical-datasets:read"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/vertical-datasets/v1/product-reviews/search":{"post":{"operationId":"ProductReviewsInterface_searchProductReview","summary":"Search Product Reviews","description":"Returns a list of Product Reviews that meet the specified search criteria.","parameters":[{"name":"page[number]","in":"query","required":false,"description":"The page of results to retrieve.","schema":{"type":"integer","format":"int32","minimum":1},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"The number of records to return per page. Valid values: 1–100.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100},"explode":false},{"name":"sort","in":"query","required":false,"description":"Sort results by the specified output field. Prefix with '-' for descending order. Sortable fields: productId, answers, avgRating, avgStarRating, benefits, benefitsText, categories, hasComment, country, sourceCreatedAt, defaultSortOrder, productUrl, writeReviewUrl, downsides, downsidesText, isIncentivized, isPublic, upsides, upsidesText, hasOfficialResponse, completionRate, productDescription, productDomain, productImageUrl, productName, productSlug, productType, region, reviewCount, reviewLink, source, starRating, submittedAt, surveyId, title, reviewerCompany, reviewerCompanySegment, reviewerIsCurrentUser, reviewerFirstName, reviewerImageUrl, reviewerLastName, reviewerTitle, reviewerUpdatedAt.","schema":{"type":"string"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ProductReviewSearchResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["ProductReviews"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ProductReviewSearchRequest"}}},"description":"The request body containing ProductReview search criteria."},"security":[{"OAuth2Auth":["api:vertical-datasets:read"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}}},"security":[{"OAuth2Auth":[]}],"components":{"schemas":{"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."},"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"},"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":"#/components/schemas/Page"}],"description":"Paging information for the current result set"}},"description":"Metadata including paging information and the total number of records in the result set"},"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."},"ZoomInfo.Core.Foundations.ErrorSourceModel":{"type":"object","properties":{"cookie":{"type":"string","description":"Identifies the cookie name that caused the issue"},"header":{"type":"string","description":"Identifies the header name that caused the error"},"pointer":{"type":"string","description":"An RFC 6901 compliant JSON pointer to the entity in the request body that caused the error"},"parameter":{"type":"string","description":"The name of the path or query parameter that caused the error"}}},"ZoomInfo.Core.Foundations.ErrorModel":{"type":"object","required":["id","code","status"],"properties":{"id":{"type":"string","description":"The unique id used to identify this specific error instance"},"code":{"type":"string","description":"The error code describing the error category. A full list of error codes can be found in the documentation for each service"},"detail":{"type":"string","description":"Message containing the specific details about this occurrence of the error"},"source":{"allOf":[{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorSourceModel"}],"description":"An optional object identifying which part of the request caused the error"},"status":{"type":"string","description":"The HTTP status code for the error"},"title":{"type":"string","description":"The error name that describes this type of error"}},"description":"The object describing a specific error from the API"},"ZoomInfo.Core.Foundations.ErrorResponseModel":{"type":"object","required":["errors"],"properties":{"detail":{"type":"string","description":"A high-level detail of the error(s) that occurred during the request"},"title":{"type":"string","description":"A high-level summary of the error(s) detected"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorModel"},"description":"The list of errors raised during the request"}},"description":"The standard error response body model for the ZoomInfo API."},"LargeTextFilterOperations":{"type":"object","properties":{"contains":{"type":"string","description":"Matches records where the field contains this substring."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."},"startsWith":{"type":"string","description":"Matches records where the field starts with this prefix (minimum 3 characters)."},"search":{"type":"string","description":"Matches records where the field contains this search term (full-text)."}},"description":"Filter operations for large text fields (largeText scalar). Supports substring match, prefix, and full-text search. Equality and set membership are not supported on large text."},"StringFilterOperations":{"type":"object","properties":{"eq":{"type":"string","description":"Matches records where the field equals this value."},"notEq":{"type":"string","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"string"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"string"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records based on whether the field is present (true) or absent (false)."},"startsWith":{"type":"string","description":"Matches records where the field starts with this prefix (minimum 3 characters)."},"search":{"type":"string","description":"Matches records where the field contains this search term (full-text)."}},"description":"Filter operations for string-like fields (email, url, domain, name, address components, etc.). Supports equality, set membership, prefix, and full-text search."},"ExactStringFilterOperations":{"type":"object","properties":{"eq":{"type":"string","description":"Matches records where the field equals this value."},"notEq":{"type":"string","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"string"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"string"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."}},"description":"Filter operations for opaque string identifier fields (opaqueIdentifier, uuid scalars). Supports equality and set membership only; range and search operators are not meaningful on identifiers."},"SearchOnlyStringFilterOperations":{"type":"object","properties":{"search":{"type":"string","description":"Matches records where the field contains this search term."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."}},"description":"Filter operations for searchable string fields that do not support equality."},"ShortAndMediumTextFilterOperations":{"type":"object","properties":{"eq":{"type":"string","description":"Matches records where the field equals this value."},"notEq":{"type":"string","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"string"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"string"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records based on whether the field is present (true) or absent (false)."},"startsWith":{"type":"string","description":"Matches records where the field starts with this prefix (minimum 3 characters)."},"search":{"type":"string","description":"Matches records where the field contains this search term (full-text)."}},"description":"Filter operations for short and medium text fields."},"ZiCompanySearchRequestAttributes":{"type":"object","properties":{"id":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"Unique ZoomInfo company identifiers."},"name":{"allOf":[{"$ref":"#/components/schemas/SearchOnlyStringFilterOperations"}],"description":"Company name."},"website":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"Company website."},"state":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"Company state or province."},"country":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"Company country."},"metroArea":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"Company metro area."},"postalCode":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"Company postal code."},"industry":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"Company industries."},"primaryIndustry":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"Company primary industry."},"sector":{"allOf":[{"$ref":"#/components/schemas/ShortAndMediumTextFilterOperations"}],"description":"Company sector keywords."},"description":{"allOf":[{"$ref":"#/components/schemas/SearchOnlyStringFilterOperations"}],"description":"Company description keywords."},"employees":{"type":"object","properties":{"eq":{"type":"number","format":"double","description":"Matches records where the field equals this value."},"notEq":{"type":"number","format":"double","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."},"gt":{"type":"number","format":"double","description":"Matches records where the field is greater than this value."},"gte":{"type":"number","format":"double","description":"Matches records where the field is greater than or equal to this value."},"lt":{"type":"number","format":"double","description":"Matches records where the field is less than this value."},"lte":{"type":"number","format":"double","description":"Matches records where the field is less than or equal to this value."},"between":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field falls within this inclusive range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."}},"description":"Employee count."},"employeeRange":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"Employee count range label."},"revenue":{"type":"object","properties":{"eq":{"type":"number","format":"double","description":"Matches records where the field equals this value."},"notEq":{"type":"number","format":"double","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."},"gt":{"type":"number","format":"double","description":"Matches records where the field is greater than this value."},"gte":{"type":"number","format":"double","description":"Matches records where the field is greater than or equal to this value."},"lt":{"type":"number","format":"double","description":"Matches records where the field is less than this value."},"lte":{"type":"number","format":"double","description":"Matches records where the field is less than or equal to this value."},"between":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field falls within this inclusive range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."}},"description":"Annual revenue."},"revenueRange":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"Revenue range label."},"domainRank":{"type":"object","properties":{"eq":{"type":"number","format":"double","description":"Matches records where the field equals this value."},"notEq":{"type":"number","format":"double","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."},"gt":{"type":"number","format":"double","description":"Matches records where the field is greater than this value."},"gte":{"type":"number","format":"double","description":"Matches records where the field is greater than or equal to this value."},"lt":{"type":"number","format":"double","description":"Matches records where the field is less than this value."},"lte":{"type":"number","format":"double","description":"Matches records where the field is less than or equal to this value."},"between":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field falls within this inclusive range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."}},"description":"Company domain rank."}},"description":"Request attributes for company search."},"FinancialFilingSearchResponseAttributes":{"type":"object","properties":{"title":{"type":"string","description":"The official name of the filing document."},"formNumber":{"type":"string","description":"The standard code that identifies the type of filing."},"isAmendment":{"type":"boolean","description":"Indicates if this filing corrects or updates a previous filing."},"periodEndDate":{"type":"string","format":"date-time","description":"The last day of the time period covered in this filing."},"releaseDate":{"type":"string","format":"date-time","description":"When the filing was made available to the public."},"ziCompany":{"allOf":[{"$ref":"#/components/schemas/ZiCompanySearch"}],"description":"Compact ZiCompany details returned with the record when available."},"ticker":{"type":"string","description":"The stock ticker for the company associated with the filing."},"exchange":{"type":"string","description":"The stock exchange for the company associated with the filing, normalized to ZI recognized exchange identifiers."},"filingSummary":{"type":"string","description":"A brief narrative summary of the filing (e.g., financial performance, business highlights and outlook)."}},"description":"FinancialFiling Search Response Attributes.","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"FinancialFiling":{"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":"FinancialFiling","pattern":"FinancialFiling"},"attributes":{"allOf":[{"$ref":"#/components/schemas/FinancialFilingSearchResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"FinancialFiling record resource."},"FinancialFilingSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FinancialFiling"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/ResultMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/Links"}],"description":"Links related to the primary data"}},"description":"Search response body for FinancialFiling."},"BooleanFilterOperations":{"type":"object","properties":{"eq":{"type":"boolean","description":"Matches records where the field equals this value."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."}},"description":"Filter operations for boolean fields. Supports equality only."},"FinancialFilingSearchRequestAttributes":{"type":"object","properties":{"title":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The official name of the filing document."},"formNumber":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The standard code that identifies the type of filing."},"isAmendment":{"allOf":[{"$ref":"#/components/schemas/BooleanFilterOperations"}],"description":"Indicates if this filing corrects or updates a previous filing."},"periodEndDate":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"Matches records where the field equals this value."},"notEq":{"type":"string","format":"date-time","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field does not equal any value in the list."},"gt":{"type":"string","format":"date-time","description":"Matches records where the field is after this value (exclusive)."},"gte":{"type":"string","format":"date-time","description":"Matches records where the field is after or on this value (inclusive)."},"lt":{"type":"string","format":"date-time","description":"Matches records where the field is before this value (exclusive)."},"lte":{"type":"string","format":"date-time","description":"Matches records where the field is before or on this value (inclusive)."},"between":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field falls within this inclusive date range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."}},"description":"The last day of the time period covered in this filing."},"releaseDate":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"Matches records where the field equals this value."},"notEq":{"type":"string","format":"date-time","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field does not equal any value in the list."},"gt":{"type":"string","format":"date-time","description":"Matches records where the field is after this value (exclusive)."},"gte":{"type":"string","format":"date-time","description":"Matches records where the field is after or on this value (inclusive)."},"lt":{"type":"string","format":"date-time","description":"Matches records where the field is before this value (exclusive)."},"lte":{"type":"string","format":"date-time","description":"Matches records where the field is before or on this value (inclusive)."},"between":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field falls within this inclusive date range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."}},"description":"When the filing was made available to the public."},"ziCompany":{"allOf":[{"$ref":"#/components/schemas/ZiCompanySearchRequestAttributes"}],"description":"Filters applied to the related ZiCompany."},"ticker":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The stock ticker for the company associated with the filing."},"exchange":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The stock exchange for the company associated with the filing, normalized to ZI recognized exchange identifiers."},"filingSummary":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"A brief narrative summary of the filing (e.g., financial performance, business highlights and outlook)."}},"description":"Request attributes for FinancialFiling search."},"FinancialFilingSearchResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"FinancialFilingSearch","pattern":"FinancialFilingSearch"},"attributes":{"allOf":[{"$ref":"#/components/schemas/FinancialFilingSearchRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Search request resource for FinancialFiling."},"FinancialFilingSearchRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/FinancialFilingSearchResource"}],"description":"The primary data of the document"}},"description":"Search request body for FinancialFiling."},"JobPostSearchResponseAttributes":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"string"},"description":"List of job categories or keywords assigned to this job posting by the source."},"contractTypes":{"type":"array","items":{"type":"string"},"description":"Type of employment contract, normalized to canonical values such as Full-Time, Part-Time, Contract, Permanent, Temporary, Internship, Remote, Hybrid, or On-Site."},"departments":{"type":"array","items":{"type":"string"},"description":"List of company departments associated with the job using the ZoomInfo classification system."},"firstSeen":{"type":"string","format":"date-time","description":"Date and time when the job posting was first observed by the source."},"companyName":{"type":"string","description":"Name of the company offering the job."},"websiteDomain":{"type":"string","description":"Website domain of the company offering the job."},"jobFunctions":{"type":"array","items":{"type":"string"},"description":"List of job functions that describe the role using the ZoomInfo classification system."},"jobTitle":{"type":"string","description":"The title of the job as stated, unaltered, in the job post."},"jobUrl":{"type":"string","description":"Web address where the job posting is listed."},"lastSeen":{"type":"string","format":"date-time","description":"Date and time when the job posting was last observed."},"managementLevel":{"type":"string","description":"Hierarchical level of the position, such as \"Non-Manager\", using the ZoomInfo classification system."},"normalizedAddressCity":{"type":"string","description":"Standardized version of the job location, based on JOB_ADDRESS, using the ZoomInfo address normalization service."},"normalizedAddressState":{"type":"string","description":"Standardized version of the job location, based on JOB_ADDRESS, using the ZoomInfo address normalization service."},"normalizedAddressCountry":{"type":"string","description":"Standardized version of the job location, based on JOB_ADDRESS, using the ZoomInfo address normalization service."},"normalizedJobTitle":{"type":"string","description":"Standardized version of the job title, based on JOB_TITLE, using ZoomInfo classification system."},"jobPostClosed":{"type":"boolean","description":"Indicates whether the job is still open (False) or closed (True)."},"description":{"type":"string","description":"The full text copy of the job post as advertised."},"ziCompany":{"allOf":[{"$ref":"#/components/schemas/ZiCompanySearch"}],"description":"Compact ZiCompany details returned with the record when available."}},"description":"JobPost Search Response Attributes.","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"JobPost":{"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":"JobPost","pattern":"JobPost"},"attributes":{"allOf":[{"$ref":"#/components/schemas/JobPostSearchResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"JobPost record resource."},"JobPostSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/JobPost"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/ResultMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/Links"}],"description":"Links related to the primary data"}},"description":"Search response body for JobPost."},"JobPostSearchRequestAttributes":{"type":"object","properties":{"categories":{"type":"array","items":{"type":"string"},"description":"List of job categories or keywords assigned to this job posting by the source."},"contractTypes":{"type":"array","items":{"type":"string"},"description":"Type of employment contract, normalized to canonical values such as Full-Time, Part-Time, Contract, Permanent, Temporary, Internship, Remote, Hybrid, or On-Site."},"departments":{"type":"array","items":{"type":"string"},"description":"List of company departments associated with the job using the ZoomInfo classification system."},"firstSeen":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"Matches records where the field equals this value."},"notEq":{"type":"string","format":"date-time","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field does not equal any value in the list."},"gt":{"type":"string","format":"date-time","description":"Matches records where the field is after this value (exclusive)."},"gte":{"type":"string","format":"date-time","description":"Matches records where the field is after or on this value (inclusive)."},"lt":{"type":"string","format":"date-time","description":"Matches records where the field is before this value (exclusive)."},"lte":{"type":"string","format":"date-time","description":"Matches records where the field is before or on this value (inclusive)."},"between":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field falls within this inclusive date range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."}},"description":"Date and time when the job posting was first observed by the source."},"companyName":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Name of the company offering the job."},"websiteDomain":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Website domain of the company offering the job."},"jobFunctions":{"type":"array","items":{"type":"string"},"description":"List of job functions that describe the role using the ZoomInfo classification system."},"jobTitle":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The title of the job as stated, unaltered, in the job post."},"jobUrl":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Web address where the job posting is listed."},"lastSeen":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"Matches records where the field equals this value."},"notEq":{"type":"string","format":"date-time","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field does not equal any value in the list."},"gt":{"type":"string","format":"date-time","description":"Matches records where the field is after this value (exclusive)."},"gte":{"type":"string","format":"date-time","description":"Matches records where the field is after or on this value (inclusive)."},"lt":{"type":"string","format":"date-time","description":"Matches records where the field is before this value (exclusive)."},"lte":{"type":"string","format":"date-time","description":"Matches records where the field is before or on this value (inclusive)."},"between":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field falls within this inclusive date range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."}},"description":"Date and time when the job posting was last observed."},"managementLevel":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Hierarchical level of the position, such as \"Non-Manager\", using the ZoomInfo classification system."},"normalizedAddressCity":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Standardized version of the job location, based on JOB_ADDRESS, using the ZoomInfo address normalization service."},"normalizedAddressState":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Standardized version of the job location, based on JOB_ADDRESS, using the ZoomInfo address normalization service."},"normalizedAddressCountry":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Standardized version of the job location, based on JOB_ADDRESS, using the ZoomInfo address normalization service."},"normalizedJobTitle":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Standardized version of the job title, based on JOB_TITLE, using ZoomInfo classification system."},"jobPostClosed":{"allOf":[{"$ref":"#/components/schemas/BooleanFilterOperations"}],"description":"Indicates whether the job is still open (False) or closed (True)."},"description":{"allOf":[{"$ref":"#/components/schemas/LargeTextFilterOperations"}],"description":"The full text copy of the job post as advertised."},"ziCompany":{"allOf":[{"$ref":"#/components/schemas/ZiCompanySearchRequestAttributes"}],"description":"Filters applied to the related ZiCompany."}},"description":"Request attributes for JobPost search."},"JobPostSearchResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"JobPostSearch","pattern":"JobPostSearch"},"attributes":{"allOf":[{"$ref":"#/components/schemas/JobPostSearchRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Search request resource for JobPost."},"JobPostSearchRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/JobPostSearchResource"}],"description":"The primary data of the document"}},"description":"Search request body for JobPost."},"LoanStatementSearchResponseAttributes":{"type":"object","properties":{"filingNumber":{"type":"string","description":"UCC number of the filing."},"filingState":{"type":"string","description":"The state the filing was filed in."},"filingDate":{"type":"string","format":"date","description":"The date the UCC filing was made."},"actionCode":{"type":"string","description":"Type of Filing: Filed, Amended, Assigned, Partial Release, Full Release, Release, Continued."},"creditorType":{"type":"string","description":"Type of Creditor (Secured Part or Assignee): S->Secured Party, A->Assignee."},"debtorZiCompany":{"allOf":[{"$ref":"#/components/schemas/ZiCompanySearch"}],"description":"Compact ZiCompany details returned with the record when available."},"debtorCompanyName":{"type":"string","description":"Debtor name exactly as it appears on the UCC filing. Populated only when there is no ZoomInfo company match; otherwise null - see the matched Debtor Company for ZoomInfo-identified entities."},"debtorCompanyDomain":{"type":"string","description":"Domain of the debtor company."},"creditorZiCompany":{"allOf":[{"$ref":"#/components/schemas/ZiCompanySearch"}],"description":"Compact ZiCompany details returned with the record when available."},"creditorCompanyName":{"type":"string","description":"Creditor name exactly as it appears on the UCC filing. Populated only when there is no ZoomInfo company match; otherwise null - see the matched Creditor Company for ZoomInfo-identified entities."},"uccFilingChainNumber":{"type":"string","description":"UCC number of the initial filing in a chain."},"uccCollateralCodes":{"type":"string","description":"Set of packed collateral codes, can be one or many, pipe-delimited: Consumer Goods, Blanket Lien, Real Estate, Vehicles, Other, Accounts Receivable, Machinery and Equipment, Furniture and Fixtures, Inventory, Hereafter Acquired Property."},"filingChainDate":{"type":"string","format":"date","description":"The date the filing chain was started."}},"description":"LoanStatement Search Response Attributes.","x-class-extra-annotation":"@com.fasterxml.jackson.annotation.JsonIgnoreProperties(ignoreUnknown = true)"},"LoanStatement":{"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":"LoanStatement","pattern":"LoanStatement"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LoanStatementSearchResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"LoanStatement record resource."},"LoanStatementSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LoanStatement"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/ResultMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/Links"}],"description":"Links related to the primary data"}},"description":"Search response body for LoanStatement."},"LoanStatementSearchRequestAttributes":{"type":"object","properties":{"filingNumber":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"UCC number of the filing."},"filingState":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The state the filing was filed in."},"filingDate":{"type":"object","properties":{"eq":{"type":"string","format":"date","description":"Matches records where the field equals this value."},"notEq":{"type":"string","format":"date","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"string","format":"date"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"string","format":"date"},"description":"Matches records where the field does not equal any value in the list."},"gt":{"type":"string","format":"date","description":"Matches records where the field is after this value (exclusive)."},"gte":{"type":"string","format":"date","description":"Matches records where the field is after or on this value (inclusive)."},"lt":{"type":"string","format":"date","description":"Matches records where the field is before this value (exclusive)."},"lte":{"type":"string","format":"date","description":"Matches records where the field is before or on this value (inclusive)."},"between":{"type":"array","items":{"type":"string","format":"date"},"description":"Matches records where the field falls within this inclusive date range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."}},"description":"The date the UCC filing was made."},"actionCode":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Type of Filing: Filed, Amended, Assigned, Partial Release, Full Release, Release, Continued."},"creditorType":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Type of Creditor (Secured Part or Assignee): S->Secured Party, A->Assignee."},"debtorZiCompany":{"allOf":[{"$ref":"#/components/schemas/ZiCompanySearchRequestAttributes"}],"description":"Filters applied to the related ZiCompany."},"debtorCompanyName":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Debtor name exactly as it appears on the UCC filing. Populated only when there is no ZoomInfo company match; otherwise null - see the matched Debtor Company for ZoomInfo-identified entities."},"debtorCompanyDomain":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Domain of the debtor company."},"creditorZiCompany":{"allOf":[{"$ref":"#/components/schemas/ZiCompanySearchRequestAttributes"}],"description":"Filters applied to the related ZiCompany."},"creditorCompanyName":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Creditor name exactly as it appears on the UCC filing. Populated only when there is no ZoomInfo company match; otherwise null - see the matched Creditor Company for ZoomInfo-identified entities."},"uccFilingChainNumber":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"UCC number of the initial filing in a chain."},"uccCollateralCodes":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"Set of packed collateral codes, can be one or many, pipe-delimited: Consumer Goods, Blanket Lien, Real Estate, Vehicles, Other, Accounts Receivable, Machinery and Equipment, Furniture and Fixtures, Inventory, Hereafter Acquired Property."},"filingChainDate":{"type":"object","properties":{"eq":{"type":"string","format":"date","description":"Matches records where the field equals this value."},"notEq":{"type":"string","format":"date","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"string","format":"date"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"string","format":"date"},"description":"Matches records where the field does not equal any value in the list."},"gt":{"type":"string","format":"date","description":"Matches records where the field is after this value (exclusive)."},"gte":{"type":"string","format":"date","description":"Matches records where the field is after or on this value (inclusive)."},"lt":{"type":"string","format":"date","description":"Matches records where the field is before this value (exclusive)."},"lte":{"type":"string","format":"date","description":"Matches records where the field is before or on this value (inclusive)."},"between":{"type":"array","items":{"type":"string","format":"date"},"description":"Matches records where the field falls within this inclusive date range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."}},"description":"The date the filing chain was started."}},"description":"Request attributes for LoanStatement search."},"LoanStatementSearchResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"LoanStatementSearch","pattern":"LoanStatementSearch"},"attributes":{"allOf":[{"$ref":"#/components/schemas/LoanStatementSearchRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Search request resource for LoanStatement."},"LoanStatementSearchRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/LoanStatementSearchResource"}],"description":"The primary data of the document"}},"description":"Search request body for LoanStatement."},"ProductReviewSearchResponseAttributes":{"type":"object","properties":{"reviewedZiCompany":{"allOf":[{"$ref":"#/components/schemas/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":"#/components/schemas/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)"},"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":"#/components/schemas/ProductReviewSearchResponseAttributes"}],"description":"The attributes defining the resource"}},"description":"ProductReview record resource."},"ProductReviewSearchResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductReview"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/ResultMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/Links"}],"description":"Links related to the primary data"}},"description":"Search response body for ProductReview."},"ProductReviewSearchRequestAttributes":{"type":"object","properties":{"reviewedZiCompany":{"allOf":[{"$ref":"#/components/schemas/ZiCompanySearchRequestAttributes"}],"description":"Filters applied to the related ZiCompany."},"reviewerZiPersonId":{"type":"object","properties":{"eq":{"type":"integer","format":"int64","description":"Matches records where the field equals this value."},"notEq":{"type":"integer","format":"int64","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."}},"description":"ZI Person ID of the Reviewer."},"reviewerZiCompany":{"allOf":[{"$ref":"#/components/schemas/ZiCompanySearchRequestAttributes"}],"description":"Filters applied to the related ZiCompany."},"productId":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"A unique identifier for the product being reviewed."},"answers":{"type":"object","properties":{"eq":{"type":"integer","format":"int64","description":"Matches records where the field equals this value."},"notEq":{"type":"integer","format":"int64","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."},"gt":{"type":"integer","format":"int64","description":"Matches records where the field is greater than this value."},"gte":{"type":"integer","format":"int64","description":"Matches records where the field is greater than or equal to this value."},"lt":{"type":"integer","format":"int64","description":"Matches records where the field is less than this value."},"lte":{"type":"integer","format":"int64","description":"Matches records where the field is less than or equal to this value."},"between":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Matches records where the field falls within this inclusive range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."}},"description":"The total number of responses provided in a product review."},"avgRating":{"type":"object","properties":{"eq":{"type":"number","format":"double","description":"Matches records where the field equals this value."},"notEq":{"type":"number","format":"double","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."},"gt":{"type":"number","format":"double","description":"Matches records where the field is greater than this value."},"gte":{"type":"number","format":"double","description":"Matches records where the field is greater than or equal to this value."},"lt":{"type":"number","format":"double","description":"Matches records where the field is less than this value."},"lte":{"type":"number","format":"double","description":"Matches records where the field is less than or equal to this value."},"between":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field falls within this inclusive range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."}},"description":"The overall numerical rating given by users, calculated as an average across all reviews."},"avgStarRating":{"type":"object","properties":{"eq":{"type":"number","format":"double","description":"Matches records where the field equals this value."},"notEq":{"type":"number","format":"double","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."},"gt":{"type":"number","format":"double","description":"Matches records where the field is greater than this value."},"gte":{"type":"number","format":"double","description":"Matches records where the field is greater than or equal to this value."},"lt":{"type":"number","format":"double","description":"Matches records where the field is less than this value."},"lte":{"type":"number","format":"double","description":"Matches records where the field is less than or equal to this value."},"between":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field falls within this inclusive range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."}},"description":"The average rating displayed in a 5-star format."},"benefits":{"allOf":[{"$ref":"#/components/schemas/LargeTextFilterOperations"}],"description":"A summary of the most valuable aspects of the product, as described by users."},"benefitsText":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The survey question asking users what business problems the product helps solve."},"categories":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"A numeric identifier for the product's category."},"hasComment":{"allOf":[{"$ref":"#/components/schemas/BooleanFilterOperations"}],"description":"Indicates whether a review includes a written comment."},"country":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The country where the reviewer is located."},"sourceCreatedAt":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"Matches records where the field equals this value."},"notEq":{"type":"string","format":"date-time","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field does not equal any value in the list."},"gt":{"type":"string","format":"date-time","description":"Matches records where the field is after this value (exclusive)."},"gte":{"type":"string","format":"date-time","description":"Matches records where the field is after or on this value (inclusive)."},"lt":{"type":"string","format":"date-time","description":"Matches records where the field is before this value (exclusive)."},"lte":{"type":"string","format":"date-time","description":"Matches records where the field is before or on this value (inclusive)."},"between":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field falls within this inclusive date range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."}},"description":"The timestamp when the review was submitted in the source system."},"defaultSortOrder":{"type":"object","properties":{"eq":{"type":"number","format":"double","description":"Matches records where the field equals this value."},"notEq":{"type":"number","format":"double","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."},"gt":{"type":"number","format":"double","description":"Matches records where the field is greater than this value."},"gte":{"type":"number","format":"double","description":"Matches records where the field is greater than or equal to this value."},"lt":{"type":"number","format":"double","description":"Matches records where the field is less than this value."},"lte":{"type":"number","format":"double","description":"Matches records where the field is less than or equal to this value."},"between":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field falls within this inclusive range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."}},"description":"The ranking score used to order reviews by default."},"productUrl":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The web link to the product's page on the review site."},"writeReviewUrl":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The web link for users to submit a review for the product."},"downsides":{"allOf":[{"$ref":"#/components/schemas/LargeTextFilterOperations"}],"description":"A description of what users find least helpful about the product."},"downsidesText":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The survey question asking users about the product's drawbacks."},"isIncentivized":{"allOf":[{"$ref":"#/components/schemas/BooleanFilterOperations"}],"description":"Indicates whether the review was written in exchange for an incentive."},"isPublic":{"allOf":[{"$ref":"#/components/schemas/BooleanFilterOperations"}],"description":"Indicates whether the review is visible to the public."},"upsides":{"allOf":[{"$ref":"#/components/schemas/LargeTextFilterOperations"}],"description":"A description of what users find most helpful about the product."},"upsidesText":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The survey question asking users about the product's advantages."},"hasOfficialResponse":{"allOf":[{"$ref":"#/components/schemas/BooleanFilterOperations"}],"description":"Indicates whether the company has responded to the review."},"completionRate":{"type":"object","properties":{"eq":{"type":"number","format":"double","description":"Matches records where the field equals this value."},"notEq":{"type":"number","format":"double","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."},"gt":{"type":"number","format":"double","description":"Matches records where the field is greater than this value."},"gte":{"type":"number","format":"double","description":"Matches records where the field is greater than or equal to this value."},"lt":{"type":"number","format":"double","description":"Matches records where the field is less than this value."},"lte":{"type":"number","format":"double","description":"Matches records where the field is less than or equal to this value."},"between":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field falls within this inclusive range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."}},"description":"The percentage of the review form completed by the user."},"productDescription":{"allOf":[{"$ref":"#/components/schemas/LargeTextFilterOperations"}],"description":"A brief overview of the product and its key features."},"productDomain":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The official domain name of the product."},"productImageUrl":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"A link to an image representing the product."},"productName":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The official name of the product."},"productSlug":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"A URL-friendly identifier for the product."},"productType":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The category of product, such as software, hardware, or suite."},"region":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The geographic region where the reviewer is located."},"reviewCount":{"type":"object","properties":{"eq":{"type":"integer","format":"int64","description":"Matches records where the field equals this value."},"notEq":{"type":"integer","format":"int64","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."},"gt":{"type":"integer","format":"int64","description":"Matches records where the field is greater than this value."},"gte":{"type":"integer","format":"int64","description":"Matches records where the field is greater than or equal to this value."},"lt":{"type":"integer","format":"int64","description":"Matches records where the field is less than this value."},"lte":{"type":"integer","format":"int64","description":"Matches records where the field is less than or equal to this value."},"between":{"type":"array","items":{"type":"integer","format":"int64"},"description":"Matches records where the field falls within this inclusive range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."}},"description":"The total number of reviews submitted for the product."},"reviewLink":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"A direct link to the user's review."},"source":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The source or method through which the review was collected."},"starRating":{"type":"object","properties":{"eq":{"type":"number","format":"double","description":"Matches records where the field equals this value."},"notEq":{"type":"number","format":"double","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field does not equal any value in the list."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."},"gt":{"type":"number","format":"double","description":"Matches records where the field is greater than this value."},"gte":{"type":"number","format":"double","description":"Matches records where the field is greater than or equal to this value."},"lt":{"type":"number","format":"double","description":"Matches records where the field is less than this value."},"lte":{"type":"number","format":"double","description":"Matches records where the field is less than or equal to this value."},"between":{"type":"array","items":{"type":"number","format":"double"},"description":"Matches records where the field falls within this inclusive range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."}},"description":"The number of stars the user gave in their review."},"submittedAt":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"Matches records where the field equals this value."},"notEq":{"type":"string","format":"date-time","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field does not equal any value in the list."},"gt":{"type":"string","format":"date-time","description":"Matches records where the field is after this value (exclusive)."},"gte":{"type":"string","format":"date-time","description":"Matches records where the field is after or on this value (inclusive)."},"lt":{"type":"string","format":"date-time","description":"Matches records where the field is before this value (exclusive)."},"lte":{"type":"string","format":"date-time","description":"Matches records where the field is before or on this value (inclusive)."},"between":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field falls within this inclusive date range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."}},"description":"The timestamp when the review was completed."},"surveyId":{"allOf":[{"$ref":"#/components/schemas/ExactStringFilterOperations"}],"description":"A unique identifier for the review survey submission."},"title":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The title of the review, usually summarizing the user's opinion."},"reviewerCompany":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The name of the reviewer's employer."},"reviewerCompanySegment":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The business size segment of the reviewer's company."},"reviewerIsCurrentUser":{"allOf":[{"$ref":"#/components/schemas/BooleanFilterOperations"}],"description":"Indicates if the reviewer is a current user of the product."},"reviewerFirstName":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The first name of the reviewer."},"reviewerImageUrl":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"A URL linking to the reviewer's profile picture."},"reviewerLastName":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The last initial of the reviewer's name."},"reviewerTitle":{"allOf":[{"$ref":"#/components/schemas/StringFilterOperations"}],"description":"The job title of the reviewer."},"reviewerUpdatedAt":{"type":"object","properties":{"eq":{"type":"string","format":"date-time","description":"Matches records where the field equals this value."},"notEq":{"type":"string","format":"date-time","description":"Matches records where the field does not equal this value."},"in":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field equals any value in the list."},"notIn":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field does not equal any value in the list."},"gt":{"type":"string","format":"date-time","description":"Matches records where the field is after this value (exclusive)."},"gte":{"type":"string","format":"date-time","description":"Matches records where the field is after or on this value (inclusive)."},"lt":{"type":"string","format":"date-time","description":"Matches records where the field is before this value (exclusive)."},"lte":{"type":"string","format":"date-time","description":"Matches records where the field is before or on this value (inclusive)."},"between":{"type":"array","items":{"type":"string","format":"date-time"},"description":"Matches records where the field falls within this inclusive date range. Expects exactly two elements: [lowerBound, upperBound]. Passing fewer or more will result in a runtime error."},"exists":{"type":"boolean","description":"Matches records where the field is present (true) or absent (false)."}},"description":"The timestamp when the user's information was last updated."}},"description":"Request attributes for ProductReview search."},"ProductReviewSearchResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"ProductReviewSearch","pattern":"ProductReviewSearch"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ProductReviewSearchRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Search request resource for ProductReview."},"ProductReviewSearchRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/ProductReviewSearchResource"}],"description":"The primary data of the document"}},"description":"Search request body for ProductReview."}},"securitySchemes":{"OAuth2Auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://login.zoominfo.com","tokenUrl":"https://okta-login.zoominfo.com/oauth2/default/v1/token","scopes":{"api:vertical-datasets:read":"Ability to read Vertical Datasets API entities and data"}}}}}},"servers":[{"url":"https://api.zoominfo.com/gtm","description":"Base URL for the Vertical Datasets API"}],"x-beta":true}