Insight data model

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

FieldTypeRequiredDescription
idstringNoUnique identifier for the insight data point
created_atstring (date-time)NoWhen the insight was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
profile_idstringNoThe social profile these stats belong to
post_idstringNoOptional: the post these stats belong to
datestring (date-time)NoThe day/timestamp of the data point
periodenumNoThe aggregation period of the value Values: DAY, WEEK, MONTH, LIFETIME, TOTAL, OTHER
metricenumNoThe metric being reported Values: FOLLOWERS, FOLLOWING, POSTS, IMPRESSIONS, REACH, ENGAGEMENT, PROFILE_VIEWS, CLICKS, VIDEO_VIEWS, LIKES, COMMENTS, SHARES, SAVES, OTHER
valuenumberNoThe metric value

TypeScript

TypeScript
export type SocialInsight = {
	id?: string; // Unique identifier for the insight data point
	created_at?: string-time; // When the insight was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	profile_id?: string; // The social profile these stats belong to
	post_id?: string; // Optional: the post these stats belong to
	date?: string-time; // The day/timestamp of the data point
	period?: 'DAY' | 'WEEK' | 'MONTH' | 'LIFETIME' | 'TOTAL' | 'OTHER'; // The aggregation period of the value
	metric?: 'FOLLOWERS' | 'FOLLOWING' | 'POSTS' | 'IMPRESSIONS' | 'REACH' | 'ENGAGEMENT' | 'PROFILE_VIEWS' | 'CLICKS' | 'VIDEO_VIEWS' | 'LIKES' | 'COMMENTS' | 'SHARES' | 'SAVES' | 'OTHER'; // The metric being reported
	value?: number; // The metric value
	raw?: any; // Raw data from integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodSocialInsight = z.object({
	id: z.string().optional().describe("Unique identifier for the insight data point"),
	created_at: z.string-time().optional().describe("When the insight was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	profile_id: z.string().optional().describe("The social profile these stats belong to"),
	post_id: z.string().optional().describe("Optional: the post these stats belong to"),
	date: z.string-time().optional().describe("The day/timestamp of the data point"),
	period: z.enum("DAY", "WEEK", "MONTH", "LIFETIME", "TOTAL", "OTHER").optional().describe("The aggregation period of the value"),
	metric: z.enum("FOLLOWERS", "FOLLOWING", "POSTS", "IMPRESSIONS", "REACH", "ENGAGEMENT", "PROFILE_VIEWS", "CLICKS", "VIDEO_VIEWS", "LIKES", "COMMENTS", "SHARES", "SAVES", "OTHER").optional().describe("The metric being reported"),
	value: z.number().optional().describe("The metric value"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class SocialInsightPeriod(str, Enum):
	DAY = 'DAY'
	WEEK = 'WEEK'
	MONTH = 'MONTH'
	LIFETIME = 'LIFETIME'
	TOTAL = 'TOTAL'
	OTHER = 'OTHER'

@dataclasses.dataclass
class SocialInsightMetric(str, Enum):
	FOLLOWERS = 'FOLLOWERS'
	FOLLOWING = 'FOLLOWING'
	POSTS = 'POSTS'
	IMPRESSIONS = 'IMPRESSIONS'
	REACH = 'REACH'
	ENGAGEMENT = 'ENGAGEMENT'
	PROFILE_VIEWS = 'PROFILE_VIEWS'
	CLICKS = 'CLICKS'
	VIDEO_VIEWS = 'VIDEO_VIEWS'
	LIKES = 'LIKES'
	COMMENTS = 'COMMENTS'
	SHARES = 'SHARES'
	SAVES = 'SAVES'
	OTHER = 'OTHER'

@dataclasses.dataclass
class SocialInsight:
	"""Unique identifier for the insight data point"""
	id: Optional[str]
	"""When the insight was recorded (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The social profile these stats belong to"""
	profile_id: Optional[str]
	"""Optional: the post these stats belong to"""
	post_id: Optional[str]
	"""The day/timestamp of the data point"""
	date: Optional[str]
	"""The aggregation period of the value"""
	period: Optional[SocialInsightPeriod]
	"""The metric being reported"""
	metric: Optional[SocialInsightMetric]
	"""The metric value"""
	value: Optional[int]
Are we missing anything? Let us know
Was this page helpful?