Amplitude · Schema

EvaluationRequest

EvaluationRequest schema from Amplitude Experiment Evaluation API

A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

Properties

Name Type Description
user_id string The user ID to evaluate experiments and flags for.
device_id string The device ID to evaluate experiments and flags for.
user_properties object User properties to use for targeting rule evaluation.
groups object Group type to group name mappings for group-level targeting.
group_properties object Group properties to use for targeting rule evaluation.
View JSON Schema on GitHub

JSON Schema

experiment-evaluation-api-evaluation-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amplitude/refs/heads/main/json-schema/experiment-evaluation-api-evaluation-request-schema.json",
  "title": "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
    }
  }
}