import {z} from 'zod' export type Pagination = {limit?: number | undefined, offset?: number | undefined}; export type RegionIdFilter = {field: 'region_id' | 'region', operator: 'is' | 'not_is' | 'in' | 'not_in', value: string | Array}; export type RegionNameFilter = {field: 'region_name', operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive', value: string | Array}; export type ModelIdFilter = {field: 'model_id' | 'model', operator: 'is' | 'not_is' | 'in' | 'not_in', value: string | Array}; export type TopicIdFilter = {field: 'topic_id' | 'topic', operator: 'is' | 'not_is' | 'in' | 'not_in', value: string | Array}; export type TopicNameFilter = {field: 'topic_name', operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive', value: string | Array}; export type ProfoundAnswerEngineInsightsFiltersAssetNameFilter = {field: 'asset_name', operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive', value: string | Array}; export type TagIdFilter = {field: 'tag_id' | 'tag', operator: 'is' | 'not_is' | 'in' | 'not_in', value: string | Array}; export type TagNameFilter = {field: 'tag_name', operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive', value: string | Array}; export type PromptIdFilter = {field: 'prompt_id', operator: 'is' | 'not_is' | 'in' | 'not_in', value: string | Array}; export type PromptFilter = {field: 'prompt', operator: 'is' | 'not_is' | 'in' | 'not_in' | 'contains' | 'not_contains' | 'matches' | 'contains_case_insensitive' | 'not_contains_case_insensitive', value: string | Array}; export type PersonaIdFilter = {field: 'persona_id', operator: 'is' | 'not_is' | 'in' | 'not_in', value: string | Array}; export type VisibilityQuery = {date_interval?: ('hour' | 'day' | 'week' | 'month' | 'quarter' | 'year' | 'relative_week') | undefined, dimensions?: (Array<'date' | 'region' | 'topic' | 'topic_id' | 'model' | 'asset_id' | 'asset_name' | 'prompt' | 'prompt_id' | 'tag' | 'persona'>) | undefined, metrics: Array<'share_of_voice' | 'mentions_count' | 'visibility_score' | 'executions' | 'average_position'>, order_by?: ({[key: string]: 'asc' | 'desc'}) | undefined, pagination?: Pagination | undefined, category_id: string, start_date: string, end_date: string, filters?: (Array) | undefined}; export type CreateApiV1ReportsVisibilityArgs = {body: VisibilityQuery}; export type CreateApiV1ReportsVisibilityOptions = {baseUrl?: string | undefined, APIKeyHeader?: string | undefined, fetch?: typeof fetch | undefined}; export const info = z.object({total_rows: z.number().int(), query: z.record(z.string(), z.unknown()).nullable().optional()}); export const result = z.object({metrics: z.array(z.union([z.number().int(), z.number()])), dimensions: z.array(z.union([z.string(), z.string()]))}); export const response = z.object({info: info, data: z.array(result)}); 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 }; /** * Query Visibility * * POST /v1/reports/visibility * * Also accepts auth: BearerAuth */ export const createApiV1ReportsVisibility = async (args: CreateApiV1ReportsVisibilityArgs, options?: CreateApiV1ReportsVisibilityOptions) => { const {baseUrl = "https://api.tryprofound.com", fetch: fetchFn = fetch, APIKeyHeader} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (APIKeyHeader !== undefined) headers.set("X-API-Key", APIKeyHeader) const url = `${baseUrl.replace(/\/+$/, '')}/v1/reports/visibility${query.size > 0 ? `?${query}` : ''}` const res = await fetchFn(url, {method: "POST", headers, body: JSON.stringify(args.body)}) if (!res.ok) throw new Error(`Request failed with status ${res.status}`, {cause: {status: res.status, body: await res.text()}}) return validateResponse(response, await res.json()) };