API docs by Redocly

User Feedback API Document (1.0.0)

Download OpenAPI specification:

You can use this API to integrate with your own service or system. This API is protected by a simple API key authentication, so please do not expose this API to the public. You can make an API key in the admin setting page. You should put the API key in the header with the key name 'x-api-key'.

feedbacks

Create Feedback

Creates a new feedback for the specified channel with json data. You can include 'issueNames' to associate issues with the feedback. You can put an array of image urls in the 'images format field' in the request data. Make sure to set image domain whitelist in the channel settings.

Authorizations:
apiKey
path Parameters
projectId
required
number
Example: 1

Project id

channelId
required
number
Example: 1

Channel id

Request Body schema: application/json
required

Feedback data in json

object (Object)

Responses

Request samples

Content type
application/json
{
  • "message": "feedback message",
  • "issueNames": [
    ]
}

Response samples

Content type
application/json
{ }

Get Feedbacks by Channel

Searches for feedback entries by channel ID with keyword. You can search by specifying both fieldKey and searchText, or by specifying issueName.

Authorizations:
apiKey
path Parameters
channelId
required
number
Example: 1

Channel id

projectId
required
number
Example: 1

Project id

query Parameters
searchText
string

Keyword to search feedbacks

fieldKey
string

Field key to search feedbacks

issueName
string

Issue name to search related feedbacks within channel

limit
object (Object)
page
object (Object)

Responses

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "items": [
    ]
}

Delete Multiple Feedbacks

Deletes multiple feedback entries based on the provided array of feedback ids.

Authorizations:
apiKey
path Parameters
channelId
required
number
Example: 1

Channel id

projectId
required
number
Example: 1

Project id

Request Body schema: application/json
required
feedbackIds
required
Array of numbers

Feedback ids in an array

Responses

Request samples

Content type
application/json
{
  • "feedbackIds": [
    ]
}

Create Feedback with Image Files

Create feedback with data and image files by multi-part. If you want to create feedback with issues, you can add 'issueNames' in the request data.

Authorizations:
apiKey
path Parameters
projectId
required
number
Example: 1

Project id

channelId
required
number
Example: 1

Channel id

Request Body schema: multipart/form-data
required

Feedback data by multipart/form-data

object (Object)

Responses

Request samples

Content type
multipart/form-data
{
  "message": "feedback message",
  "issueNames": [
    "issue name 1",
    "issue name 2"
  ],
  "images": [
    "image file 1",
    "image file 2"
  ]
}

Response samples

Content type
application/json
{ }

Search Feedbacks by Channel

Searches for feedback entries by channel ID with various filters.

Authorizations:
apiKey
path Parameters
channelId
required
number
Example: 1

Channel id

projectId
required
number
Example: 1

Project id

Request Body schema: application/json
optional
limit
number >= 1
Default: 10
page
number >= 1
Default: 1
object

You can query by key-value with this object. (createdAt, updatedAt are kind of examples) If you want to search by text, you can use 'searchText' key.

sort
object

You can sort by specific feedback key with sort method values: 'ASC', 'DESC'

Responses

Request samples

Content type
application/json
{
  • "limit": 10,
  • "page": 1,
  • "query": {
    },
  • "sort": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "items": [
    ]
}

Add Issue to Feedback

Adds an issue to an existing feedback by specifying the feedback id and issue id.

Authorizations:
apiKey
path Parameters
channelId
required
number
Example: 1

Channel id

feedbackId
required
number
Example: 1

Feedback id to add an issue

issueId
required
number
Example: 1

Issue id to be added to the feedback

projectId
required
number
Example: 1

Project id

Responses

Response samples

Content type
application/json
{
  • "issueId": 1,
  • "feedbackId": 1
}

Remove Issue from Feedback

Removes an issue from an existing feedback.

Authorizations:
apiKey
path Parameters
channelId
required
number
Example: 1

Channel id

feedbackId
required
number
Example: 1

Feedback id to remove the added issue

issueId
required
number
Example: 1

Issue id to remove from the feedback

projectId
required
number
Example: 1

Project id

Responses

Response samples

Content type
application/json
{
  • "issueId": 1,
  • "feedbackId": 1
}

Update Feedback

Updates an existing feedback with new information. Only Editable fields can be updated.

Authorizations:
apiKey
path Parameters
channelId
required
number
Example: 1

Channel id

feedbackId
required
number
Example: 1

Feedback id to update

projectId
required
number
Example: 1

Project id

Request Body schema: application/json
required

Feedback data to be updated in json

object (Object)

Responses

Request samples

Content type
application/json
{
  • "message": "updated feedback message",
  • "issueNames": [
    ]
}

Get Feedback by ID

Retrieves a specific feedback by its id.

Authorizations:
apiKey
path Parameters
channelId
required
number
Example: 1

Channel id

feedbackId
required
number
Example: 1

Feedback id to find

projectId
required
number
Example: 1

Project id

Responses

Response samples

Content type
application/json
{ }

feedbacks-v2

Search Feedbacks by Channel (V2)

Searches for feedback entries by channel ID with various filters.

Authorizations:
apiKey
path Parameters
channelId
required
number
Example: 1

Channel id

projectId
required
number
Example: 1

Project id

Request Body schema: application/json
optional
limit
number >= 1
Default: 10
page
number >= 1
Default: 1
Array of objects (QueryV2)

You can query by key-value with this object. Queries are concatenated with 'AND' or 'OR' operator.

Array of objects (QueryV2)

You can query by key-value with this object by default (like createdAt). This condition always applies regardless of the conditions of the queries.

operator
string

You can concatenate queries with 'AND' or 'OR' operators.

sort
object

You can sort by specific feedback key with sort method values: 'ASC', 'DESC'

Responses

Request samples

