Get aggregated performance report for an experience

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/experiences/{experience_id}/aggregated_report

Retrieves the main performance report for a specific experience. This report shows aggregated data for each variation, including visitor counts, conversions, conversion rates, improvement percentages, and statistical confidence (or chance to win for Bayesian). Data is provided for all goals attached to the experience. Supports filtering by date range and segments. The Knowledge Base article "Experiment Report" details the metrics shown.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project to which save/retrieved data is connected

experience_id

integer

required

ID of the experience

Body Params

Parameters to customize the aggregated performance report for an experience. Key parameters include:

start_time, end_time, utc_offset: Define the reporting period.
segments: Apply filters based on visitor characteristics (e.g., device, browser, country, custom segments).
stats_engine_processing: Configure statistical settings like confidence level, test type (one-tail/two-tails), MAB strategy, and MDE for Frequentist; or decision/risk thresholds for Bayesian.
goals: (Optional) List of specific goal IDs to include in the report. If omitted, all goals attached to the experience are reported.
metrics: (Optional) List of specific metrics (e.g., 'conversion_rate', 'avg_revenue_visitor') to calculate and display.

Base Parameters needed to drill down the reports.

goals

array of integers | null

A list of goal Id's for which to return the reporting data.

If no ID is provided, the list of goals attached to the experience is being used;

goals

metrics

array of objects | null

The list of metrics to return. If not provided, all available metrics will be returned.

metrics

utc_offset

integer

-43200 to 50400

Defaults to 0

The time offset from Coordinated Universal Time (UTC) in seconds. For example, UTC-5 (EST) would be -18000. UTC+2 would be 7200. Used for interpreting or displaying date/time information according to a specific timezone.

start_time

number | null

Unix timestamp (seconds since epoch) for the beginning of the reporting period. If null, data from the experience start is typically used. Should be interpreted with utc_offset.

end_time

number | null

Unix timestamp (seconds since epoch) for the end of thereporting period. If null, data up to the current time is typically used. Should be interpreted with utc_offset.

segments

object

A collection of filters used to segment experience report data based on various visitor attributes and traffic sources. Applying these filters allows for deeper analysis of how different user groups interact with experience variations. Knowledge Base: "Using Basic and Advanced Post segmentation".

stats_engine_processing

Overall settings for the statistical engine processing results for this experience.

Headers

report_token

string

Token to access the experience report in read-only mode.

Responses

200The main performance report for an experience, showing aggregated data (visitors, conversions, conversion rate, improvement, confidence/chance to win) for each variation, broken down by all attached goals.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.