import {z} from 'zod' export type GetApiV3RankTrackingKeywordTimelineArgs = {teamId?: string | undefined, keyword?: string | undefined, trackedKeywordId?: string | undefined, startDate?: string | undefined, endDate?: string | undefined, days?: number | undefined}; export type GetApiV3RankTrackingKeywordTimelineOptions = {baseUrl?: string | undefined, bearerAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const getApiV3RankTrackingKeywordTimelineResponse = z.object({success: z.boolean().optional(), keyword: z.string().optional(), trackedKeywordId: z.string().optional(), countryId: z.string().nullable().optional(), locationCanonicalName: z.string().nullable().optional(), brandDomain: z.string().nullable().optional(), startDate: z.string().optional(), endDate: z.string().optional(), events: z.array(z.object({date: z.string().optional(), type: z.string().optional(), direction: z.string().optional(), summary: z.string().optional(), position: z.number().optional(), previousPosition: z.number().optional(), domain: z.string().optional(), urls: z.array(z.string()).optional(), volatility: z.number().optional(), feature: z.string().optional()})).optional(), volatility: z.array(z.object({date: z.string().optional(), score: z.number().optional()})).optional(), tenure: z.object({daysTracked: z.number().optional(), daysInTop3: z.number().optional(), daysInTop10: z.number().optional(), bestPosition: z.number().nullable().optional(), bestPositionDate: z.string().nullable().optional(), firstSeen: z.string().nullable().optional(), currentTop10Streak: z.number().optional()}).optional()}); 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 }; /** * Keyword timeline * * GET /v3/rank-tracking/keyword-timeline * * Also accepts auth: apiKey */ export const getApiV3RankTrackingKeywordTimeline = async (args: GetApiV3RankTrackingKeywordTimelineArgs, options?: GetApiV3RankTrackingKeywordTimelineOptions) => { const {baseUrl = "https://api.snowseo.com", fetch: fetchFn = fetch, bearerAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('accept', "application/json") if (args.teamId != null) query.append("teamId", String(args.teamId)) if (args.keyword != null) query.append("keyword", String(args.keyword)) if (args.trackedKeywordId != null) query.append("trackedKeywordId", String(args.trackedKeywordId)) if (args.startDate != null) query.append("startDate", String(args.startDate)) if (args.endDate != null) query.append("endDate", String(args.endDate)) if (args.days != null) query.append("days", String(args.days)) if (bearerAuth !== undefined) headers.set('authorization', `Bearer ${bearerAuth}`) const url = `${baseUrl.replace(/\/+$/, '')}/v3/rank-tracking/keyword-timeline${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(getApiV3RankTrackingKeywordTimelineResponse, await res.json()) };