Sign in

v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB
Instruments

Get all instruments

Returns the list of all instruments.

get/instruments

Query parameters

hierarchical0 | 1

Filter instruments indicating whether they are hierarchical or not.

calculationType1 | 2 | 3 | 4

Filter instruments indicating what calculation type it uses. 1 - Answers avarage 2 - Answers categorization 3 - Categorization of the individual 4 - NPS

locked0 | 1

Indicates whether the instrument is blocked from receiving answers (when an instrument is blocked, its questions are not displayed in the survey).

sendType0 | 1 | 2 | 3

Filter instruments indicating what send type it uses. 0 - Unique 1 - Recurrent 2 - Trigger 3 - Manual

Response

Successful response

id_instrumentinteger

ID of the instrument

id_send_groupinteger

ID of the send group

id_clientinteger

ID of the client

uid_instrumentstring uuid

UUID of the instrument

namestring

Name of the instrument

activeinteger

Indicates if the instrument is active to send pulses (instruments not active doesnt have questions sended in the pulse)

lockedinteger

Indicates if the instrument is locked to receive answers

typestring

Type of the instrument

calculation_typeinteger

Indicates what calculation type the instrument uses. 1 - Answers avarage 2 - Answers categorization 3 - Categorization of the individual 4 - NPS

minimum_respondentsinteger

Indicates the minimum number of respondents to display score informations

lagginginteger

Number of weeks that an answer will be valid and considered when counting the instrument score

recencyinteger

Number of weeks that a question will not be shown to the user after it has been answered by them

all_at_onceinteger

Indicates whether all instrument questions will be sent at once to the user

max_questionsinteger

Indicates the maximum number of instrument questions that will be shown in the survey that is sent to users

hierarchicalinteger

Indicates if the instrument is hierarchical or not

confidentiality0 | 1 | 2

Indicates the confidentiality level of the instrument 0 - Identifiable 1 - Confidential 2 - Partially confidential

first_answer_datestring

When the first answer was inserted

last_answer_datestring

When the last answer was inserted

created_atstring

When the instrument was created

updated_atstring

When the instrument was created

deleted_atstring

When the instrument was deleted, null if it is not deleted