The modern link attribution platform. Loved by world-class engineering teams at Twilio, Zillow, Jobber, Vercel, Raycast, and more.
TypeScript clickhousemysqlnextjsopen-sourceplanetscaleprismatailwindcsstinybirdtypescriptupstashvercel
import { getPaginationQuerySchema } from "@/lib/zod/schemas/misc";
import { tokenSchema } from "@/lib/zod/schemas/token";
import { UserSchema } from "@/lib/zod/schemas/users";
import * as z from "zod/v4";
import { sanitizeTimezone } from "../analytics/utils/sanitize-timezone";
import { parseDateSchema } from "../zod/schemas/utils";
import { API_LOGS_MAX_PAGE_SIZE } from "./constants";
export const requestTypeSchema = z.enum(["api", "webhook"]);
export const apiLogSchemaTB = z.object({
id: z.string(),
timestamp: z.string(),
method: z.string(),
path: z.string(),
route_pattern: z.string(),
status_code: z.number(),
duration: z.number(),
user_agent: z.string(),
request_body: z.string(),
query_params: z.string(),
response_body: z.string(),
token_id: z.string(),
user_id: z.string(),
request_type: requestTypeSchema,
});
// Schema for query filter params
export const apiLogFilterSchemaTB = z.object({
workspaceId: z.string(),
routePattern: z.string().optional(),
method: z.string().optional(),
statusCode: z.number().optional(),
tokenId: z.string().optional(),
requestId: z.string().optional(),
requestType: requestTypeSchema.optional(),
start: z.string().optional(),
end: z.string().optional(),
limit: z.number().optional(),
offset: z.number().optional(),
});
export const apiLogCountGroupBySchema = z.enum([
"routePattern",
"statusCode",
"method",
]);
export const apiLogCountFilterSchemaTB = apiLogFilterSchemaTB
.omit({
limit: true,
offset: true,
})
.extend({
groupBy: apiLogCountGroupBySchema.optional(),
});
// Raw Tinybird shape for the non-grouped count node
export const apiLogCountAggregateRowSchemaTB = z.object({
count: z.number(),
});
// Aggregate / routePattern grouping (aggregate uses routePattern `"all"`)
export const apiLogCountRowSchemas = {
routePattern: z.object({
routePattern: z.string(),
count: z.number(),
}),
statusCode: z.object({
statusCode: z.number(),
count: z.number(),
}),
method: z.object({
method: z.string(),
count: z.number(),
}),
} as const;
export const apiLogByIdFilterSchemaTB = z.object({
workspaceId: z.string(),
id: z.string(),
});
// Schema for enriched API log (with resolved token and user)
export const apiLogEnrichedSchema = apiLogSchemaTB.extend({
token: tokenSchema
.pick({
id: true,
name: true,
partialKey: true,
})
.nullable(),
user: UserSchema.nullable(),
});
export const getApiLogsQuerySchema = z
.object({
routePattern: z.string().optional(),
method: z.enum(["POST", "PATCH", "PUT", "DELETE"]).optional(),
statusCode: z.coerce.number().int().optional(),
tokenId: z.string().optional(),
requestId: z.string().optional(),
requestType: requestTypeSchema.optional(),
start: parseDateSchema.optional(),
end: parseDateSchema.optional(),
interval: z.enum(["24h", "7d", "30d", "60d", "90d"]).optional(),
timezone: z
.string()
.optional()
.overwrite((v) => (v === undefined ? undefined : sanitizeTimezone(v))),
exactRange: z.enum(["1", "true"]).optional(),
})
.extend(
getPaginationQuerySchema({
pageSize: API_LOGS_MAX_PAGE_SIZE,
}),
);
export const getApiLogsCountQuerySchema = getApiLogsQuerySchema
.omit({ page: true, pageSize: true })
.extend({
groupBy: apiLogCountGroupBySchema.optional(),
});
export const getApiLogsTimeseriesQuerySchema = getApiLogsCountQuerySchema.omit({
groupBy: true,
});
export const apiLogTimeseriesGranularitySchema = z.enum(["minute", "hour", "day"]);
export const apiLogTimeseriesFilterSchemaTB = apiLogFilterSchemaTB
.omit({
limit: true,
offset: true,
})
.extend({
timezone: z.string().optional(),
granularity: apiLogTimeseriesGranularitySchema.optional(),
});
export const apiLogTimeseriesRowSchema = z.object({
date: z.string(),
dateEnd: z.string(),
status2xx: z.number(),
status4xx: z.number(),
status5xx: z.number(),
statusOther: z.number(),
});