import {z} from 'zod' export type GetApiV2CampaignsPerformanceArgs = {startDate: string, endDate: string, metrics: Array, instanceIds?: Array | undefined, campaignIds?: Array | undefined, platform?: (Array<'instagram' | 'tiktok' | 'facebook' | 'youtube' | 'twitter' | 'linkedin' | 'pinterest' | 'snapchat' | 'blog' | 'twitch'>) | undefined, contentType?: (Array<'instagram_post' | 'instagram_reel' | 'instagram_story' | 'facebook_post' | 'facebook_live' | 'facebook_group' | 'facebook_reel' | 'tiktok' | 'youtube_video' | 'youtube_shorts' | 'twitter' | 'linkedin' | 'pinterest' | 'snapchat_story' | 'blog' | 'twitch_stream'>) | undefined, dateBasis?: ('post_date' | 'performance_date') | undefined, limit?: number | undefined, nextCursor?: (string | null) | undefined, sortProperty?: string | undefined, sortDirection?: ('ASC' | 'DESC') | undefined}; export type GetApiV2CampaignsPerformanceOptions = {baseUrl?: string | undefined, JWT?: string | undefined, fetch?: typeof fetch | undefined}; export const campaignMetricsDto = z.object({affiliateLinksClicks: z.number().nullable().optional(), affiliateLinksCommissionEarned: z.number().nullable().optional(), affiliateLinksConversionRate: z.number().nullable().optional(), affiliateLinksConversions: z.number().nullable().optional(), affiliateLinksRoi: z.number().nullable().optional(), affiliateLinksSales: z.number().nullable().optional(), clicks: z.number().nullable().optional(), comments: z.number().nullable().optional(), cpe: z.number().nullable().optional(), cpm: z.number().nullable().optional(), crosspostedFacebookOnlyViews: z.number().nullable().optional(), crosspostedViews: z.number().nullable().optional(), engagementRate: z.number().nullable().optional(), engagements: z.number().nullable().optional(), estimatedContentCost: z.number().nullable().optional(), estimatedRoi: z.number().nullable().optional(), estimatedValueGenerated: z.number().nullable().optional(), impressions: z.number().nullable().optional(), impressionsPerPost: z.number().nullable().optional(), influencersCount: z.number().nullable().optional(), likes: z.number().nullable().optional(), organicReach: z.number().nullable().optional(), paidAdSpend: z.number().nullable().optional(), paidClicks: z.number().nullable().optional(), paidComments: z.number().nullable().optional(), paidCost: z.number().nullable().optional(), paidCpe: z.number().nullable().optional(), paidCpm: z.number().nullable().optional(), paidEngagementRate: z.number().nullable().optional(), paidEngagements: z.number().nullable().optional(), paidImpressions: z.number().nullable().optional(), paidInfluencersCount: z.number().nullable().optional(), paidInitialPlays: z.number().nullable().optional(), paidLikes: z.number().nullable().optional(), paidPostsCount: z.number().nullable().optional(), paidReach: z.number().nullable().optional(), paidReturnOnAdSpend: z.number().nullable().optional(), paidSaves: z.number().nullable().optional(), paidShares: z.number().nullable().optional(), paidViews: z.number().nullable().optional(), postsCount: z.number().nullable().optional(), potentialReach: z.number().nullable().optional(), reach: z.number().nullable().optional(), replies: z.number().nullable().optional(), reposts: z.number().nullable().optional(), saves: z.number().nullable().optional(), shares: z.number().nullable().optional(), totalInteractions: z.number().nullable().optional(), trackingLinksClicks: z.number().nullable().optional(), trackingLinksConversionValue: z.number().nullable().optional(), trackingLinksConversions: z.number().nullable().optional(), videoViewTotalTime: z.number().nullable().optional(), views: z.number().nullable().optional()}); export const campaignPerformanceResponseDto = z.object({campaignId: z.number(), campaignName: z.string().nullable(), description: z.string().nullable(), firstPostDate: z.string().nullable(), instanceId: z.string(), lastPostDate: z.string().nullable(), metrics: campaignMetricsDto, uniqueContentTypes: z.array(z.string()).nullable()}); export const getApiV2CampaignsPerformanceResponse = z.object({data: z.array(campaignPerformanceResponseDto), nextCursor: z.string().nullable()}); export const validateResponse = async ( schema: { readonly '~standard': { readonly validate: (value: unknown) => ({ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }) | Promise<{ readonly value: Output; readonly issues?: undefined } | { readonly issues: ReadonlyArray<{ readonly message: string; readonly path?: ReadonlyArray | undefined }> }> } }, value: unknown ): Promise => { const result = await schema['~standard'].validate(value) if (result.issues !== undefined) { const detail = result.issues .map(({ message, path }) => path?.length ? `${path.map((segment) => String(typeof segment === 'object' ? segment.key : segment)).join('.')}: ${message}` : message ) .join('; ') throw new Error(`Response does not match the schema: ${detail}`, { cause: { issues: result.issues } }) } return result.value }; /** * Campaign performance metrics * * GET /v2/campaigns/performance */ export const getApiV2CampaignsPerformance = async (args: GetApiV2CampaignsPerformanceArgs, options?: GetApiV2CampaignsPerformanceOptions) => { const {baseUrl = "https://reporting.api.later.com", fetch: fetchFn = fetch, JWT} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.startDate != null) query.append("startDate", String(args.startDate)) if (args.endDate != null) query.append("endDate", String(args.endDate)) for (const item of args.metrics ?? []) query.append("metrics", String(item)) for (const item of args.instanceIds ?? []) query.append("instanceIds", String(item)) for (const item of args.campaignIds ?? []) query.append("campaignIds", String(item)) for (const item of args.platform ?? []) query.append("platform", String(item)) for (const item of args.contentType ?? []) query.append("contentType", String(item)) if (args.dateBasis != null) query.append("dateBasis", String(args.dateBasis)) if (args.limit != null) query.append("limit", String(args.limit)) if (args.nextCursor != null) query.append("nextCursor", String(args.nextCursor)) if (args.sortProperty != null) query.append("sortProperty", String(args.sortProperty)) if (args.sortDirection != null) query.append("sortDirection", String(args.sortDirection)) if (JWT !== undefined) headers.set('authorization', `Bearer ${JWT}`) const url = `${baseUrl.replace(/\/+$/, '')}/v2/campaigns/performance${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "GET", headers}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(getApiV2CampaignsPerformanceResponse, await res.json()) };