import {z} from 'zod' export type GetApiV1ReportsBrandReportIdStatsArgs = {reportId: string, startDate: string, endDate: string, country: string, frequency?: ('daily' | 'weekly') | undefined, engines?: ('chatgpt' | 'google' | 'perplexity' | 'copilot' | 'google_ai_mode' | 'gemini' | 'claude' | Array<'chatgpt' | 'google' | 'perplexity' | 'copilot' | 'google_ai_mode' | 'gemini' | 'claude'>) | undefined, tagId?: string | undefined}; export type GetApiV1ReportsBrandReportIdStatsOptions = {baseUrl?: string | undefined, BearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const publicApiBrandReportStats = z.object({id: z.string(), status: z.string(), isRecalculating: z.boolean(), totalPrompts: z.number().int().gte(0), brand: z.object({brand: z.string(), brandDomain: z.string(), brandDomainWildcard: z.boolean().optional()}), summary: z.object({averageRank: z.number().nullable(), averagePosition: z.number().nullable(), totalMentions: z.number().int().gte(0), totalSources: z.number().int().gte(0), shareOfVoice: z.number(), brandCoverage: z.number(), domainCoverage: z.number()}), detectedBrands: z.array(z.object({name: z.string(), mentions: z.number()})), allBrandsAnalysis: z.object({brandMentions: z.array(z.object({brand: z.string(), isMainBrand: z.boolean(), rank: z.number(), mentions: z.number(), shareOfVoice: z.number(), brandCoverage: z.number()})), brandRankHistory: z.array(z.object({date: z.string(), brands: z.array(z.object({brand: z.string(), isMainBrand: z.boolean(), rank: z.number()}))})), brandCoverageHistory: z.array(z.object({date: z.string(), brands: z.array(z.object({brand: z.string(), isMainBrand: z.boolean(), logoUrl: z.string(), coverage: z.number()}))})), brandPositionHistory: z.array(z.object({date: z.string(), brands: z.array(z.object({brand: z.string(), isMainBrand: z.boolean(), position: z.number()}))})), brandVisibilityIndex: z.array(z.object({date: z.string(), brands: z.array(z.object({brand: z.string(), isMainBrand: z.boolean(), visibilityScore: z.number(), brandCoverage: z.number(), likelihoodToBuy: z.number()}))})), domainCoverageHistory: z.array(z.object({date: z.string(), domains: z.array(z.object({domain: z.string(), isMainBrand: z.boolean(), logoUrl: z.string(), coverage: z.number()}))}))}), competitorBrandsAnalysis: z.object({brandMentions: z.array(z.object({brand: z.string(), domain: z.string(), logoUrl: z.string(), isMainBrand: z.boolean(), mentions: z.number(), shareOfVoice: z.number(), brandCoverage: z.number(), domainCoverage: z.number(), domainCitations: z.number(), averageRank: z.number().nullable(), averagePosition: z.number().nullable(), visibilityScore: z.number(), likelihoodToBuy: z.number().nullable(), sentiment: z.object({positive: z.number(), neutral: z.number(), negative: z.number(), nss: z.number()}).nullable()})), brandCoverageHistory: z.array(z.object({date: z.string(), brands: z.array(z.object({brand: z.string(), isMainBrand: z.boolean(), logoUrl: z.string(), coverage: z.number()}))})), domainCoverageHistory: z.array(z.object({date: z.string(), domains: z.array(z.object({domain: z.string(), isMainBrand: z.boolean(), logoUrl: z.string(), coverage: z.number()}))})), brandVisibilityIndex: z.array(z.object({date: z.string(), brands: z.array(z.object({brand: z.string(), isMainBrand: z.boolean(), visibilityScore: z.number(), brandCoverage: z.number(), likelihoodToBuy: z.number()}))}))})}); 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 statistics for a brand report * * GET /v1/reports/brand/{reportId}/stats */ export const getApiV1ReportsBrandReportIdStats = async (args: GetApiV1ReportsBrandReportIdStatsArgs, options?: GetApiV1ReportsBrandReportIdStatsOptions) => { const {baseUrl = "https://data.otterly.ai", fetch: fetchFn = fetch, BearerAuth} = 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)) if (args.country != null) query.append("country", String(args.country)) if (args.frequency != null) query.append("frequency", String(args.frequency)) if (args.engines != null) query.append("engines", String(args.engines)) if (args.tagId != null) query.append("tagId", String(args.tagId)) if (BearerAuth !== undefined) headers.set('authorization', `Bearer ${BearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v1/reports/brand/${encodeURIComponent(String(args.reportId))}/stats${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(publicApiBrandReportStats, await res.json()) };