import {z} from 'zod' export type GetApiAdhawkMediaimpressionsArgs = {startDate?: string | undefined, endDate?: string | undefined, deviceId?: Array | undefined, fileId?: Array | undefined, minDwellThreshold?: number | undefined, limit?: number | undefined}; export type GetApiAdhawkMediaimpressionsOptions = {baseUrl?: string | undefined, Bearer?: string | undefined, fetch?: typeof fetch | undefined}; export const adHawkMediaImpressions = z.object({file_id: z.string().nullable().optional(), file_name: z.string().nullable().optional(), total_impressions: z.number().int().optional(), unique_device_count: z.number().int().optional(), net_reach: z.number().int().optional(), ots_percentage: z.number().nullable().optional(), ots_per_device: z.number().nullable().optional(), avg_dwell_time: z.number().nullable().optional(), male_count: z.number().int().optional(), female_count: z.number().int().optional(), unknown_gender_count: z.number().int().optional(), avg_age: z.number().nullable().optional()}); export const getApiAdhawkMediaimpressionsResponse = z.array(adHawkMediaImpressions); 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 }; /** * Gets media impressions (OTS - Opportunity To See) data aggregated by media file. * Joins audience/impression data with play logs to determine which audience members * had an opportunity to see specific media content during playback. * * GET /adhawk/mediaimpressions * * Also accepts auth: ApiKeyInHeader, ApiKeyInQuery */ export const getApiAdhawkMediaimpressions = async (args: GetApiAdhawkMediaimpressionsArgs, options?: GetApiAdhawkMediaimpressionsOptions) => { const {baseUrl = "https://api.reveldigital.com", fetch: fetchFn = fetch, Bearer} = 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.deviceId ?? []) query.append("deviceId", String(item)) for (const item of args.fileId ?? []) query.append("fileId", String(item)) if (args.minDwellThreshold != null) query.append("minDwellThreshold", String(args.minDwellThreshold)) if (args.limit != null) query.append("limit", String(args.limit)) if (Bearer !== undefined) headers.set('authorization', `Bearer ${Bearer}`) const url = `${baseUrl.replace(/\/+$/, '')}/adhawk/mediaimpressions${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(getApiAdhawkMediaimpressionsResponse, await res.json()) };