Review data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNoUnique identifier for the review
created_atstring (date-time)NoWhen the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
profile_idstringNoThe social profile (page/handle/listing) being reviewed
ratingnumberNoStar rating, typically 1-5
titlestringNoOptional review title/headline
contentstringNoThe review text
author_namestringNoDisplay name of the reviewer
author_avatar_urlstringNoProfile image URL of the reviewer
author_locationstringNoFree-text location of the reviewer
replyobjectNoThe business's reply to the review
reply.contentstringNoThe reply text from the business
reply.created_atstring (date-time)NoWhen the reply was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
reply.updated_atstring (date-time)NoWhen the reply was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
urlstringNoPublic permalink to the review

TypeScript

TypeScript
export type SocialReview = {
	id?: string; // Unique identifier for the review
	created_at?: string-time; // When the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // When the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	profile_id?: string; // The social profile (page/handle/listing) being reviewed
	rating?: number; // Star rating, typically 1-5
	title?: string; // Optional review title/headline
	content?: string; // The review text
	author_name?: string; // Display name of the reviewer
	author_avatar_url?: string; // Profile image URL of the reviewer
	author_location?: string; // Free-text location of the reviewer
	reply?: {
		content?: string; // The reply text from the business 
		created_at?: string-time; // When the reply was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) 
		updated_at?: string-time; // When the reply was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) 
	}; // The business's reply to the review
	url?: string; // Public permalink to the review
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodSocialReview = z.object({
	id: z.string().optional().describe("Unique identifier for the review"),
	created_at: z.string-time().optional().describe("When the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("When the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	profile_id: z.string().optional().describe("The social profile (page/handle/listing) being reviewed"),
	rating: z.number().optional().describe("Star rating, typically 1-5"),
	title: z.string().optional().describe("Optional review title/headline"),
	content: z.string().optional().describe("The review text"),
	author_name: z.string().optional().describe("Display name of the reviewer"),
	author_avatar_url: z.string().optional().describe("Profile image URL of the reviewer"),
	author_location: z.string().optional().describe("Free-text location of the reviewer"),
	reply: z.object({
			content: z.string().optional().describe("The reply text from the business"),
			created_at: z.string-time().optional().describe("When the reply was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
			updated_at: z.string-time().optional().describe("When the reply was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)")
}).optional().describe("The business's reply to the review"),
	url: z.string().optional().describe("Public permalink to the review"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PropertySocialReviewReply:
	"""The reply text from the business"""
	content: Optional[str]
	"""When the reply was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""When the reply was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]

@dataclasses.dataclass
class SocialReview:
	"""Unique identifier for the review"""
	id: Optional[str]
	"""When the review was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""When the review was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The social profile (page/handle/listing) being reviewed"""
	profile_id: Optional[str]
	"""Star rating, typically 1-5"""
	rating: Optional[int]
	"""Optional review title/headline"""
	title: Optional[str]
	"""The review text"""
	content: Optional[str]
	"""Display name of the reviewer"""
	author_name: Optional[str]
	"""Profile image URL of the reviewer"""
	author_avatar_url: Optional[str]
	"""Free-text location of the reviewer"""
	author_location: Optional[str]
	"""The business's reply to the review"""
	reply: Optional[PropertySocialReviewReply]
	"""Public permalink to the review"""
	url: Optional[str]
Are we missing anything? Let us know
Was this page helpful?