Productmind API

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

GET
https://api.productmind.ai
/workspaces/{workspaceId}/customer-researches

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.

List customer research studies in a workspace › path Parameters

workspaceId
​string · required

Workspace UUID

List customer research studies in a workspace › query Parameters

page
​number

Page number (1-indexed, default 1)

limit
​number

Items per page (default 50)

sortBy
​string · enum

Field to sort by

Enum values:
title
createdAt
sortOrder
​string · enum

Sort direction (default desc)

Enum values:
asc
desc
search
​string

Full-text search across searchable fields

anchorId
​string · uuid · pattern: ^([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

200

List of customer researches

​CustomerResearchDTO[] · required
​object
​object

Create a customer research study

POST
https://api.productmind.ai
/workspaces/{workspaceId}/customer-researches

Create a new research study to organize customer interviews and feedback collection.

Create a customer research study › path Parameters

workspaceId
​string · required

Workspace UUID

Create a customer research study › Request Body

title
​string · minLength: 1 · required
objectives
​string[] · minItems: 1 · required
questions
​string[] · minItems: 1 · required
description
​string
widgetWelcomeMessage
​string

Create a customer research study › Responses

Created customer research

​CustomerResearchDTO · required

List feature requests linked to a customer research

GET
https://api.productmind.ai
/workspaces/{workspaceId}/customer-researches/{id}/feature-requests

Returns feature requests linked to interactions in this customer research via interests, with a count of how many interactions mention each request.

List feature requests linked to a customer research › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Customer research UUID

List feature requests linked to a customer research › Responses

200

List of linked feature requests with interest counts

​FeatureRequestSummaryDTO[] · required

Generate a widget key for a customer research study

POST
https://api.productmind.ai
/workspaces/{workspaceId}/customer-researches/{id}/widget-key

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.

Generate a widget key for a customer research study › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Customer research UUID

Generate a widget key for a customer research study › Request Body

Generate a widget key for a customer research study › Responses

200

The customer research, with its widget key

​CustomerResearchDTO · required

Get a customer research study by ID

GET
https://api.productmind.ai
/workspaces/{workspaceId}/customer-researches/{id}

Retrieve a single customer research with its interview counts, sentiment and summary.

Get a customer research study by ID › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Customer research UUID

Get a customer research study by ID › Responses

200

Customer research details

​CustomerResearchDTO · required

Update a customer research study

PUT
https://api.productmind.ai
/workspaces/{workspaceId}/customer-researches/{id}

Modify research title or description.

Update a customer research study › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Customer research UUID

Update a customer research study › Request Body

title
​string · minLength: 1
description
​string
objectives
​string[]
questions
​string[]
guideline
​string
interviewWelcomeMessage
​string
widgetWelcomeMessage
​string

Update a customer research study › Responses

200

Updated customer research

​CustomerResearchDTO · required

Delete a customer research study

DELETE
https://api.productmind.ai
/workspaces/{workspaceId}/customer-researches/{id}

Permanently remove a customer research and its linked interactions.

Delete a customer research study › path Parameters

workspaceId
​string · required

Workspace UUID

id
​string · required

Customer research UUID

Delete a customer research study › Responses

200

Customer research deleted

No data returned