Content type
application/json
{
  • "limit": 10,
  • "page": 1,
  • "queries": [
    ],
  • "defaultQueries": [
    ],
  • "operator": "string",
  • "sort": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "items": [
    ]
}

issues

Create Issue

Creates a new issue for the specified project.

Authorizations:
apiKey
path Parameters
projectId
required
number
Example: 1

Project id

Request Body schema: application/json
required
name
required
string

Issue name

status
string
Enum: "INIT" "ON_REVIEW" "IN_PROGRESS" "RESOLVED" "PENDING"

Issue status

description
required
string or null

Issue description

externalIssueId
string

External Issue Id

Responses

Request samples

Content type
application/json
{
  • "name": "payment issue",
  • "status": "IN_PROGRESS",
  • "description": "This is a payment issue",
  • "externalIssueId": "123"
}

Response samples

Content type
application/json
{
  • "id": 1
}

Delete Multiple Issues

Deletes multiple issues from the specified project, based on an array of issue ids.

Authorizations:
apiKey
path Parameters
projectId
required
number
Example: 1

Project id

Request Body schema: application/json
required
issueIds
required
Array of numbers

Issue ids in an array to delete in chunk

Responses

Request samples

Content type
application/json
{
  • "issueIds": [
    ]
}

Find Issue by ID

Retrieves a specific issue by its id within the specified project.

Authorizations:
apiKey
path Parameters
issueId
required
number
Example: 1

Issue id

projectId
required
number
Example: 1

Project id

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Issue

Updates an existing issue with new information within the specified project.

Authorizations:
apiKey
path Parameters
projectId
required
number
Example: 1

Project id

issueId
required
number
Example: 1

Issue id

Request Body schema: application/json
required
name
required
string

Issue name

status
string
Enum: "INIT" "ON_REVIEW" "IN_PROGRESS" "RESOLVED" "PENDING"

Issue status

description
required
string or null

Issue description

externalIssueId
string

External Issue Id

Responses

Request samples

Content type
application/json
{
  • "name": "payment issue",
  • "status": "IN_PROGRESS",
  • "description": "This is a payment issue",
  • "externalIssueId": "123"
}

Delete Issue

Deletes a specific issue by its id from the specified project.

Authorizations:
apiKey
path Parameters
issueId
required
number
Example: 1

Issue id

projectId
required
number
Example: 1

Project id

Responses

Search Issues by Project

Searches for all issues within the specified project, with the various filters.

Authorizations:
apiKey
path Parameters
projectId
required
number
Example: 1

Project id

Request Body schema: application/json
required
limit
number >= 1
Default: 10
page
number >= 1
Default: 1
query
object

You can query by key-value with this object. If you want to search by text, you can use 'searchText' key.

sort
object

You can sort by specific feedback key with sort method values: 'ASC', 'DESC'

Responses

Request samples

Content type
application/json
{
  • "limit": 10,
  • "page": 1,
  • "query": {
    },
  • "sort": {
    }
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "items": [
    ]
}

Add Category to Issue

Add a new category to an issue within the specified project.

Authorizations:
apiKey
path Parameters
issueId
required
number
Example: 1

Issue id

categoryId
required
number
Example: 1

Category id

projectId
required
number
Example: 1

Project id

Responses

Remove Category from Issue

Remove a category from the specified issue within the specified project.

Authorizations:
apiKey
path Parameters
issueId
required
number
Example: 1

Issue id

categoryId
required
number
Example: 1

Category id

projectId
required
number
Example: 1

Project id

Responses

channels

Get Image Upload URL

Generates a presigned URL for image upload to a specific channel within a project.

Authorizations:
apiKey
path Parameters
projectId
required
number
Example: 1

Project id

channelId
required
number
Example: 1

Channel id

query Parameters
extension
required
string
Example: extension=png

File extension for the image to be uploaded

Responses

Response samples

Content type
application/json
"string"

Get Fields

Authorizations:
apiKey
path Parameters
projectId
required
number
Example: 1

Project id

channelId
required
number
Example: 1

Channel id

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "name": "fieldName",
  • "key": "fieldKey",
  • "format": "text",
  • "status": "ACTIVE"
}

projects

Get Project Info

Retreives a project info by project id.

Authorizations:
apiKey
path Parameters
projectId
required
number
Example: 1

Project id

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "timezone": {
    },
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

categories

Create Category

Create a new category within a project

Authorizations:
apiKey
path Parameters
projectId
required
number
Example: 1

Project id

Request Body schema: application/json
required

Category name to create

object (Object)

Responses

Request samples

Content type
application/json
{
  • "name": "category1"
}

Response samples

Content type
application/json
{
  • "id": 1
}

Get All Categories by name

Get all categories by name within a project

Authorizations:
apiKey
path Parameters
projectId
required
number
Example: 1

Project id

query Parameters
limit
number >= 1
Default: 10
Example: limit=10
page
number >= 1
Default: 1
Example: page=1
categoryName
string
sort
object (Object)

You can sort category by specific key with sort method values: 'ASC', 'DESC'

Request Body schema: application/json
required

Category name

object (Object)

Responses

Request samples

Content type
application/json
{
  • "categoryName": "category1"
}

Response samples

Content type
application/json
{
  • "meta": {
    },
  • "items": [
    ]
}

Update category name

Update existing category name

Authorizations:
apiKey
path Parameters
projectId
required
number
Example: 1

Project id

categoryId
required
number
Example: 1

Category id

Request Body schema: application/json
required

Category name

object (Object)

Responses

Request samples

Content type
application/json
{
  • "name": "category2"
}

Delete category

Delete existing category

Authorizations:
apiKey
path Parameters
projectId
required
number
Example: 1

Project id

categoryId
required
number
Example: 1

Category id

Responses