Customer research
A research is a study with objectives and questions, and every agentic interview belongs to one. List and create researches, change their title, description, objectives and questions, read one with its interview counts, sentiment and summary, and list the feature requests its interviews brought up, with how many interviews mention each. Deleting a research also deletes its interviews, which you manage as customer interactions. See Agentic interviews.
List customer research studies in a workspace
Returns customer research studies used to organize customer interviews and feedback collection. Each research can contain multiple customer interactions. Returns: id, title, description, interactionCount, createdAt.
path Parameters
workspaceIdWorkspace UUID
query Parameters
pagePage number (1-indexed, default 1)
limitItems per page (default 50)
sortByField to sort by
sortOrderSort direction (default desc)
searchFull-text search across searchable fields
anchorId^([0-9a-fA-F]{8}-[0-…Serve the page containing this row; its page is echoed as pagination.anchorPage
List customer research studies in a workspace › Responses
List of customer researches
Create a customer research study
Create a new research study to organize customer interviews and feedback collection.
path Parameters
workspaceIdWorkspace UUID
Create a customer research study › Request Body
titleobjectivesquestionsdescriptionwidgetWelcomeMessageCreate a customer research study › Responses
Created customer research
List feature requests linked to a customer research
Returns feature requests linked to interactions in this customer research via interests, with a count of how many interactions mention each request.
path Parameters
workspaceIdWorkspace UUID
idCustomer research UUID
List feature requests linked to a customer research › Responses
List of linked feature requests with interest counts
Generate a widget key for a customer research study
Gives a customer research study a feedback widget key when it has none, so its feedback widget can be embedded on a website. A study that already has a key keeps it, so widgets already on a website are unaffected. Returns the study with its key.
path Parameters
workspaceIdWorkspace UUID
idCustomer research UUID
Generate a widget key for a customer research study › Responses
The customer research, with its widget key
Get a customer research study by ID
Retrieve a single customer research with its interview counts, sentiment and summary.
path Parameters
workspaceIdWorkspace UUID
idCustomer research UUID
Get a customer research study by ID › Responses
Customer research details
Update a customer research study
Modify research title or description.
path Parameters
workspaceIdWorkspace UUID
idCustomer research UUID
Update a customer research study › Request Body
titledescriptionobjectivesquestionsguidelineinterviewWelcomeMessagewidgetWelcomeMessageUpdate a customer research study › Responses
Updated customer research