Report data model

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

Data Model
FieldTypeRequiredDescription
idstringNo
created_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
property_idstringNopoints to AnalyticsProperty
start_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
end_atstring (date-time)No(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
metricsAnalyticsReportMetrics[]No
metrics[].valuenumberNo
metrics[].typeenumNoTraffic metrics Values: USERS, NEW_USERS, SESSIONS, PAGE_VIEWS, UNIQUE_PAGE_VIEWS, SCREENS, EVENTS, AVERAGE_SESSION_DURATION, PAGES_PER_SESSION, BOUNCE_RATE, ENGAGEMENT_RATE, EVENTS_PER_SESSION, CONVERSIONS, CONVERSION_RATE, GOAL_COMPLETIONS, GOAL_VALUE, TRANSACTIONS, REVENUE, AVERAGE_ORDER_VALUE, ECOMMERCE_CONVERSION_RATE, SESSIONS_BY_SOURCE, USERS_BY_SOURCE, CONVERSIONS_BY_SOURCE, VIDEO_VIEWS, WATCH_TIME, AVERAGE_VIEW_DURATION, AVERAGE_VIEW_PERCENTAGE, LIKES, DISLIKES, COMMENTS, SHARES, SUBSCRIBERS_GAINED, SUBSCRIBERS_LOST
metrics[].dimensionenumNonew vs returning Values: DATE, HOUR, DAY_OF_WEEK, WEEK, MONTH, YEAR, PAGE, PAGE_TITLE, EVENT_NAME, SOURCE, MEDIUM, CAMPAIGN, COUNTRY, CITY, DEVICE_TYPE, BROWSER, OS, USER_TYPE, LANDING_PAGE, VIDEO
metrics[].dimension_valuestringNo

TypeScript

TypeScript
export type AnalyticsReport = {
	id?: string;
	created_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	property_id?: string; // points to AnalyticsProperty
	start_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	end_at?: string-time; // (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	metrics?: [];
	raw?: any;
}

Zod

Zod
import { z } from 'zod';

export const ZodAnalyticsReport = z.object({
	id: z.string().optional(),
	created_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	property_id: z.string().optional().describe("points to AnalyticsProperty"),
	start_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	end_at: z.string-time().optional().describe("(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	metrics: z.array().optional(),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class AnalyticsReport:
	id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""points to AnalyticsProperty"""
	property_id: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	start_at: Optional[str]
	"""(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	end_at: Optional[str]
	metrics: Optional[PropertyAnalyticsReportMetrics]
Are we missing anything? Let us know
Was this page helpful?