Post data model

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

FieldTypeRequiredDescription
idstringNoUnique identifier for the post
created_atstring (date-time)NoWhen the post was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoWhen the post was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
profile_idstringNoThe social profile (page/handle/listing) that owns this post
parent_post_idstringNoThe post this one replies to or references
titlestringNoOptional post title/headline
bodystringNoThe main text content of the post
statusenumNoPublication status of the post Values: DRAFT, SCHEDULED, PUBLISHED, REJECTED, PROCESSING, DELETED, OTHER
typeenumNoThe kind of post Values: POST, REPLY, REPOST, QUOTE, EVENT, OFFER, ALERT, STORY, OTHER
mediaSocialMedia[]NoMedia assets attached to the post
media[].idstringNoProvider media id, when the media is individually addressable
media[].urlstringYesURL of the media asset
media[].altstringNoAccessibility caption / alt text
media[].typeenumNoType of media Values: PHOTO, VIDEO, GIF, OTHER
media[].heightnumberNoMedia height in pixels
media[].widthnumberNoMedia width in pixels
media[].positionnumberNoOrdering of the media within the post; 1 is the first
urlstringNoPublic permalink to the post
languagestringNoLanguage code of the post content
scheduled_atstring (date-time)NoWhen the post is scheduled to publish (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
call_to_actionobjectNoCall-to-action button on the post
call_to_action.typeenumNoThe call-to-action button type Values: BOOK, ORDER, SHOP, LEARN_MORE, SIGN_UP, CALL, OTHER
call_to_action.urlstringNoThe URL the call-to-action points to
metricsobjectNoEngagement metrics for the post
metrics.like_countnumberNoNumber of likes/reactions
metrics.comment_countnumberNoNumber of comments/replies
metrics.share_countnumberNoNumber of shares/reposts
metrics.quote_countnumberNoNumber of quotes
metrics.view_countnumberNoNumber of views/impressions
metrics.bookmark_countnumberNoNumber of bookmarks/saves

TypeScript

TypeScript
export type SocialPost = {
	id?: string; // Unique identifier for the post
	created_at?: string-time; // When the post was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // When the post was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	profile_id?: string; // The social profile (page/handle/listing) that owns this post
	parent_post_id?: string; // The post this one replies to or references
	title?: string; // Optional post title/headline
	body?: string; // The main text content of the post
	status?: 'DRAFT' | 'SCHEDULED' | 'PUBLISHED' | 'REJECTED' | 'PROCESSING' | 'DELETED' | 'OTHER'; // Publication status of the post
	type?: 'POST' | 'REPLY' | 'REPOST' | 'QUOTE' | 'EVENT' | 'OFFER' | 'ALERT' | 'STORY' | 'OTHER'; // The kind of post
	media?: []; // Media assets attached to the post
	url?: string; // Public permalink to the post
	language?: string; // Language code of the post content
	scheduled_at?: string-time; // When the post is scheduled to publish (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	call_to_action?: {
		type?: 'BOOK' | 'ORDER' | 'SHOP' | 'LEARN_MORE' | 'SIGN_UP' | 'CALL' | 'OTHER'; // The call-to-action button type 
		url?: string; // The URL the call-to-action points to 
	}; // Call-to-action button on the post
	metrics?: {
		like_count?: number; // Number of likes/reactions 
		comment_count?: number; // Number of comments/replies 
		share_count?: number; // Number of shares/reposts 
		quote_count?: number; // Number of quotes 
		view_count?: number; // Number of views/impressions 
		bookmark_count?: number; // Number of bookmarks/saves 
	}; // Engagement metrics for the post
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodSocialPost = z.object({
	id: z.string().optional().describe("Unique identifier for the post"),
	created_at: z.string-time().optional().describe("When the post was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("When the post was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	profile_id: z.string().optional().describe("The social profile (page/handle/listing) that owns this post"),
	parent_post_id: z.string().optional().describe("The post this one replies to or references"),
	title: z.string().optional().describe("Optional post title/headline"),
	body: z.string().optional().describe("The main text content of the post"),
	status: z.enum("DRAFT", "SCHEDULED", "PUBLISHED", "REJECTED", "PROCESSING", "DELETED", "OTHER").optional().describe("Publication status of the post"),
	type: z.enum("POST", "REPLY", "REPOST", "QUOTE", "EVENT", "OFFER", "ALERT", "STORY", "OTHER").optional().describe("The kind of post"),
	media: z.array().optional().describe("Media assets attached to the post"),
	url: z.string().optional().describe("Public permalink to the post"),
	language: z.string().optional().describe("Language code of the post content"),
	scheduled_at: z.string-time().optional().describe("When the post is scheduled to publish (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	call_to_action: z.object({
			type: z.enum("BOOK", "ORDER", "SHOP", "LEARN_MORE", "SIGN_UP", "CALL", "OTHER").optional().describe("The call-to-action button type"),
			url: z.string().optional().describe("The URL the call-to-action points to")
}).optional().describe("Call-to-action button on the post"),
	metrics: z.object({
			like_count: z.number().optional().describe("Number of likes/reactions"),
			comment_count: z.number().optional().describe("Number of comments/replies"),
			share_count: z.number().optional().describe("Number of shares/reposts"),
			quote_count: z.number().optional().describe("Number of quotes"),
			view_count: z.number().optional().describe("Number of views/impressions"),
			bookmark_count: z.number().optional().describe("Number of bookmarks/saves")
}).optional().describe("Engagement metrics for the post"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class SocialPostStatus(str, Enum):
	DRAFT = 'DRAFT'
	SCHEDULED = 'SCHEDULED'
	PUBLISHED = 'PUBLISHED'
	REJECTED = 'REJECTED'
	PROCESSING = 'PROCESSING'
	DELETED = 'DELETED'
	OTHER = 'OTHER'

@dataclasses.dataclass
class SocialPostType(str, Enum):
	POST = 'POST'
	REPLY = 'REPLY'
	REPOST = 'REPOST'
	QUOTE = 'QUOTE'
	EVENT = 'EVENT'
	OFFER = 'OFFER'
	ALERT = 'ALERT'
	STORY = 'STORY'
	OTHER = 'OTHER'

@dataclasses.dataclass
class SocialPostCall_to_actionType(str, Enum):
	BOOK = 'BOOK'
	ORDER = 'ORDER'
	SHOP = 'SHOP'
	LEARN_MORE = 'LEARN_MORE'
	SIGN_UP = 'SIGN_UP'
	CALL = 'CALL'
	OTHER = 'OTHER'

@dataclasses.dataclass
class PropertySocialPostCall_to_action:
	"""The call-to-action button type"""
	type: Optional[SocialPostCall_to_actionType]
	"""The URL the call-to-action points to"""
	url: Optional[str]

@dataclasses.dataclass
class PropertySocialPostMetrics:
	"""Number of likes/reactions"""
	like_count: Optional[int]
	"""Number of comments/replies"""
	comment_count: Optional[int]
	"""Number of shares/reposts"""
	share_count: Optional[int]
	"""Number of quotes"""
	quote_count: Optional[int]
	"""Number of views/impressions"""
	view_count: Optional[int]
	"""Number of bookmarks/saves"""
	bookmark_count: Optional[int]

@dataclasses.dataclass
class SocialPost:
	"""Unique identifier for the post"""
	id: Optional[str]
	"""When the post was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""When the post was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""The social profile (page/handle/listing) that owns this post"""
	profile_id: Optional[str]
	"""The post this one replies to or references"""
	parent_post_id: Optional[str]
	"""Optional post title/headline"""
	title: Optional[str]
	"""The main text content of the post"""
	body: Optional[str]
	"""Publication status of the post"""
	status: Optional[SocialPostStatus]
	"""The kind of post"""
	type: Optional[SocialPostType]
	"""Media assets attached to the post"""
	media: Optional[PropertySocialPostMedia]
	"""Public permalink to the post"""
	url: Optional[str]
	"""Language code of the post content"""
	language: Optional[str]
	"""When the post is scheduled to publish (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	scheduled_at: Optional[str]
	"""Call-to-action button on the post"""
	call_to_action: Optional[PropertySocialPostCall_to_action]
	"""Engagement metrics for the post"""
	metrics: Optional[PropertySocialPostMetrics]
Are we missing anything? Let us know
Was this page helpful?