How to find metadata for User Detail api

Question

Hello, 
Is there any api available which can return metadata of the User details?

I am using https://amplitude.com/api/2/useractivity?user={user_email}
           to get detailed user information but I am looking for any api or documentation which will  give me metadata of this detailed information.

Saish Redkar · Accepted Answer

Hey sonali123 ,
The example response of the /useractivity endpoint serves as the metadata of the api response. Not sure if there is any other detailed description of the fields in the docs out there. Also, this endpoint takes in the Amplitude ID of the user as the value for the “user” parameter.

There are 2 main key objects here - userData and events.

The userData object will mirror the data you see in a typical user stream profile for a user in the UI. ie.  aggregate statistics about the user and their user properties.
e.g.

The nested properties key in the userData object will contain all your custom user properties that you have set for the user.

The events object consists of an array of JSON objects, one for each event performed by the user. This can be controlled by the limit parameter you input in the api call.

Hope this helps!