GET v1/Surveys/InviteRespondents/SurveysInvitationStatus

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 status of all surveys' invitation.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A collection of invitation survey status objects

Response Message

Collection of InvitationMonitorSurveyStatus
NameDescriptionTypeAdditional information
SurveyName

Name of the survey

string

None.

InvitationsBlocked

True if invitations are blocked

boolean

None.

LastActivity

Survey's batches latest activity (most recent ScheduledFor value for the batches)

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:
[
  {
    "SurveyName": "sample string 1",
    "InvitationsBlocked": true,
    "LastActivity": "2024-05-26T06:48:34.8321696+00:00",
    "SurveyId": "sample string 3",
    "TotalCount": 4,
    "ScheduledCount": 5,
    "PendingCount": 6,
    "NotSentCount": 7,
    "ErrorCount": 8,
    "SentCount": 9,
    "OpenedCount": 10,
    "ClickedCount": 11,
    "UnsubscribedCount": 12,
    "AbuseReportCount": 13,
    "UnknownCount": 14
  },
  {
    "SurveyName": "sample string 1",
    "InvitationsBlocked": true,
    "LastActivity": "2024-05-26T06:48:34.8321696+00:00",
    "SurveyId": "sample string 3",
    "TotalCount": 4,
    "ScheduledCount": 5,
    "PendingCount": 6,
    "NotSentCount": 7,
    "ErrorCount": 8,
    "SentCount": 9,
    "OpenedCount": 10,
    "ClickedCount": 11,
    "UnsubscribedCount": 12,
    "AbuseReportCount": 13,
    "UnknownCount": 14
  }
]

application/xml, text/xml

Sample:
<ArrayOfInvitationMonitorSurveyStatus xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NipoSoftware.Nfield.Manager.Api.Models">
  <InvitationMonitorSurveyStatus>
    <AbuseReportCount>13</AbuseReportCount>
    <ClickedCount>11</ClickedCount>
    <ErrorCount>8</ErrorCount>
    <NotSentCount>7</NotSentCount>
    <OpenedCount>10</OpenedCount>
    <PendingCount>6</PendingCount>
    <ScheduledCount>5</ScheduledCount>
    <SentCount>9</SentCount>
    <SurveyId>sample string 3</SurveyId>
    <TotalCount>4</TotalCount>
    <UnknownCount>14</UnknownCount>
    <UnsubscribedCount>12</UnsubscribedCount>
    <InvitationsBlocked>true</InvitationsBlocked>
    <LastActivity>2024-05-26T06:48:34.8321696+00:00</LastActivity>
    <SurveyName>sample string 1</SurveyName>
  </InvitationMonitorSurveyStatus>
  <InvitationMonitorSurveyStatus>
    <AbuseReportCount>13</AbuseReportCount>
    <ClickedCount>11</ClickedCount>
    <ErrorCount>8</ErrorCount>
    <NotSentCount>7</NotSentCount>
    <OpenedCount>10</OpenedCount>
    <PendingCount>6</PendingCount>
    <ScheduledCount>5</ScheduledCount>
    <SentCount>9</SentCount>
    <SurveyId>sample string 3</SurveyId>
    <TotalCount>4</TotalCount>
    <UnknownCount>14</UnknownCount>
    <UnsubscribedCount>12</UnsubscribedCount>
    <InvitationsBlocked>true</InvitationsBlocked>
    <LastActivity>2024-05-26T06:48:34.8321696+00:00</LastActivity>
    <SurveyName>sample string 1</SurveyName>
  </InvitationMonitorSurveyStatus>
</ArrayOfInvitationMonitorSurveyStatus>