useranalytics

Get information on the contributions individual users made in a

Changed on

Get information on the contributions individual users made in a particular time frame. This endpoint requires admin permissions. The returned fields all contain lists where each entry relates to one day in the query time frame by the requested user. The fields are the following:

<ul> <li>annotation_events: how many treenodes or connector nodes where edited/added on a given day</li> <li> annotation_timeaxis: dates for each annotation event <li>review_events: how many node reviews were performed on a given day</li> review_timeaxis: dates for each review event</li> <li>write_events: how many write events of any form (incl. annotations/tags/renames) where made on a given day</li> <li>write_timeaxis: dates for each write event</li> <li>raw_write_events: a raw list of all write events of any kind</li> <li>active_bouts: time segments in which a user was active that had no pauses longer than the requested activity time threshold.</li> <li>net_active_time: the active time in hours per day between the first event of the first active bout and the last event of the last bout.</li> <li>netactivetime_timeaxis: dates for each net active time entry</li> </ul>
gethttp://localhost:8000/{project_id}/useranalytics/data

Request

Path parameters

project_idstring required

Request body application/x-www-form-urlencoded

useridstring

The id of the user to get information on

startstring

Start date of request time frame in the form YYYY-MM-DD. Defaults to seven days ago from today.

endstring

End date of request time frame in the form YYYY-MM-DD. Defaults to today/now.

max_inactivitystring

Number of minutes of inactivity, before a pause is assumed.

all_writesstring

Whether info ann all types of write events should be returned, including annotating neurons, renaming neurons or editing tags. True by default.

with_active_boutsstring

Whether all active bouts should be returned. This can be potentially a large list. False by default.

Response

OK

Changes