Amplitude · JSON Structure

Experiment Evaluation Api Evaluation Request Structure

EvaluationRequest schema from Amplitude Experiment Evaluation API

Type: object Properties: 5
A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

EvaluationRequest is a JSON Structure definition published by Amplitude, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

user_id device_id user_properties groups group_properties

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amplitude/refs/heads/main/json-structure/experiment-evaluation-api-evaluation-request-structure.json",
  "name": "EvaluationRequest",
  "description": "EvaluationRequest schema from Amplitude Experiment Evaluation API",
  "type": "object",
  "properties": {
    "user_id": {
      "type": "string",
      "description": "The user ID to evaluate experiments and flags for."
    },
    "device_id": {
      "type": "string",
      "description": "The device ID to evaluate experiments and flags for."
    },
    "user_properties": {
      "type": "object",
      "description": "User properties to use for targeting rule evaluation.",
      "additionalProperties": true
    },
    "groups": {
      "type": "object",
      "description": "Group type to group name mappings for group-level targeting.",
      "additionalProperties": true
    },
    "group_properties": {
      "type": "object",
      "description": "Group properties to use for targeting rule evaluation.",
      "additionalProperties": true
    }
  }
}