import {z} from 'zod' export type StandardPinMetricTypes = 'IMPRESSION' | 'OUTBOUND_CLICK' | 'PIN_CLICK' | 'SAVE' | 'SAVE_RATE' | 'TOTAL_COMMENTS' | 'TOTAL_REACTIONS' | 'USER_FOLLOW' | 'PROFILE_VISIT'; export type VideoPinMetricTypes = 'IMPRESSION' | 'OUTBOUND_CLICK' | 'PIN_CLICK' | 'SAVE' | 'SAVE_RATE' | 'VIDEO_MRC_VIEW' | 'VIDEO_10S_VIEW' | 'QUARTILE_95_PERCENT_VIEW' | 'VIDEO_V50_WATCH_TIME' | 'VIDEO_START' | 'VIDEO_AVG_WATCH_TIME' | 'TOTAL_COMMENTS' | 'TOTAL_REACTIONS'; export type QuerypinanalyticsmetrictypesItems = StandardPinMetricTypes | VideoPinMetricTypes; export type GetApiPinsPinIdAnalyticsArgs = {pin_id: string, start_date: string, end_date: string, app_types?: ('ALL' | 'MOBILE' | 'TABLET' | 'WEB') | undefined, metric_types: Array, split_field?: ('NO_SPLIT' | 'APP_TYPE') | undefined, ad_account_id?: string | undefined}; export type GetApiPinsPinIdAnalyticsOptions = {baseUrl?: string | undefined, pinterestOauth2?: string | undefined, fetch?: typeof fetch | undefined}; export const dataStatus = z.enum(["PROCESSING", "READY", "ESTIMATE", "BEFORE_BUSINESS_CREATED", "BEFORE_DATA_RETENTION_PERIOD", "BEFORE_PIN_DATA_RETENTION_PERIOD", "BEFORE_METRIC_START_DATE", "BEFORE_CORE_METRIC_START_DATE", "BEFORE_PIN_FORMAT_METRIC_START_DATE", "BEFORE_AUDIENCE_METRIC_START_DATE", "BEFORE_AUDIENCE_MONTHLY_METRIC_START_DATE", "BEFORE_VIDEO_METRIC_START_DATE", "BEFORE_CONVERSION_METRIC_START_DATE", "PURCHASERS_METRIC_SMALLER_THAN_THRESHOLD", "IN_BAD_TAG_DATE", "BEFORE_PUBLISHED_METRIC_START_DATE", "BEFORE_ASSIST_METRIC_START_DATE", "BEFORE_PIN_CREATED", "BEFORE_ACCOUNT_CLAIMED", "BEFORE_DEMOGRAPHIC_FILTERS_START_DATE", "AUDIENCE_SEGMENT_SMALLER_THAN_THRESHOLD", "AUDIENCE_TOTAL_SMALLER_THAN_THRESHOLD", "BEFORE_PRODUCT_GROUP_FILTER_START_DATE"]); export const pinAnalyticsDailyMetrics = z.object({data_status: dataStatus.optional(), date: z.string().optional(), metrics: z.record(z.string(), z.number()).optional()}); export const pinAnalyticsMetricsResponse = z.object({daily_metrics: z.array(pinAnalyticsDailyMetrics).optional(), lifetime_metrics: z.record(z.string(), z.number().int()).optional(), summary_metrics: z.record(z.string(), z.number()).optional()}); export const pinAnalyticsResponse = z.record(z.string(), pinAnalyticsMetricsResponse); 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 }; /** * Get Pin analytics * * GET /pins/{pin_id}/analytics * * Also accepts auth: client_credentials */ export const getApiPinsPinIdAnalytics = async (args: GetApiPinsPinIdAnalyticsArgs, options?: GetApiPinsPinIdAnalyticsOptions) => { const {baseUrl = "https://api.pinterest.com/v5", fetch: fetchFn = fetch, pinterestOauth2} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.start_date != null) query.append("start_date", String(args.start_date)) if (args.end_date != null) query.append("end_date", String(args.end_date)) if (args.app_types != null) query.append("app_types", String(args.app_types)) if (args.metric_types != null) query.append("metric_types", args.metric_types.join(',')) if (args.split_field != null) query.append("split_field", String(args.split_field)) if (args.ad_account_id != null) query.append("ad_account_id", String(args.ad_account_id)) if (pinterestOauth2 !== undefined) headers.set('authorization', `Bearer ${pinterestOauth2}`) const url = `${baseUrl.replace(/\/+$/, '')}/pins/${encodeURIComponent(String(args.pin_id))}/analytics${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(pinAnalyticsResponse, await res.json()) };