1. v3
  2. Surveys
  3. GET - 3/surveys/{surveyid}/contacts/fieldvaluecount

Definition

GET - 3/surveys/{surveyId}/contacts/fieldvaluecount

Retrieve the amount of unique values for the custom fields for a survey.

This request can be used when building custom reports or custom dashboards. It's very usefull to check if you would like to give certain options when filtering the aggregates, grouping the response rate, ...

Request information

surveyId

The survey identifier.


Type integer
Additional info
Required

Response information


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type PanelFieldValueCount
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-12-03T17:16:04.6143977Z",
    "IsFiltered": true
  },
  "Data": {
    "CustomField1Count": 1,
    "CustomField2Count": 2,
    "CustomField3Count": 3,
    "CustomField4Count": 4,
    "CustomField5Count": 5,
    "CustomField6Count": 6,
    "CustomField7Count": 7,
    "CustomField8Count": 8,
    "CustomField9Count": 9,
    "CustomField10Count": 10,
    "CustomField11Count": 11,
    "CustomField12Count": 12,
    "CustomField13Count": 13,
    "CustomField14Count": 14,
    "CustomField15Count": 15,
    "CustomField16Count": 16,
    "CustomField17Count": 17,
    "CustomField18Count": 18,
    "CustomField19Count": 19,
    "CustomField20Count": 20,
    "PostalCodeCount": 21,
    "CityCount": 22,
    "StateCount": 23,
    "ProvinceCount": 24,
    "CountryIdCount": 25,
    "ContactGroupCount": 26
  }
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data z:Id="i2">
    <CityCount>22</CityCount>
    <ContactGroupCount>26</ContactGroupCount>
    <CountryIdCount>25</CountryIdCount>
    <CustomField10Count>10</CustomField10Count>
    <CustomField11Count>11</CustomField11Count>
    <CustomField12Count>12</CustomField12Count>
    <CustomField13Count>13</CustomField13Count>
    <CustomField14Count>14</CustomField14Count>
    <CustomField15Count>15</CustomField15Count>
    <CustomField16Count>16</CustomField16Count>
    <CustomField17Count>17</CustomField17Count>
    <CustomField18Count>18</CustomField18Count>
    <CustomField19Count>19</CustomField19Count>
    <CustomField1Count>1</CustomField1Count>
    <CustomField20Count>20</CustomField20Count>
    <CustomField2Count>2</CustomField2Count>
    <CustomField3Count>3</CustomField3Count>
    <CustomField4Count>4</CustomField4Count>
    <CustomField5Count>5</CustomField5Count>
    <CustomField6Count>6</CustomField6Count>
    <CustomField7Count>7</CustomField7Count>
    <CustomField8Count>8</CustomField8Count>
    <CustomField9Count>9</CustomField9Count>
    <PostalCodeCount>21</PostalCodeCount>
    <ProvinceCount>24</ProvinceCount>
    <StateCount>23</StateCount>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-12-03T17:16:04.6143977+00:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>