Get aggregated performance report for an experience

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
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

ID of the account that owns the retrieved/saved data

integer
required
≥ 1

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

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.
  • custom_dimension_breakdown: (Optional) A custom-dimension slot, 1 to 5, to break each goal down by value.

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
integer | null
1 to 5

Names one custom-dimension slot, 1 to 5, to break each goal down by value.
Omit or send null to skip the breakdown.

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.

number | null
0 to 4294967295

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.

number | null
0 to 4294967295

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

Conversion custom dimensions are stored only on conversion (hitGoal) and transaction (tr) events.
Each conversion_custom_dimension_N filter is applied when counting those events and is not applied
to visitor or bucketing (viewExp) events.
Website transactions recorded before the tracking script copies these dimensions onto the
transaction carry none, so filtered revenue for that period counts those transactions as zero.
Within one dimension, an event matches when it carries any listed value. Dimensions combine with AND.
Revenue and product counts are those of the whole matching transaction, not of the dimension value alone.
Requires the advanced segmentation plan function, the same as campaigns and custom segments.
Each value is matched exactly and is stored truncated to 32 characters.

stats_engine_processing

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

Headers
string

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

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json