import {z} from 'zod' export type ProductAnalyticsJourneyFunnelCompute = {aggregation?: string | undefined, metric?: string | undefined}; export type QuerySortOrder = 'asc' | 'desc'; export type ProductAnalyticsGroupBySort = {aggregation?: string | undefined, metric?: string | undefined, order?: QuerySortOrder | undefined}; export type ProductAnalyticsGraphQueryGroupBySource = 'product_analytics_audience_filters.users' | 'product_analytics_audience_filters.accounts'; export type ProductAnalyticsJourneyNodeTargetType = 'node'; export type ProductAnalyticsJourneyNodeTarget = {type: ProductAnalyticsJourneyNodeTargetType, value: string}; export type ProductAnalyticsJourneyPathTargetType = 'path'; export type ProductAnalyticsJourneyPathTarget = {end: string, start: string, type: ProductAnalyticsJourneyPathTargetType}; export type ProductAnalyticsJourneyTarget = ProductAnalyticsJourneyNodeTarget | ProductAnalyticsJourneyPathTarget; export type ProductAnalyticsGraphQueryGroupBy = {facet: string, limit?: number | undefined, should_exclude_missing?: boolean | undefined, sort?: ProductAnalyticsGroupBySort | undefined, source?: ProductAnalyticsGraphQueryGroupBySource | undefined, target?: ProductAnalyticsJourneyTarget | undefined, value_filters?: Array | undefined}; export type ProductAnalyticsJourneyAudienceAccountQuery = {name: string, query?: string | undefined}; export type ProductAnalyticsJourneyAudienceSegmentQuery = {name: string, segment_id: string}; export type ProductAnalyticsJourneyAudienceUserQuery = {name: string, query?: string | undefined}; export type ProductAnalyticsJourneyAudienceFilters = {accounts?: Array | undefined, formula?: string | undefined, segments?: Array | undefined, users?: Array | undefined}; export type ProductAnalyticsJourneySearchGraphFilterName = '__dd.time_to_convert' | '__dd.session' | '__dd.dropoff_rate'; export type ProductAnalyticsJourneySearchGraphFilterOperator = '=' | '<' | '>' | '<=' | '>='; export type ProductAnalyticsJourneySearchGraphFilter = {name: ProductAnalyticsJourneySearchGraphFilterName, operator: ProductAnalyticsJourneySearchGraphFilterOperator, target?: ProductAnalyticsJourneyTarget | undefined, value: number}; export type ProductAnalyticsJourneySearchFilters = {audience_filters?: ProductAnalyticsJourneyAudienceFilters | undefined, graph_filters?: Array | undefined, string_filter?: string | undefined}; export type ProductAnalyticsJoinKeys = {primary?: string | undefined, secondary?: Array | undefined}; export type ProductAnalyticsEventQueryDataSource = 'product_analytics'; export type ProductAnalyticsEventSearch = {query?: string | undefined}; export type ProductAnalyticsEventQuery = {data_source: ProductAnalyticsEventQueryDataSource, search: ProductAnalyticsEventSearch}; export type ProductAnalyticsOccurrenceQueryDataSource = 'product_analytics_occurrence'; export type ProductAnalyticsOccurrenceFilter = {meta?: {[key: string]: string} | undefined, operator: string, value: string}; export type ProductAnalyticsOccurrenceSearch = {occurrences?: ProductAnalyticsOccurrenceFilter | undefined, query?: string | undefined}; export type ProductAnalyticsOccurrenceQuery = {data_source: ProductAnalyticsOccurrenceQueryDataSource, search: ProductAnalyticsOccurrenceSearch}; export type ProductAnalyticsBaseQuery = ProductAnalyticsEventQuery | ProductAnalyticsOccurrenceQuery; export type ProductAnalyticsJourneySearch = {expression: string, filters?: ProductAnalyticsJourneySearchFilters | undefined, join_keys?: ProductAnalyticsJoinKeys | undefined, node_objects: {[key: string]: ProductAnalyticsBaseQuery}}; export type ProductAnalyticsJourneyFunnelQuery = {compute?: ProductAnalyticsJourneyFunnelCompute | undefined, group_by?: Array | undefined, search: ProductAnalyticsJourneySearch}; export type ProductAnalyticsJourneyFunnelRequestAttributes = {exclude_anonymous_traffic?: boolean | undefined, from: number, query: ProductAnalyticsJourneyFunnelQuery, to: number}; export type ProductAnalyticsJourneyRequestType = 'journey_request'; export type ProductAnalyticsJourneyFunnelRequestData = {attributes: ProductAnalyticsJourneyFunnelRequestAttributes, type: ProductAnalyticsJourneyRequestType}; export type ProductAnalyticsJourneyFunnelRequest = {data: ProductAnalyticsJourneyFunnelRequestData}; export type CreateApiApiV2ProductAnalyticsJourneyFunnelArgs = {body: ProductAnalyticsJourneyFunnelRequest}; export type CreateApiApiV2ProductAnalyticsJourneyFunnelOptions = {baseUrl?: string | undefined, apiKeyAuth?: string | undefined, appKeyAuth?: string | undefined, fetch?: typeof fetch | undefined}; export const productAnalyticsElapsedTime = z.object({avg: z.number().int(), max: z.number().int(), min: z.number().int()}); export const productAnalyticsJourneyFunnelStepGroup = z.object({conversion_count: z.number().int(), elapsed_time_to_next_step: productAnalyticsElapsedTime, group_tags: z.array(z.string()), value: z.number()}); export const productAnalyticsJourneyFunnelStep = z.object({elapsed_time_to_next_step: productAnalyticsElapsedTime, groups: z.array(productAnalyticsJourneyFunnelStepGroup), label: z.string(), unit: z.string(), value: z.number()}); export const productAnalyticsJourneyFunnelResponseAttributes = z.object({end_to_end_conversion_rate: z.number(), end_to_end_elapsed_time: productAnalyticsElapsedTime, funnel_steps: z.array(productAnalyticsJourneyFunnelStep), initial_count: z.number().int()}); export const productAnalyticsJourneyFunnelResponseType = z.literal("funnel_response"); export const productAnalyticsJourneyFunnelResponseData = z.object({attributes: productAnalyticsJourneyFunnelResponseAttributes, id: z.string(), type: productAnalyticsJourneyFunnelResponseType}); export const productAnalyticsJourneyFunnelResponse = z.object({data: productAnalyticsJourneyFunnelResponseData}); 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 }; /** * Compute journey funnel analysis * * POST /api/v2/product-analytics/journey/funnel * * Also accepts auth: AuthZ */ export const createApiApiV2ProductAnalyticsJourneyFunnel = async (args: CreateApiApiV2ProductAnalyticsJourneyFunnelArgs, options?: CreateApiApiV2ProductAnalyticsJourneyFunnelOptions) => { const {baseUrl = "https://api.datadoghq.com", fetch: fetchFn = fetch, apiKeyAuth, appKeyAuth} = options ?? {} const query = new URLSearchParams() const headers = new Headers() headers.set('content-type', "application/json") headers.set('accept', "application/json") if (apiKeyAuth !== undefined) headers.set("DD-API-KEY", apiKeyAuth) if (appKeyAuth !== undefined) headers.set("DD-APPLICATION-KEY", appKeyAuth) const url = `${baseUrl.replace(/\/+$/, '')}/api/v2/product-analytics/journey/funnel${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(productAnalyticsJourneyFunnelResponse, await res.json()) };