:hedgehog: PostHog is the leading platform for building self-driving products. Our developer tools – AI observability, analytics, session replay, flags, experiments, error tracking, logs, and more – capture all the context agents need to diagnose problems, uncover opportunities, and ship fixes. Steer it all from Slack, web, desktop, or the MCP.
Python ab-testingai-analyticsanalyticscdpdata-warehouseexperimentsfeature-flagsjavascriptproduct-analyticspythonreactsession-replaysurveystypescriptweb-analytics
import type { z } from 'zod'
import { findRecoverableApiError, PostHogApiError, PostHogValidationError, wrapError } from '@/lib/errors'
import { withUiApp } from '@/resources/ui-apps'
import type { ExperimentResultsSummary } from '@/schema/experiments'
import { transformExperimentResults } from '@/schema/experiments'
import { ExperimentResultsGetSchema } from '@/schema/tool-inputs'
import { withPostHogUrl, type WithPostHogUrl } from '@/tools/tool-utils'
import type { Context, ToolBase } from '@/tools/types'
const schema = ExperimentResultsGetSchema
type Params = z.infer<typeof schema>
type Result = WithPostHogUrl<ExperimentResultsSummary>
/**
* Get experiment results including metrics and exposures data
* This tool fetches the experiment details and executes the necessary queries
* to get metrics results (both primary and secondary) and exposure data
*/
export const getResultsHandler: ToolBase<typeof schema, Result>['handler'] = async (
context: Context,
params: Params
) => {
const projectId = await context.stateManager.getProjectId()
const result = await context.api.experiments({ projectId }).getMetricResults({
experimentId: params.id,
refresh: params.refresh,
})
if (!result.success) {
const message = `Failed to get experiment results: ${result.error.message}`
// A 400 from /query/ means the exposure query was built wrong on this side. Dropping
// the typed cause keeps it out of handleToolError's 4xx short-circuit so it is still
// captured as an exception. Every other failure keeps its cause: a 404, 403 or 429
// is the agent's or the caller's to recover from.
const apiError = findRecoverableApiError(result.error)
const isOwnQueryBug =
apiError instanceof PostHogValidationError ||
(apiError instanceof PostHogApiError && apiError.status === 400)
throw isOwnQueryBug ? new Error(message) : wrapError(message, result.error)
}
const {
experiment,
primaryMetricEntries,
secondaryMetricEntries,
primaryMetricsResults,
secondaryMetricsResults,
exposures,
} = result.data
return withPostHogUrl(
context,
transformExperimentResults({
experiment,
primaryMetricEntries,
secondaryMetricEntries,
primaryMetricsResults,
secondaryMetricsResults,
exposures,
}),
`/experiments/${params.id}`
)
}
export default (): ToolBase<typeof schema, Result> =>
withUiApp('experiment-results', {
name: 'experiment-results-get',
schema,
handler: getResultsHandler,
})