The count is the total number of profiles there are, these include completed & uncompleted profiles.
The results is a paginated list of 100 profiles, once the count is more than 100 it will be paginated.
You can use the next and previous links to offset the results.
The content:
The fields are pretty self-explanatory, however, if a field is null it means the user has not yet provided that information
The id is the "id" of the profile, not the user. The user's ID is stored in user. This is the same user ID used in the survey results CSV you receive.
ban is the field for the "bad actor score", which is used to prevent the user from seeing surveys on the menu, this does not prevent them from doing the survey if you send them a template
notify is the field that indicates whether the user has "opted-in/-out" for updates on new surveys.
Additional uses:
You can view individual profiles by adding the profile "id" in the URL e.g.
You can update a user's profile by calling a PATCH request to the above mentioned individual profile endpoint, this could be useful for banning / unbanning someone
You can also delete a user's profile by calling a DELETE request to the individual profile endpoint
Limitations:
It does NOT allow you to search according to a specific parameter (its possible, but would require additional work)
Want to print your doc? This is not the way.
Try clicking the ⋯ next to your doc name or using a keyboard shortcut (
Analytics & Data