Class GetExperimentResultsCommandProtected

Retrieves the results of a running or completed experiment. No results are available until there have been 100 events for each variation and at least 10 minutes have passed since the start of the experiment. To increase the statistical power, Evidently performs an additional offline p-value analysis at the end of the experiment. Offline p-value analysis can detect statistical significance in some cases where the anytime p-values used during the experiment do not find statistical significance.

Experiment results are available up to 63 days after the start of the experiment. They are not available after that because of CloudWatch data retention policies.

Example

Use a bare-bones client and the command you need to make an API call.

import { EvidentlyClient, GetExperimentResultsCommand } from "@aws-sdk/client-evidently"; // ES Modules import
// const { EvidentlyClient, GetExperimentResultsCommand } = require("@aws-sdk/client-evidently"); // CommonJS import
const client = new EvidentlyClient(config);
const input = { // GetExperimentResultsRequest
  project: "STRING_VALUE", // required
  experiment: "STRING_VALUE", // required
  startTime: new Date("TIMESTAMP"),
  endTime: new Date("TIMESTAMP"),
  metricNames: [ // MetricNameList // required
    "STRING_VALUE",
  ],
  treatmentNames: [ // TreatmentNameList // required
    "STRING_VALUE",
  ],
  baseStat: "STRING_VALUE",
  resultStats: [ // ExperimentResultRequestTypeList
    "STRING_VALUE",
  ],
  reportNames: [ // ExperimentReportNameList
    "STRING_VALUE",
  ],
  period: Number("long"),
};
const command = new GetExperimentResultsCommand(input);
const response = await client.send(command);
// { // GetExperimentResultsResponse
//   resultsData: [ // ExperimentResultsDataList
//     { // ExperimentResultsData
//       metricName: "STRING_VALUE",
//       treatmentName: "STRING_VALUE",
//       resultStat: "STRING_VALUE",
//       values: [ // DoubleValueList
//         Number("double"),
//       ],
//     },
//   ],
//   reports: [ // ExperimentReportList
//     { // ExperimentReport
//       metricName: "STRING_VALUE",
//       treatmentName: "STRING_VALUE",
//       reportName: "STRING_VALUE",
//       content: "STRING_VALUE",
//     },
//   ],
//   timestamps: [ // TimestampList
//     new Date("TIMESTAMP"),
//   ],
//   details: "STRING_VALUE",
// };

Param

GetExperimentResultsCommandInput

Returns

GetExperimentResultsCommandOutput

See

• GetExperimentResultsCommandInput for command's input shape.
• GetExperimentResultsCommandOutput for command's response shape.
• config for EvidentlyClient's config shape.

Throws

AccessDeniedException (client fault)

You do not have sufficient permissions to perform this action.

Throws

ConflictException (client fault)

A resource was in an inconsistent state during an update or a deletion.

Throws

ResourceNotFoundException (client fault)

The request references a resource that does not exist.

Throws

ThrottlingException (client fault)

The request was denied because of request throttling. Retry the request.

Throws

ValidationException (client fault)

The value of a parameter in the request caused an error.

Throws

EvidentlyServiceException

Base exception class for all service exceptions from Evidently service.