KAkameleoon
Experiment

Request experiment's results

Send a POST request to generate a results report for the given experiment. This endpoint returns a dataCode hash — not the results themselves. Pass the dataCode to the result endpoint to retrieve the actual data. For a full walkthrough, see Retrieving experiment results using the Automation API.

post/experiments/{experimentId}/results

Request

Path parameters

experimentIdinteger required

Request body

visitorDataboolean

Set to true to only include data from unique visitors. By default, the report includes all visitor data.

allVariationsDataboolean

Set to true to include data from all variations at once.

bayesianboolean

Enables the current Bayesian result probability for the experiment in the report.

sequentialTestingboolean

Enables the sequential testing result for the experiment in the report.

enabledMultipleTestingboolean

Enables multiple testing correction for the experiment in the report.

referenceVariationIdstring

Unique ID of the variation that you want to use as the reference variation.

goalsIdsinteger[]

Specifies which goals to include in the report. Use an empty list [] to exclude all goals. Use null to include all goals. Use a list of goal IDs [123, 456] to include only those goals.

goalIdsCupedinteger[]

Specifies which CUPED goals to include in the report. Use an empty list [] to exclude all CUPED goals. Use null to include all CUPED goals. Use a list of CUPED goal IDs [123, 456] to include only those goals.

conversionType'ALL_CONVERSION' | 'CONVERTED_VISITS' required

Type of conversions to use for calculating reliability, improvement rate and etc

callbackUrlstring

Callback URL that you want to send the data response to.

Response

OK

dataCodestring

Hash code containing information about the data request, such as dates, goals, variations, format, filters, and so on. Use this code in the AudienceController#poll or DataController functions to obtain actual results. There are two possible formats for the code, depending on the context: 123...123 or 123...123|123...123. For example, AudienceController#global generates the latter.

Example response

{
  "dataCode": "89599333501501534304101214660291496129464311669540935471556471877530843827432"
}

Changes

No recorded changes to this operation across all 1 revision of this API.