Artigos sobre: Programadores e API
Este artigo também está disponível em:

Estrutura de Dados & API

Existem 3 formas de se ligar à nossa API:



O que a API devolve


A API devolve um registo por participação: os campos do formulário, o resultado (pontuação, perfil ou prémio) e os campos técnicos, conforme indicado na tabela abaixo. Não devolve as respostas que cada jogador deu às perguntas de um quiz ou de uma pesquisa. Para consultar cada resposta, utilize a exportação de dados da sua aplicação, onde cada pergunta tem a sua própria coluna.


Quer apresentar os resultados em direto num ecrã de grandes dimensões, por exemplo, num evento? Utilize a classificação de jogadores: tem uma ligação própria, é atualizada em tempo real após cada participação e pode ser apresentada num ecrã separado.


Estrutura dos dados da API


Veja como pode preencher a coluna Exemplo de dados, com base nos formatos habitualmente utilizados para estes tipos de campos:


Chave

Descrição

Exemplo de dados

Id

Identificador único.

123456

appId

Identificador da aplicação.

123456

appRef

Referência interna da aplicação.

my campaign

idunic

Dados recolhidos no campo de identificador único.

ABC123XYZ

gender

Dados recolhidos no campo de género.

Male / Female / Prefer not to say

username

Dados recolhidos no campo de nome de utilizador.

johndoe

firstName

Dados recolhidos no campo de nome próprio.

John

lastName

Dados recolhidos no campo de apelido.

Doe

email

Dados recolhidos no campo de e-mail.

johndoe@example.com

dob

Dados recolhidos no campo de data de nascimento.

1990-01-01T00:00:00+01:00

address

Dados recolhidos no campo de morada.

123 Main St, Apt 4B

cp

Dados recolhidos no campo de código postal.

12345

town

Dados recolhidos no campo de cidade.

New York

country

Dados recolhidos no campo de país.

United States

phoneNumber

Dados recolhidos no campo de número de telefone.

+12025550199

companyName

Dados recolhidos no campo de nome da empresa.

Example Corp.

website

Dados recolhidos no campo de site.

https://www.example.com

optinNewsletter

Dados recolhidos através da caixa de seleção de consentimento.

true / false

customText

Dados recolhidos no campo de texto personalizado.

Valor personalizado introduzido

customFormat

Dados recolhidos no campo de formato personalizado.

Valor personalizado introduzido

profil

Perfil obtido numa aplicação de teste de personalidade, quiz ou pesquisa.

Explorer

profilUid

Identificador único do perfil obtido numa aplicação de teste de personalidade, quiz ou pesquisa.

EXPL123

score

Pontuação do utilizador numa aplicação baseada em pontos.

85

prizeUid

Identificador único do prémio. Se não tiver sido ganho nenhum prémio, devolve "lost".

0f8e4a298ba5c036c7db5e5ef1ce422e85ceb5e3 / lost

prizeTitle

Título do prémio registado quando o utilizador ganha um prémio.

Gold Membership

prizeRef

Referência do prémio registada quando o utilizador ganha um prémio.

GOLD2023

code

Código ganho pelo utilizador.

WIN12345

date

Data e hora do servidor.

2024-11-10T19:09:32+01:00

publisherId

Identificador do editor.

PUB123

sessionId

Identificador da sessão do utilizador.

Session_296c9d74f159eacf374a2ac4e9d6f028

countryCode

Código do país determinado a partir do endereço IP do utilizador.

FR

selectValue

Dados recolhidos no menu pendente personalizado.

Opção A

selectValue2

Dados recolhidos no segundo menu pendente personalizado.

Opção B

customCheckbox

Dados recolhidos na lista personalizada de caixas de seleção. Se forem selecionadas várias opções, os valores são separados por uma barra vertical. (∣)

Opção 1 ∣ Opção 2

timeTaken

Tempo que o utilizador passou na aplicação, em segundos.

360

levelsPlayed

Número total de níveis concluídos pelo utilizador nas experiências Combo™, Percurso Dinâmico™ ou Calendário De Advento. Devolve null para todos os outros tipos de jogos.

123456

referral

Origem do tráfego de referência.

direct

updatedAt

Data e hora da atualização dos dados.

2024-11-10T19:09:32+01:00

connectionCountry

País determinado a partir do endereço IP do utilizador.

France

updatedAtTimeStamp

Marca temporal da atualização dos dados.

1731262172

dateWithTimezone

Data e hora convertidas para o fuso horário da aplicação.

2024-11-10T17:09:32+01:00

played

Indicador que devolve true se o utilizador tiver jogado a mecânica de jogo e false caso contrário.

true / false

locale

Idioma da aplicação utilizado durante a experiência do utilizador.

en

ipAddress

Endereço IP do utilizador.

192.168.1.1

Actualizado em: 19/10/2026

Esse artigo foi útil?

Partilhe o seu feedback

Cancelar

Obrigado!