Amplitude · JSON Structure

User Profile Api Recommendation Structure

Recommendation schema from Amplitude User Profile API

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

Recommendation 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

rec_id child_ids is_control recommendation_type name

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/user-profile-api-recommendation-structure.json",
  "name": "Recommendation",
  "description": "Recommendation schema from Amplitude User Profile API",
  "type": "object",
  "properties": {
    "rec_id": {
      "type": "string",
      "description": "The recommendation model ID."
    },
    "child_ids": {
      "type": "array",
      "description": "Array of recommended item IDs.",
      "items": {
        "type": "string"
      }
    },
    "is_control": {
      "type": "boolean",
      "description": "Whether the user is in the control group for this recommendation model."
    },
    "recommendation_type": {
      "type": "string",
      "description": "The type of recommendation model."
    },
    "name": {
      "type": "string",
      "description": "The title of the recommendation."
    }
  }
}