Amplitude · Schema

Recommendation

Recommendation schema from Amplitude User Profile API

A/B TestingAnalyticsExperimentationFeature FlagsProduct AnalyticsUser Behavior

Properties

Name Type Description
rec_id string The recommendation model ID.
child_ids array Array of recommended item IDs.
is_control boolean Whether the user is in the control group for this recommendation model.
recommendation_type string The type of recommendation model.
title string The title of the recommendation.
View JSON Schema on GitHub

JSON Schema

user-profile-api-recommendation-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/user-profile-api-recommendation-schema.json",
  "title": "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."
    },
    "title": {
      "type": "string",
      "description": "The title of the recommendation."
    }
  }
}