Comment data model

Updated:

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

FieldTypeRequiredDescription
idstringNoUnique identifier for the comment
created_atstring (date-time)NoWhen the comment was posted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the comment was last edited, when the provider reports it (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
post_idstringNoThe post (or video) the comment belongs to
parent_idstringNoSet when this comment is a reply; the id of the comment being replied to
author_identifierstringNoProvider id of the commenter (not a Unified id)
author_namestringNoDisplay name of the commenter
author_usernamestringNoHandle / username of the commenter
author_avatar_urlstringNoAvatar URL of the commenter
contentstringNoThe comment text
urlstringNoPermalink to the comment, when available
is_hiddenbooleanNoTrue if the comment is hidden or held for moderation
metricsobjectNo
metrics.like_countnumberNoNumber of likes on the comment
metrics.reply_countnumberNoNumber of replies to the comment

TypeScript

TypeScript
export type SocialComment = {
	id?: string; // Unique identifier for the comment
	created_at?: string-time; // When the comment was posted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // When the comment was last edited, when the provider reports it (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	post_id?: string; // The post (or video) the comment belongs to
	parent_id?: string; // Set when this comment is a reply; the id of the comment being replied to
	author_identifier?: string; // Provider id of the commenter (not a Unified id)
	author_name?: string; // Display name of the commenter
	author_username?: string; // Handle / username of the commenter
	author_avatar_url?: string; // Avatar URL of the commenter
	content?: string; // The comment text
	url?: string; // Permalink to the comment, when available
	is_hidden?: boolean; // True if the comment is hidden or held for moderation
	metrics?: {
		like_count?: number; // Number of likes on the comment 
		reply_count?: number; // Number of replies to the comment 
	};
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodSocialComment = z.object({
	id: z.string().optional().describe("Unique identifier for the comment"),
	created_at: z.string-time().optional().describe("When the comment was posted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("When the comment was last edited, when the provider reports it (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	post_id: z.string().optional().describe("The post (or video) the comment belongs to"),
	parent_id: z.string().optional().describe("Set when this comment is a reply; the id of the comment being replied to"),
	author_identifier: z.string().optional().describe("Provider id of the commenter (not a Unified id)"),
	author_name: z.string().optional().describe("Display name of the commenter"),
	author_username: z.string().optional().describe("Handle / username of the commenter"),
	author_avatar_url: z.string().optional().describe("Avatar URL of the commenter"),
	content: z.string().optional().describe("The comment text"),
	url: z.string().optional().describe("Permalink to the comment, when available"),
	is_hidden: z.boolean().optional().describe("True if the comment is hidden or held for moderation"),
	metrics: z.object({
			like_count: z.number().optional().describe("Number of likes on the comment"),
			reply_count: z.number().optional().describe("Number of replies to the comment")
}).optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class PropertySocialCommentMetrics:
	"""Number of likes on the comment"""
	like_count: Optional[int]
	"""Number of replies to the comment"""
	reply_count: Optional[int]

@dataclasses.dataclass
class SocialComment:
	"""Unique identifier for the comment"""
	id: Optional[str]
	"""When the comment was posted (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""When the comment was last edited, when the provider reports it (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The post (or video) the comment belongs to"""
	post_id: Optional[str]
	"""Set when this comment is a reply; the id of the comment being replied to"""
	parent_id: Optional[str]
	"""Provider id of the commenter (not a Unified id)"""
	author_identifier: Optional[str]
	"""Display name of the commenter"""
	author_name: Optional[str]
	"""Handle / username of the commenter"""
	author_username: Optional[str]
	"""Avatar URL of the commenter"""
	author_avatar_url: Optional[str]
	"""The comment text"""
	content: Optional[str]
	"""Permalink to the comment, when available"""
	url: Optional[str]
	"""True if the comment is hidden or held for moderation"""
	is_hidden: Optional[bool]
	metrics: Optional[PropertySocialCommentMetrics]
Are we missing anything? Let us know
Was this page helpful?