Experimentation - Get Latest Scorecard

Service:

Experimentation

API Version:

240426

Gets the latest scorecard of the experiment for the title.

POST https://titleId.playfabapi.com/Experimentation/GetLatestScorecard

Request Header

Name	Required	Type	Description
X-EntityToken	True	string	This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Request Body

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ExperimentId	string	The ID of the experiment.

Responses

Name	Type	Description
200 OK	GetLatestScorecardResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-EntityToken

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Type: apiKey
In: header

Definitions

Name	Description
AnalysisTaskState
ApiErrorWrapper	The basic wrapper around every failed API response
GetLatestScorecardRequest	Given a title entity token and experiment details, will return the latest available scorecard.
GetLatestScorecardResult
MetricData
Scorecard
ScorecardDataRow

AnalysisTaskState

Name	Type	Description
Canceled	string
Completed	string
Failed	string
ReadyForSubmission	string
Running	string
SubmittingToPipeline	string
Waiting	string

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

GetLatestScorecardRequest

Given a title entity token and experiment details, will return the latest available scorecard.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
ExperimentId	string	The ID of the experiment.

GetLatestScorecardResult

Name	Type	Description
Scorecard	Scorecard	Scorecard for the experiment of the title.

MetricData

Name	Type	Description
ConfidenceIntervalEnd	number	The upper bound of the confidence interval for the relative delta (Delta.RelativeValue).
ConfidenceIntervalStart	number	The lower bound of the confidence interval for the relative delta (Delta.RelativeValue).
DeltaAbsoluteChange	number	The absolute delta between TreatmentStats.Average and ControlStats.Average.
DeltaRelativeChange	number	The relative delta ratio between TreatmentStats.Average and ControlStats.Average.
InternalName	string	The machine name of the metric.
Movement	string	Indicates if a movement was detected on that metric.
Name	string	The readable name of the metric.
PMove	number	The expectation that a movement is real
PValue	number	The p-value resulting from the statistical test run for this metric
PValueThreshold	number	The threshold for observing sample ratio mismatch.
StatSigLevel	string	Indicates if the movement is statistically significant.
StdDev	number	Observed standard deviation value of the metric.
Value	number	Observed average value of the metric.

Scorecard

Name	Type	Description
DateGenerated	string	Represents the date the scorecard was generated.
Duration	string	Represents the duration of scorecard analysis.
EventsProcessed	number	Represents the number of events processed for the generation of this scorecard
ExperimentId	string	Id of the experiment.
ExperimentName	string	Friendly name of the experiment.
LatestJobStatus	AnalysisTaskState	Represents the latest compute job status.
SampleRatioMismatch	boolean	Represents the presence of a sample ratio mismatch in the scorecard data.
ScorecardDataRows	ScorecardDataRow[]	Scorecard containing list of analysis.

ScorecardDataRow

Name	Type	Description
IsControl	boolean	Represents whether the variant is control or not.
MetricDataRows	MetricData	Data of the analysis with the internal name of the metric as the key and an object of metric data as value.
PlayerCount	number	Represents the player count in the variant.
VariantName	string	Name of the variant of analysis.

Error Codes

Name	Code
ExperimentationExperimentNotFound	7002
ExperimentationNoScorecard	7009
FeatureNotConfiguredForTitle	1177