topic Re: Understanding hs_value Field Usage in Custom Surveys via API in APIs & Integrations

Understanding hs_value Field Usage in Custom Surveys via API

krillman — Sun, 21 Jan 2024 22:14:12 GMT

Hello!

I'm seeking clarification on using the hs_value field in custom survey submissions via the HubSpot API. Specifically, I'm encountering an issue where this field consistently returns None in API responses for custom surveys.

Objective: Retrieve feedback rating from custom surveys.
Issue: hs_value field is always None in API responses.
Question:
1. Is hs_value applicable to custom surveys, or is it specific to standard surveys like NPS?
2. If not applicable, which field(s) should be used for feedback or rating data in custom surveys?

Your insights on this matter would be greatly appreciated.

Thank you,
Kristian

Re: Understanding hs_value Field Usage in Custom Surveys via API

Jaycee_Lewis — Mon, 22 Jan 2024 17:05:17 GMT

Hey, @krillman 👋 Can you add a brief example of your request and the response, please? It will be easier for our community to understand with a bit more information.

Thank you! — Jaycee

Re: Understanding hs_value Field Usage in Custom Surveys via API

krillman — Mon, 22 Jan 2024 22:22:34 GMT

Thank you for your response. As requested, here's an example of my API request and the responses I'm receiving, which illustrate the issue with the hs_value and hs_content fields in custom surveys.

Request for an NPS Survey Submission:

curl --request GET \ --url 'https://api.hubapi.com/crm/v3/objects/feedback_submissions/101958507729?properties=hs_survey_type%2Chs_value&archived=false' \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN'

Response:

{ "id": "101983670229", "properties": { "hs_content": "Krångelfri IT och kompetens och lika mycket trevligt bemötande!", "hs_survey_type": "NPS", "hs_value": "10" } }

In this case, the hs_value and hs_content field is present and holds the expected data.

Request for a Custom Survey Submission:

curl --request GET \ --url 'https://api.hubapi.com/crm/v3/objects/feedback_submissions/101689525692?properties=hs_survey_type%2Chs_value%2Chs_content&archived=false' \ --header 'authorization: Bearer YOUR_ACCESS_TOKEN'

Response:

{ "id": "101689525692", "properties": { "hs_content": null, "hs_survey_type": "CUSTOM", "hs_value": null } }

However, for a custom survey submission, both hs_content and hs_value are null.

Given these examples, my questions are:

Is it expected that hs_value (and hs_content) would be null for custom survey types?
If hs_value is not applicable for custom surveys, is there another field that should be used to retrieve feedback or ratings?

Any further insights would be greatly appreciated to help clarify this behavior.

Re: Understanding hs_value Field Usage in Custom Surveys via API

krillman — Mon, 22 Jan 2024 22:39:41 GMT

Thank you for your prompt response. As requested, here's an example of my API request and the responses I'm receiving, which illustrate the issue with the hs_value field in custom surveys.

Request for an NPS Survey Submission:
curl --request GET \
--url 'https://api.hubapi.com/crm/v3/objects/feedback_submissions/101983670229?properties=hs_survey_type%2Chs_value%2Chs_content&archived=false' \
--header 'authorization: Bearer YOUR_ACCESS_TOKEN'
Response:

{
"id": "101983670229",
"properties": {
"hs_content": "Krångelfri IT och kompetens och lika mycket trevligt bemötande!",
"hs_createdate": "2024-01-22T15:32:45.060Z",
"hs_lastmodifieddate": "2024-01-22T15:33:57.018Z",
"hs_object_id": "101983670229",
"hs_survey_type": "NPS",
"hs_value": "10"
},
"createdAt": "2024-01-22T15:32:45.060Z",
"updatedAt": "2024-01-22T15:33:57.018Z",
"archived": false
}
In this case, the hs_value and hs_content fields are present and holds the expected data.
Request for a Custom Survey Submission:
curl --request GET \
--url 'https://api.hubapi.com/crm/v3/objects/feedback_submissions/101689525692?properties=hs_survey_type%2Chs_value%2Chs_content&archived=false' \
--header 'authorization: Bearer YOUR_ACCESS_TOKEN'
Response:
{
"id": "101689525692",
"properties": {
"hs_content": null,
"hs_createdate": "2024-01-20T15:33:12.897Z",
"hs_lastmodifieddate": "2024-01-20T15:33:13.451Z",
"hs_object_id": "101689525692",
"hs_survey_type": "CUSTOM",
"hs_value": null
},
"createdAt": "2024-01-20T15:33:12.897Z",
"updatedAt": "2024-01-20T15:33:13.451Z",
"archived": false
}
However, for a custom survey submission, both hs_content and hs_value are null.

Given these examples, my questions are:

Is it expected that hs_value and hs_content would be null for custom survey types?
If hs_value is not applicable for custom surveys, is there another field that should be used to retrieve feedback or ratings?

Any further insights would be greatly appreciated to help clarify this behavior.

Re: Understanding hs_value Field Usage in Custom Surveys via API

krillman — Tue, 23 Jan 2024 08:29:29 GMT

Thank you @Jaycee_Lewis for your response. As requested, here's an example of my API request and the responses I'm receiving, which illustrate the issue with the hs_value field in custom surveys.

Request for an NPS Survey Submission:
curl --request GET \

--url 'https://api.hubapi.com/crm/v3/objects/feedback_submissions/xxx29?properties=hs_survey_type%2Chs_value%2Chs_content&archived=false ' \

--header 'authorization: Bearer xxx'

Response:
{
"id": "xxx29",
"properties": {
"hs_content": "Krångelfri IT och kompetens och lika mycket trevligt bemötande!",
"hs_createdate": "2024-01-22T15:32:45.060Z",
"hs_lastmodifieddate": "2024-01-22T15:33:57.018Z",
"hs_object_id": "xxx29",
"hs_survey_type": "NPS",
"hs_value": "10"
},
"createdAt": "2024-01-22T15:32:45.060Z",
"updatedAt": "2024-01-22T15:33:57.018Z",
"archived": false
}
In this case, the hs_value and hs_content fields are present and holds the expected data.

Request for a Custom Survey Submission:
curl --request GET \

--url 'https://api.hubapi.com/crm/v3/objects/feedback_submissions/xxx92?properties=hs_survey_type%2Chs_value%2Chs_content&archived=false ' \

--header 'authorization: Bearer xxx'

Response:
{
"id": "xxx92",
"properties": {
"hs_content": null,
"hs_createdate": "2024-01-20T15:33:12.897Z",
"hs_lastmodifieddate": "2024-01-20T15:33:13.451Z",
"hs_object_id": "xxx92",
"hs_survey_type": "CUSTOM",
"hs_value": null
},
"createdAt": "2024-01-20T15:33:12.897Z",
"updatedAt": "2024-01-20T15:33:13.451Z",
"archived": false
}
However, for a custom survey submission, both hs_content and hs_value are null.

Given these examples, my questions are:

Is it expected that hs_value and hs_content would be null for custom survey types?
If hs_value is not applicable for custom surveys, is there another field that should be used to retrieve feedback or ratings?

Any further insights would be greatly appreciated to help clarify this behavior.

All the best!

Kristian