Feedback
Feedback as the main entity of our platform, it allows you to manage and get detailed analytical reports. On this page, we'll dive into the different feedback endpoints.
The feedback model
The feedback model contains all the information about the feedback itself. It also contains references to the associated answers, attributes...
Properties
- Name
id- Type
- integer
- Description
Unique identifier for the feedback.
- Name
carrier_id- Type
- integer
- Description
The unique identifier linked to the Carrier where this feedback belongs to.
- Name
source- Type
- string
- Description
The source where the feedback is coming from.
- Name
created_at- Type
- timestamp
- Description
The date where the feedback has been created.
- Name
completed_at- Type
- timestamp
- Description
The date where the feedback has been fully completed (all answers has been answered).
- Name
nps_profile- Type
- string
- Description
The NPS Profile of the feedback (positive, neutral or negative).
- Name
satisfaction_ratio- Type
- integer
- Description
The Satisfaction Ratio of the feedback (0-100%).
Relations
- Name
attributes- Type
- Attribute[]
- Description
List of all the attributes attached to the feedback.
- Name
answers- Type
- Question Answer[]
- Description
List of all the answers attached to this feedback.
List all feedback
This endpoint allows you to retrieve a list of your feedback. By default, a maximum of ten feedback are shown per page. The ordering is always done by most recent feedback first and cannot be changed.
Optional attributes
- Name
per_page- Type
- integer
- Description
Number of items to display per page - 10 by default (max: 100).
- Name
order- Type
- string
- Description
Ordering of your feedback, can be
descorasc(default:desc).
- Name
fql- Type
- string
- Description
Narrow your search by using our Feedback Query Language. More information in our FQL documentation.
- Name
search_after- Type
- integer
- Description
Provide the ID of the last Feedback item retrieved, to be used as a starting point for fetching the next set of results.
We use search_after instead of standard pagination for performance optimization. You can find the key for the next query in the meta.next_search_after field of the response.
Request
curl -G https://api.bx.feedier.com/v3/feedback \
-H "Authorization: Bearer {token}"
Response
{
"data": [
{
"id": 26800,
"carrier_id": 91,
"source": "trustpilot",
"created_at": "2024-11-06T15:23:02.000000Z",
"completed_at": null,
"nps_profile": null,
"satisfaction_ratio": 45.0,
"attributes": [
{
"name": "City",
"value": "Lille"
},
// ...
],
"answers": [
{
"id": 242565,
"feedback_id": 26800,
"question_id": 344,
"question_option_id": null,
"value": "My experience was awesome during this car demonstration!",
"created_at": "2020-01-28T13:50:20.000000Z"
}
]
}
// ...
],
"meta": {
"total": 151815,
"next_search_after": 26800
}
}
Receive a feedback
This endpoint allows you to create a new feedback attached to a carrier into the Dashboard.
Required attributes
- Name
carrier_id- Type
- integer
- Description
The unique identifier of the carrier.
- Name
source- Type
- string
- Description
The source where this feedback came from. Allowed Values:
trustpiloteasiwarebigqueryemailchatreviewgoogle_reviewgoogle_reviews_competitorcsvfacebooklinkedinletterdocumentglassdoorhomeviewssurveysmsfacetofacefeedback_boxwhatsappinstagramcall_centeramazon_reviewshubspot
Optional attributes
- Name
created_at- Type
- string
- Description
The date and time when this feedback has been received. Format: MM/dd/yyyy HH:mm:ss (e.g.,
03/13/2025 14:30:45).
- Name
attributes- Type
- object
- Description
An object containing the list of attribute with the corresponding values — like on the example bellow. If the attribute name doesn't exist, it will be automatically created.
{ "attribute_name": "attribute_value", "city": "Lille", "car": "Toyota", "age": 30 }
- Name
answers- Type
- array
- Description
An array containing a list of answers following the schema bellow:
[ {"question_id": 1, "value": "My Answer"}, ]Ensure careful attention when using the specific questions below, as incorrect configurations might result in API errors.
Ratings Table
Choices
Request
curl https://api.bx.feedier.com/v3/feedback \
-H "Authorization: Bearer {token}" \
-d carrier_id=91 \
-d source="trustpilot" \
-d attributes[city]="Lille" \
-d attributes[car]="Toyota" \
-d attributes[age]=30 \
-d answers[0][question_id]=344 \
-d answers[0][value]="My experience was awesome during this car demonstration!"
Response
{
"id": 26800,
"carrier_id": 91,
"source": "trustpilot",
"created_at": "2024-11-06T15:23:02.000000Z",
"completed_at": null,
"nps_profile": null,
"satisfaction_ratio": 45.0,
"attributes": [
{
"name": "City",
"value": "Lille"
},
{
"name": "Car",
"value": "Toyota"
},
{
"name": "Age",
"value": 30
},
],
"answers": [
{
"id": 242565,
"feedback_id": 26800,
"question_id": 344,
"question_option_id": null,
"value": "My experience was awesome during this car demonstration!",
"created_at": "2020-01-28T13:50:20.000000Z"
},
]
}
Retrieve a feedback
This endpoint allows you to retrieve a feedback by providing their unique identifier. Refer to the list at the top of this page to see which properties are included with contact objects.
Request
curl https://api.bx.feedier.com/v3/feedback/26800 \
-H "Authorization: Bearer {token}"
Response
{
"id": 26800,
"carrier_id": 91,
"source": "trustpilot",
"created_at": "2024-11-06T15:23:02.000000Z",
"completed_at": null,
"nps_profile": null,
"satisfaction_ratio": 45.0,
"attributes": [
{
"name": "City",
"value": "Lille"
},
{
"name": "Car",
"value": "Toyota"
},
{
"name": "Age",
"value": 30
},
],
"answers": [
{
"id": 242565,
"feedback_id": 26800,
"question_id": 344,
"question_option_id": null,
"value": "My experience was awesome during this car demonstration!",
"created_at": "2020-01-28T13:50:20.000000Z"
},
]
}