Send an Authenticated Experimentation Assignment Request

Place authenticated requests for experiment cohort assignments based on data derived from Salesforce Data 360 through an authenticated endpoint.

POST /experimentation/v1/authenticated/assignment

To authenticate your request, provide a Data 360 access token in the header. For instructions on generating an access token, see Data 360 Developer Guide: Quick Start.

Media type: application/json

ParameterTypeDescription
contextObjectDetails regarding the context from which the request is taking place.
experimentsArray of StringsAn array of experiment API names or platform IDs in the corresponding dataspace referenced in the context.
experimentsOverrideString of ObjectOptional. Test or preview specific experiment variants by forcing an assignment for a user, bypassing the normal evaluation process. This object requires an experiment (ID or API name) and a cohortId (the specific variant). This override only functions when the TestMode flag is included in executionFlags.
profileObjectOptional. A Data 360 Hot Layer Profile.
  • Full profile: The API skips the Data 360 lookup.
  • Partial profile: The API merges this data with the existing Data 360 profile. If keys match, this request’s value takes priority.
executionFlagsArray of StringsModifiers that change how the request is processed. Supported values:
  • TestMode: Evaluate assignments without saving data to the lake.
  • ContextOnly: Skip the profile lookup.
  • EnableDiagnostics: Include troubleshooting data in the response.
  • IncludeUnstartedExperiment: Show experiments that haven't launched (requires authentication).

Media type: application/json

ParameterTypeDescription
Response ArrayArrayA list of one or more experiment responses, based on the number of experiment references specified in the request.
experimentStringThe Platform ID of the Experiment.
variableAssignmentsArrayVariable assignments for the experiment. Simple experiments contain one response; multivariate experiments contain nested assignments.
variableAssignments.variableIdStringThe ID of the assigned cohort. For simple experiments, this matches the cohortId in the attributes object that follows.
variableAssignments.experimentIdStringThe Platform ID of the Experiment.
variableAssignments.experimentNameStringThe API name of the Experiment.
variableAssignments.dataStringAn optional array of data that can be returned along with the cohort assignment. This is dependent on the response template you chose when designing the experiment.
variableAssignments.attributesArrayAn array of attributes that can be returned with the cohort assignment. The attributes returned vary depending on the template you chose when designing the experiment.
diagnosticsArrayInformation about errors or warnings encountered during processing.
diagnostics.codeStringThe error code.
diagnostics.descriptionStringA detailed message describing the error.
requestIdStringThe unique identifier for the request and response.

Details regarding the context from which the request is taking place.

ParameterTypeDescription
individualIdStringThe Individual ID associated with a Data 360 Profile.
dataspaceStringThe data space that defines the boundary of an experimentation context.
ParameterTypeDescription
variableIdStringThe parent cohort ID for multivariate experiments. For simple experiments, this matches the cohortId.
experimentIdStringThe Platform ID of the Experiment.
experimentNameStringThe API Name of the Experiment.
dataStringOptional data returned with the cohort assignment based on the response template.
attributesArrayAttributes returned with the cohort assignment based on the response template.

A request for one or more experiment assignments for an individual. If values conflict between context, events, and profile, context takes precedence.

ParameterTypeDescription
contextObjectDetails regarding the context from which the request is taking place.
experimentsArray of StringsArray of experiment API names or platform IDs in the corresponding dataspace referenced in the context.
executionFlagsArray of StringsEnumerated values:
  • TestMode: Indicates whether the call is operating in test mode. In this mode, no outputs are recorded to the data lake.
ParameterTypeDescription
Response ArrayArrayA list of one or more experiment responses, based on the number of experiment references specified in the request.
experimentStringThe Platform ID of the Experiment.
variableAssignmentsArrayVariable assignments for the experiment. Simple experiments contain one response, and multivariate experiments contain nested assignments.
variableAssignments.variableIdStringThe ID of the assigned cohort. For simple experiments, this matches the cohortId in the attributes object that follows.
variableAssignments.experimentIdStringThe Platform ID of the Experiment.
variableAssignments.experimentNameStringThe API name of the Experiment.
variableAssignments.dataStringAn optional array of data that can be returned with the cohort assignment. This is dependent on the response template you chose when designing the experiment.
variableAssignments.attributesArrayAn array of attributes that can be returned with the cohort assignment. The attributes returned vary depending on the template you chose when designing the experiment.
diagnosticsArrayInformation about errors or warnings encountered during processing.
diagnostics.codeStringThe error code.
diagnostics.descriptionStringA detailed message describing the error.
requestIdStringThe unique identifier for the request and response.