GET v1/Surveys/{surveyId}/InviteRespondents/SurveyBatchesStatus

User roles allowed to make this request: DomainAdministrator PowerUser RegularUser LimitedUser SampleManager

Permissions required to make this request: EmailBatch.Read SampleRecord.Read Survey.Read

Has survey type usage restrictions online

Gets the invitation status of all batches for the specified survey.

Request Information

URI Parameters

Name	Description	Type	Additional information
surveyId	The survey for which to get the batches status	string	Required

Body Parameters

None.

Response Information

Resource Description

A collection of invitation batch status objects

Response Message

Collection of InvitationMonitorBatchStatus

Name	Description	Type	Additional information
BatchName	Name of the Batch	string	None.
Status	Batch status	string	None.
ScheduledFor	Date and time of when the batch has been scheduled for	date	None.
SurveyId	Id of the survey	string	None.
TotalCount	Total number of respondents invited	integer	None.
ScheduledCount	Number of respondents for which an invitation is currently scheduled	integer	None.
PendingCount	Number of respondents for which an invitation is currently pending	integer	None.
NotSentCount	Number of invitations that haven't been sent	integer	None.
ErrorCount	Number of invitations that resulted in an error	integer	None.
SentCount	Number of invitations that have already been sent	integer	None.
OpenedCount	Number of invitations that have been opened	integer	None.
ClickedCount	Number of invitations that have been clicked	integer	None.
UnsubscribedCount	Number of respondent that have unsubscribed	integer	None.
AbuseReportCount	Number of respondent that have been reported	integer	None.
UnknownCount	Number of invitations with unknown status	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "BatchName": "sample string 1",
    "Status": "sample string 2",
    "ScheduledFor": "2024-05-18T20:40:49.7253377+00:00",
    "SurveyId": "sample string 4",
    "TotalCount": 5,
    "ScheduledCount": 6,
    "PendingCount": 7,
    "NotSentCount": 8,
    "ErrorCount": 9,
    "SentCount": 10,
    "OpenedCount": 11,
    "ClickedCount": 12,
    "UnsubscribedCount": 13,
    "AbuseReportCount": 14,
    "UnknownCount": 15
  },
  {
    "BatchName": "sample string 1",
    "Status": "sample string 2",
    "ScheduledFor": "2024-05-18T20:40:49.7253377+00:00",
    "SurveyId": "sample string 4",
    "TotalCount": 5,
    "ScheduledCount": 6,
    "PendingCount": 7,
    "NotSentCount": 8,
    "ErrorCount": 9,
    "SentCount": 10,
    "OpenedCount": 11,
    "ClickedCount": 12,
    "UnsubscribedCount": 13,
    "AbuseReportCount": 14,
    "UnknownCount": 15
  }
]

application/xml, text/xml

Sample:

<ArrayOfInvitationMonitorBatchStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <InvitationMonitorBatchStatus>
    <AbuseReportCount>14</AbuseReportCount>
    <ClickedCount>12</ClickedCount>
    <ErrorCount>9</ErrorCount>
    <NotSentCount>8</NotSentCount>
    <OpenedCount>11</OpenedCount>
    <PendingCount>7</PendingCount>
    <ScheduledCount>6</ScheduledCount>
    <SentCount>10</SentCount>
    <SurveyId>sample string 4</SurveyId>
    <TotalCount>5</TotalCount>
    <UnknownCount>15</UnknownCount>
    <UnsubscribedCount>13</UnsubscribedCount>
    <BatchName>sample string 1</BatchName>
    <ScheduledFor>2024-05-18T20:40:49.7253377+00:00</ScheduledFor>
    <Status>sample string 2</Status>
  </InvitationMonitorBatchStatus>
  <InvitationMonitorBatchStatus>
    <AbuseReportCount>14</AbuseReportCount>
    <ClickedCount>12</ClickedCount>
    <ErrorCount>9</ErrorCount>
    <NotSentCount>8</NotSentCount>
    <OpenedCount>11</OpenedCount>
    <PendingCount>7</PendingCount>
    <ScheduledCount>6</ScheduledCount>
    <SentCount>10</SentCount>
    <SurveyId>sample string 4</SurveyId>
    <TotalCount>5</TotalCount>
    <UnknownCount>15</UnknownCount>
    <UnsubscribedCount>13</UnsubscribedCount>
    <BatchName>sample string 1</BatchName>
    <ScheduledFor>2024-05-18T20:40:49.7253377+00:00</ScheduledFor>
    <Status>sample string 2</Status>
  </InvitationMonitorBatchStatus>
</ArrayOfInvitationMonitorBatchStatus>