GET v1/Surveys/{surveyId}/Counts

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser Supervisor LimitedUser QuotaManager OperationsUser SampleManager DemoUser

Permissions required to make this request: SurveyFieldworkReport.Read SurveyResponseCode.Read Survey.Read

Supports survey simulations

Returns the counts for the specified survey. For all surveys it will return the topline counts. For surveys with Quota, it will also include detailed counts per quota level.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The survey for which the counts are requested	string	Required

Body Parameters

None.

Response Information

Resource Description

survey counts

Response Message

SurveyCountsModel

Name	Description	Type	Additional information
SurveyId	Id of the survey that the counts belong to	string	None.
SuccessfulCount	The count of interviews successfully completed	integer	None.
ScreenedOutCount	The count of interviews that ended with *ENDST or #ENDNGB	integer	None.
DroppedOutCount	Number of currently timed-out non-test interviews	integer	None.
RejectedCount	The count of interviews successfully completed	integer	None.
QuotaCounts	The detailed counts per quota cell for surveys with quota	QuotaLevel	None.
ActiveLiveCount	Number of currently active live interviews	integer	None.
ActiveTestCount	Number of currently active test interviews	integer	None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

No sample available