GUgupy
Instruments

Consulta dados do instrumento via uid_instrument

Retorna um instrumento via uid_instrument

get/instruments/{uid_instrument}

Request

  • Base URL
    https://www.pulses.com.br/api/engage/v1
  • URL
    https://www.pulses.com.br/api/engage/v1/instruments/{uid_instrument}
  • Auth
    API key in header Authorization

Path parameters

uid_instrumentstring required

uid instrument

Response

Successful response

uid_instrumentstring uuid

UUID of the instrument

id_instrumentinteger

ID of the instrument

id_send_groupinteger

ID of the send group

id_instrument_referenceinteger

ID instrument reference

namestring

Name of the instrument

typestring

Type of the instrument

all_at_onceinteger

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

recencyinteger

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

max_questionsinteger

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

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

hierarchicalinteger

Indicates if the instrument is hierarchical or not

anonymous0 | 1 | 2

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

messagesstring

null

questions_configobject

{}

send_type0 | 1 | 2 | 3

0 - Único | 1 - Recorrente | 2 - Gatilho | 3 - Manual

current_cycleinteger

0

is_deepening_cycleinteger

0

frequencyinteger

0

groupsobject

[]

Changes

No recorded changes to this operation across all 1 revision of this API.