Definitions

CallHistory

Class representing information about the call attempt

Name Description Schema

aaporCode
optional

AAPOR code based on Extended status of the call attempt

string

callAttemptNumber
optional

Represents the sequence number of a call attempt made during an interview. This value corresponds to the 'CallAttemptCount' respondent field at the time of the call. It can be used to link call history data with survey data collected in the "call history" loop.

integer (int32)

callCenterId
optional

Unique identifier of the call center

integer (int32)

connectedTime
optional

The difference in seconds between the first time the phone connection was established within the interview and the last time the phone connection was disconnected within the interview.

integer (int32)

duration
optional

Duration of the call attempt in seconds

integer (int32)

endTime
optional

End Time of the call attempt

string (date-time)

extendedStatus
optional

Extended status that has been assigned to the interview after the call attempt

integer (int32)

id
optional

Unique identifier of the call

integer (int32)

interviewId
optional

Unique identifier of the interview

integer (int32)

interviewerId
optional

Unique identifier of the interviewer

integer (int32)

interviewerName
optional

Name of the Call Interviewer

string

links
optional

< string, object > map

openEndReviewDuration
optional

Duration of the Open End Review interview phase

integer (int32)

previewTime
optional

The difference in seconds between the interview start time and the first time the phone connection was established within the interview. Only applicable for Preview interviews.

integer (int32)

surveyId
optional

Unique identifier of the survey (pXXXXXXXX)

string

telephoneNumber
optional

Telephone number

string

time
optional

Time of the call attempt

string (date-time)

waitingTime
optional

Waiting time (in seconds) before the call has started

integer (int32)

wrapTime
optional

The difference in seconds between the last time the phone connection was disconnected within the interview and the start of the open end review (if open end review is enabled for the survey) or the interview end (if open end review is not enabled for the survey).

integer (int32)

CallState

Type : enum (toBeDeleted, disabledByFCD, scheduled, disabledByUser, toBeAddedFromSample, loadedToDialerPredictively, interviewInProgress)

DialType

Type : enum (landline, cellphone)

Dialer

Class representing information about the Dialer

Name Description Schema

dialType
optional

DialType

dialerStatus
optional

DialerStatus

id
optional

Unique identifier of the Dialer

integer (int32)

links
optional
read-only

< string, object > map

name
optional

Name of the Dialer

string

DialerStatus

Type : enum (disconnected, connected, connectedAndActivated)

DialingMode

Type : enum (undefined, manual, preview, automatic, predictive, specialDial)

Interview

Class representing information about the CATI interview

Name Description Schema

appointmentExpiration
optional

Time when scheduled appointment expires

string (date-time)

appointmentTime
optional

Time of the scheduled appointment

string (date-time)

assignedResourceId
optional

Id of the interviewer or group whom interview is assigned

string

assignedResourceName
optional

Name of the interviewer or group whom interview is assigned

string

callAttemptsCount
optional

Number of attempts to call for this respondent

integer (int32)

callId
optional

Unique identifier of the call associated with interview

integer (int32)

callState
optional

CallState

dialTypeId
optional

Id of the Dial type

Possible values:

0 Landline 1 Cellphone

integer (int32)

dialTypeName
optional

Type of the Dial

string

dialingMode
optional

DialingMode

expireTime
optional

Time when schedule expires

string (date-time)

extendedStatusId
optional

Id of the interview Status

integer (int32)

extendedStatusName
optional

Status of the interview

string

interviewId
optional

Unique identifier of the interview

integer (int32)

lastInterviewerId
optional

Id of the last interviewer called for this interviews

integer (int32)

lastInterviewerName
optional

Name of the last interviewer called for this interviews

string

links
optional

< string, object > map

priority
optional

Priority of the interviews

integer (int32)

respondentName
optional

Name of the respondent

string

reviewStatus
optional

ReviewStatus

shiftType
optional

Shift type of te call

string

shiftTypeId
optional

Id of the Shift type of te call

integer (int32)

surveyId
optional

Unique identifier of the survey (pXXXXXXXX)

string

telephoneNumber
optional

Telephone number of the respondent

string

timeOfLastCall
optional

Time of the latest attempt to call for this respondent

string (date-time)

timeToCall
optional

Scheduled time of the interviews value "1899-12-30T00:00:00+00:00" means that TimeToCall = Now

string (date-time)

timezoneId
optional

Respondent Timezone id

integer (int32)

timezoneName
optional

Respondent Timezone name

string

PublicApiError

Name Schema

correlationId
optional

string

message
optional

string

ResourceCollection[CallHistory]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< CallHistory > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[Dialer]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< Dialer > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ResourceCollection[Interview]

Name Schema

itemCount
optional

integer (int32)

itemType
optional

string

items
optional

< Interview > array

links
optional

< string, object > map

totalCount
optional

integer (int32)

ReviewStatus

Type : enum (notSentToReview, sentToReview, reviewStarted, reviewCompleted)

RootResponse

Name Schema

id
optional

string

links
optional

< string, object > map