UserData is a JSON Structure definition published by Amplitude, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amplitude/refs/heads/main/json-structure/user-profile-api-user-data-structure.json",
"name": "UserData",
"description": "UserData schema from Amplitude User Profile API",
"type": "object",
"properties": {
"user_id": {
"type": "string",
"description": "The user's user_id."
},
"user_properties": {
"type": "object",
"description": "A dictionary of the user's properties as set via the Identify API or SDK.",
"additionalProperties": true
},
"computed_properties": {
"type": "object",
"description": "A dictionary of computed properties calculated by Amplitude for the user.",
"additionalProperties": true
},
"cohort_ids": {
"type": "array",
"description": "Array of cohort IDs the user is a member of.",
"items": {
"type": "string"
}
},
"recommendations": {
"type": "array",
"description": "Array of personalized recommendation results for the user. Only included when get_recs is true.",
"items": {
"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."
}
}
}
},
"amplitude_id": {
"type": "int64",
"description": "The Amplitude internal ID for the user."
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.