This article will explain the four main business entities to make you more effective when navigating around, and using our full API documentation. Voxpopme API gives you full access and control of your data, but there are 4 key entities around which everything revolves - Accounts, Users, Projects and Responses.

Accounts

Accounts represent a company (or a division of a company) using our platform, i.e. Microsoft or Coca-Cola.

Under normal operation, an Account will simply contain a list of Users who can log into the platform, see all of the Projects in that Account, check Responses, generate showreels, export data, etc. But for partners who manage Projects on their own customer’s behalf, we provide an option for Accounts to create Sub-Accounts, with their own set Users, Projects and Responses. This allows you to grant regular and API access to the Voxpopme platform to your own customers, completely siloed and separated from your other customers' Projects and data. More about this workflow and the considerations you'll have to think about can be found in the ‘Creating Accounts’ page.

It’s important to keep in mind that having this setup will add an inherent layer of complexity to managing your Voxpopme integration. Therefore, before starting any development work, determine if the added benefits of having a Sub-Account setup outweigh simply storing all of your Projects under a single Account. 

Users

A User is a representation of a physical person. They have regular login credentials with a username and a password with which they can see Accounts, Projects and Responses they have been granted access to.

Users can belong to multiple Accounts and switch between them on our platform.

If granting a set of credentials for your own customers is not a valid option - we provide SSO support, allowing you to generate single-use links that authenticate the user and grant them access to their Projects and Responses. More on how to create SSO links.

Projects

A Project in the Voxpopme platform represents a closely coupled collection of Responses. 

Through the years, we referred to this collection with various different names: Question, Campaign, Study, Project. If you see any of these names mentioned anywhere in our API documentation, they refer to exactly the same thing - a Project.

An Account can have many different Projects, and each Project will have a list of Responses. Projects are flexible, and are created to contain Responses for an entire market research study, or an ongoing customer experience study. We recommend setting new Projects for each new subject we’re trying to learn more about. 

More on how to setup and manage Projects.

Responses

When a respondent records a video, or one is manually uploaded to our platform - it’s represented as a Response.

Besides containing the actual video or an audio file that was recorded for a specific Project, Responses also contain a collection of other metrics. These metrics help you understand and learn more about a particular Response, i.e. transcripts, translations, sentiment analysis, locale, date of creation and any other Additional Data that was attached to that particular Response, either pre or post recording.

More about Capturing Responses, and our recommendations and usage tips of Additional Data.