Buscar Pesquisa InApp Elegível

Busca se existe uma pesquisa a ser exibida para um cliente no canal InApp (Sistemas Legados). Retorna: 'eligible' (se o cliente é elegível para ver a pesquisa agora); 'complementSurvey' (se ele já respondeu a métrica principal mas pode deixar comentário); 'survey' (estrutura completa da pesquisa com perguntas, cores e automações); 'surveyAnswer' (objeto da sessão — o '_id' dele deve ser usado nos endpoints de Enviar Resposta e Ignorar Pesquisa).

curl -X POST "https://api.amplifique.me/partners/cf/inApp" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY" \
  -d '{
  "name": "João da Silva",
  "email": "joao@example.com",
  "company": "Empresa Teste",
  "phone": "+5542999999999",
  "custom_fields": {
    "regiao": "SUL",
    "id": 12345
  }
}'

import requests
import json

url = "https://api.amplifique.me/partners/cf/inApp"
headers = {
  "Content-Type": "application/json",
  "Authorization": "YOUR_API_KEY"
}
data = {
  "name": "João da Silva",
  "email": "joao@example.com",
  "company": "Empresa Teste",
  "phone": "+5542999999999",
  "custom_fields": {
    "regiao": "SUL",
    "id": 12345
  }
}

response = requests.post(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://api.amplifique.me/partners/cf/inApp", {
  method: "POST",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "YOUR_API_KEY"
},
  body: JSON.stringify({
  "name": "João da Silva",
  "email": "joao@example.com",
  "company": "Empresa Teste",
  "phone": "+5542999999999",
  "custom_fields": {
    "regiao": "SUL",
    "id": 12345
  }
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "name": "João da Silva",
  "email": "joao@example.com",
  "company": "Empresa Teste",
  "phone": "+5542999999999",
  "custom_fields": {
    "regiao": "SUL",
    "id": 12345
  }
}`)

    req, err := http.NewRequest("POST", "https://api.amplifique.me/partners/cf/inApp", bytes.NewBuffer(data))
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "YOUR_API_KEY")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api.amplifique.me/partners/cf/inApp')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'YOUR_API_KEY'
request.body = '{
  "name": "João da Silva",
  "email": "joao@example.com",
  "company": "Empresa Teste",
  "phone": "+5542999999999",
  "custom_fields": {
    "regiao": "SUL",
    "id": 12345
  }
}'

response = http.request(request)
puts response.body

{
  "message": "OK",
  "eligible": true,
  "complementSurvey": false,
  "survey": {
    "_id": "60e336ef69a03a000e20164d",
    "title": "Pesquisa InApp",
    "anonymous": false,
    "active": true,
    "draft": false,
    "archived": false,
    "primary_color": "#ffca00",
    "button_text_color": "#ffffff",
    "smartTagsEnabled": true,
    "survey_logo": "https://cdn.filestackcontent.com/SPQDJyczSjGTbxYbjgeV",
    "channels": [
      "inapp",
      "link-qrcode"
    ],
    "questions": [
      {
        "_id": "example_string",
        "type": "nps",
        "internal_name": "nps_1",
        "pre_text": "Gostaríamos de saber a sua opinião!",
        "unlikely_text": "Pouco provável",
        "likely_text": "Muito provável",
        "accept_others": false,
        "isTextArea": false,
        "options": "null",
        "required": false,
        "variations": [
          {
            "_id": "example_string",
            "condition": null,
            "question": "Em uma escala de 0 a 10, qual a probabilidade de recomendar nossa empresa?",
            "placeholder": null,
            "show": false
          }
        ]
      }
    ],
    "thankyou_page": {
      "skip": false,
      "url_to_skip": "",
      "variations": [
        {
          "_id": "example_string",
          "condition": null,
          "message": "Obrigado por responder nossa pesquisa!"
        }
      ]
    },
    "inapp_params": {
      "first_survey": 40,
      "dismiss_resurvey_throttle": null,
      "observation_resurvey_limit": 7,
      "time_delay": null
    },
    "automations": [
      {
        "_id": "example_string",
        "condition": "nps_1,maior,8",
        "action": "referral_on_screen",
        "type": "true",
        "params": {
          "referralCampaign": "5f888e037e4ec0000e91f12b"
        }
      }
    ],
    "_business": {
      "_id": "5b5765bec9498b0014883c0b",
      "_empresa": "59c94ff5e5b20500126eadde"
    },
    "created_at": "2024-12-25T10:00:00Z",
    "updated_at": "2024-12-25T10:00:00Z"
  },
  "surveyAnswer": {
    "_id": "61ddbce5b038c4c87c78b9b4",
    "_survey": "60e336ef69a03a000e20164d",
    "channel": 4,
    "sent_at": "2022-01-11T17:22:45.150Z",
    "opened_at": "2022-01-11T17:22:45.150Z",
    "origin": "API",
    "anonymized": false,
    "_customer": "616ef4659ce878549d16c718",
    "_business": "5b5765bec9498b0014883c0b",
    "_smartTags": [
      "example_string"
    ],
    "billing_restriction": true,
    "answers": [
      {}
    ],
    "created_at": "2022-01-11T17:22:45.154Z"
  }
}

POST

/partners/cf/inApp

POST

API Key (header: Authorization)

Authorizationstring

Required

API key (sent in header)

Content-Typestring

Required

The media type of the request body

Options: application/json

Nome do cliente

E-mail do cliente

Empresa do cliente

Telefone no padrão E.164

custom_fieldsobject

Campos customizados do cliente

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

API Key for authentication. Provide your API key in the header.

Body

application/json

Nome do cliente

E-mail do cliente

Empresa do cliente

Telefone no padrão E.164

custom_fieldsobject

Campos customizados do cliente

Responses

messagestring

eligibleboolean

Se o cliente é elegível para ver e responder a pesquisa agora

complementSurveyboolean

Se o cliente já respondeu a métrica principal mas pode ainda complementar com comentário

surveyobject

Estrutura completa da pesquisa configurada

_idstring

ID da pesquisa

titlestring

Título da pesquisa

anonymousboolean

Se a pesquisa é anônima

activeboolean

draftboolean

Se a pesquisa ainda é rascunho

archivedboolean

primary_colorstring

Cor principal da pesquisa em hexadecimal

button_text_colorstring

Cor do texto dos botões em hexadecimal

smartTagsEnabledboolean

Se SmartTags estão ativas nesta pesquisa

survey_logostring

URL da logo exibida na pesquisa

channelsstring[]

Canais habilitados para esta pesquisa

questionsarray

Perguntas da pesquisa

_idstring

typestring

Tipo da pergunta

Allowed values:npscsatcesuniquemultipleselecttextthumbslikertmatrix

internal_namestring

Nome interno usado para identificar a pergunta nas respostas

pre_textstring

Texto exibido antes da pergunta

unlikely_textstring

Rótulo do extremo negativo (NPS/CES)

likely_textstring

Rótulo do extremo positivo (NPS/CES)

accept_othersboolean

Se aceita opção 'Outros' (para tipos multiple e unique)

isTextAreaboolean

Para perguntas de texto: se deve exibir textarea (true) ou campo de linha única (false)

optionsarray,null

Opções de resposta (para tipos unique, multiple e select)

requiredboolean

Se a pergunta é obrigatória

variationsarray

Variações do texto da pergunta conforme condição. O item com condition: null é o padrão.

_idstring

conditionstring,null

Condição para exibir esta variação (ex: 'nps_1,menor,7'). null = variação padrão.

questionstring

Texto da pergunta

placeholderstring,null

Placeholder do campo (para perguntas de texto)

showboolean

Se a variação tem lógica de exibição condicional

thankyou_pageobject

Configuração da página de agradecimento exibida após a pesquisa

skipboolean

Se deve pular o agradecimento e redirecionar para URL externa

url_to_skipstring

URL para redirecionamento quando skip: true

variationsarray

Variações da mensagem de agradecimento por condição. O item com condition: null é o padrão.

_idstring

conditionstring,null

Condição para exibir esta mensagem (ex: 'nps_1,menor,7'). null = mensagem padrão.

messagestring

Texto de agradecimento

inapp_paramsobject

Parâmetros de controle de exibição InApp

first_surveyinteger

Quantos dias após o cadastro do cliente a pesquisa começa a ser exibida

dismiss_resurvey_throttleinteger,null

Dias de espera após o cliente fechar a pesquisa sem responder antes de exibir novamente

observation_resurvey_limitinteger

Limite de dias para reaplicar a pesquisa após resposta

time_delayinteger,null

Delay em segundos antes de exibir a pesquisa na tela

automationsarray

Automações configuradas na pesquisa (ex: exibir referral ou review em tela após resposta)

_idstring

conditionstring

Condição que dispara a automação (ex: 'nps_1,maior,8')

actionstring

Ação a executar (ex: referral_on_screen, review_on_screen)

typestring

paramsobject

Parâmetros adicionais da automação

_businessobject

_idstring

ID da unidade

_empresastring

ID da empresa

created_atstring

updated_atstring

surveyAnswerobject

Objeto da pesquisa-resposta criado para esta sessão. O _id deste objeto deve ser passado nos endpoints de Enviar Resposta (PUT /partners/cf/inApp/(id)) e Ignorar Pesquisa (PATCH /partners/cf/inApp/(id)/decline).

_idstring

ID da pesquisa-resposta — usar este valor nos endpoints subsequentes

_surveystring

ID da pesquisa

channelinteger

Canal: 4 = InApp

sent_atstring

Data/hora do envio

opened_atstring

Data/hora de abertura

originstring

anonymizedboolean

_customerstring

ID do contato

_businessstring

ID da unidade

_smartTagsstring[]

billing_restrictionboolean

answersobject[]

Respostas já registradas (vazio na criação)

created_atstring

Was this page helpful?