Configurações e Origem de Dados

Disponível para planos Extremo e Enterprise.

Caso opte por partir de um template, foi disponibilizado para o Microsoft Power BI. Neste modelo já temos as fontes de dados conectadas, bem como relatórios já criados.

Integração

A integração com os dados é realizada através de uma API REST que retorna um JSON contendo os dados solicitados.

Autenticação

A autenticação é realizada através de uma chave de acesso única, gerada por empresa. Esta chave pode ser revogada e dá acesso somente aos dados da empresa vinculada.

Para acessar a chave, acesse a aba BI na rotina de Minha Empresa.

Códigos de Retorno

Os retornos indicam possíveis erros ao buscar os dados, como falta de plano Performance, empresa inativa, chave inválida ou filtros incorretos.

Tipo	Id	Observação
BadRequest	402	Mensagem indicando o erro
NotFound	404	Quando chave ou empresa não encontrada
Success	200	Sucesso - retorna os dados
Forbidden	403	Quando não possui acesso (chave revogada ou empresa inativa)

{
  "error": {
    "id": "31",
    "message": "Token de acesso inválido.",
    "details": null,
    "code": "404"
  },
  "data": null
}

Estrutura de Resposta

O grupo de informações paging é retornado apenas para métodos que possuem paginação (ex: apontamento de horas).

{
  "error": null,
  "data": [
    {
      "id": 12067,
      "subject": "site teste",
      "status": 1,
      "source": 2,
      "type": 4,
      "reOpenCount": 0,
      "actualTime": 0,
      "createdIn": "2020-12-07T16:20:02.6753916",
      "concludedIn": null,
      "priority": 10,
      "priorityGroup": 0,
      "workspaceId": 84,
      "workspace": "Bombeiros - CBVJ",
      "createdById": "0d33961f-7a7f-4c61-ac7b-43d6c242844d",
      "createdBy": "Cliente teste 01",
      "requestById": "0d33961f-7a7f-4c61-ac7b-43d6c242844d",
      "requestBy": "Cliente teste 01",
      "executorId": "05500656-5b59-47ba-870d-56189ee27b43",
      "executor": "Carlos",
      "phaseId": 4,
      "phase": "Produção",
      "timeFirstResponse": 19,
      "iterations": 27
    }
  ],
  "paging": {
    "currentPage": { "size": 100, "number": 1 },
    "totalCollectionSize": 17575,
    "totalPages": 176
  }
}

Requisições

Para acessar os dados, realize uma requisição GET para o endpoint desejado combinando a apiKey e os filtros.

Importante

A apiKey deve ser enviada em todas as requisições como parâmetro de query.

Exemplo de URL: https://api.ekyte.com/v1.1/tasks?apiKey=xxx&createdFrom=2022-01-15&status=0&page=1

Tarefas

Objetivo: Listar tarefas da empresa relacionadas a chave, seguindo filtros definidos.

GET /v1.1/tasks

Endpoint principal para consulta de tarefas.

Filtros e Parâmetros

Filtro por	Campo	Tipo	Descrição
Workspace	workspaceId	numérico	ID da Workspace para filtro
Criação Ini	createdFrom	data	AAAA-MM-DD (ex: 2022-01-25)
Criação Fim	createdTo	data	AAAA-MM-DD
Entrega Ini	dueFrom	data	AAAA-MM-DD
Entrega Fim	dueTo	data	AAAA-MM-DD
Etapa Ini	phaseDateFrom	data	AAAA-MM-DD
Etapa Fim	phaseDateTo	data	AAAA-MM-DD
Conclusão Ini	resolvedDateFrom	data	AAAA-MM-DD
Conclusão Fim	resolvedDateTo	data	AAAA-MM-DD
Situação	status	numérico	10: Ativas, 20: Pausadas, 30: Concluídas, 40: Canceladas
Projeto	projectId	numérico	id do projeto desejado
Tipo de Tarefa	taskTypeId	numérico	id do tipo de tarefa desejado
Etapa atual	phaseId	numérico	Indicador da etapa corrente
Squad	SquadId	numérico	Quando informado o workspace será ignorado
Checklists	includeChecklist	numérico	'1' para retornar checklists
Phases	includePhases	numérico	'1' para retornar etapas
Comentários	includeComments	numérico	'1' para retornar comentários

Descritivo dos Campos

Campo	Tipo	Descrição
id	numérico	identificador único da tarefa
title	texto	título da tarefa
description	texto	descrição da tarefa
allocationType	numérico	controle de esforço da tarefa
workspaceId	numérico	id workspace
workspace	texto	nome workspace
situation	numérico	10: Ativas, 20: Pausadas, 30: Concluídas, 40: Canceladas
priority	numérico	10: Não priorizada, 100: Baixa, 200: Média, 300: Alta, 400: Urgente
priorityGroup	numérico	0 a 100 - indicando prioridade
estimatedTime	numérico	tempo previsto em minutos
actualTime	numérico	tempo apontado em minutos
phaseId	numérico	etapa atual
phase	texto	nome etapa atual
coPhaseId	numérico	id da co-etapa atual
coPhase	texto	nome da co-etapa atual
creationDate	data/hora	data de criação da tarefa
originalDueDate	data/hora	data de entrega original
currentDueDate	data/hora	data de entrega atual
phaseStartDate	data/hora	data de início da etapa atual
phaseDueDate	data/hora	data de entrega da etapa atual
resolvedDate	data/hora	data de conclusão da tarefa (situation = 30)
createdById	numérico	id do usuário criador
createdBy	texto	nome do usuário criador
executorId	numérico	id do executor atual
executor	texto	nome do executor atual
coExecutorId	numérico	id do co-executor atual
coExecutor	texto	nome do co-executor atual
projectId	numérico	id do projeto
project	texto	nome do projeto
projectAlias	texto	identificação do projeto
ctcTaskTypeId	numérico	id do tipo de tarefa
ctcTaskType	texto	nome do tipo de tarefa
ctcTaskPredecessorId	numérico	id da tarefa predecessora
ctcTaskPredecessor	texto	nome da tarefa predecessora
channelId	numérico	id do canal
channel	texto	nome do canal
mediaId	numérico	id mídia
media	texto	nome da mídia
quantity	numérico	quantidade de peças

Campo	Tipo	Descrição
id	numérico	id único
nome	texto	nome do checklist
completedIn	data/hora	data de conclusão
completedBy	texto	usuário que encerrou
phase	texto	Etapa vinculada
ctcTaskId	numérico	Id da tarefa
sequential	numérico	ordem do item

Campo	Tipo	Descrição
id	numérico	id único
effort	numérico	esforço previsto
sequential	numérico	ordem do item das etapas
actualTime	numérico	esforço realizado
phase	texto	Nome da etapa
ctcTaskId	numérico	Id da tarefa
phaseStartDate	data	início etapa
phaseDueData	data	conclusão etapa
phaseId	numérico	Id da etapa
cophaseId	numérico	Id da co-etapa
executorId	numérico	id do executor atual
executor	texto	nome do executor atual

Projetos

Objetivo: Listar projetos da empresa relacionadas a chave, seguindo filtros definidos.

GET /v1.0/projects

Endpoint para consulta de projetos ativos e arquivados.

Filtros

Campo	Tipo	Descrição
workspaceId	numérico	ID da Workspace para filtro
createdFrom	data	Data inicial (AAAA-MM-DD)
createdTo	data	Data final (AAAA-MM-DD)

Descritivo dos campos

Campo	Tipo	Descrição
id	numérico	identificador único do projeto
name	texto	nome do projeto
alias	texto	identificador único textual
link	texto	link do projeto
workspaceId	numérico	id do workspace
workspace	texto	nome do workspace
startDate	data	início planejado
endDate	data	fim planejado
plannedTasksCount	numérico	total de tarefas no projeto
accomplishedTasksCount	numérico	total de tarefas concluídas
plannedTasksTime	numérico	esforço total previsto (minutos)
accomplishedTasksTime	numérico	esforço realizado (minutos)
plannedProjectTasksCount	numérico	total de tarefas planejadas
ctcTaskProjectTasksCount	numérico	total de tarefas
expectedEffort	numérico	esforço previsto total
trend	numérico	tendência de entrega
plannedManualBudget	numérico	orçamento planejado
hourlyBudget	numérico	valor hora
plannedTotalEstimatedHourlyRate	numérico	valor previsto planejado
plannedTotalAccomplishedHourlyRate	numérico	valor realizado planejado
totalEstimatedExpense	numérico	despesas previstas
totalRealizedExpense	numérico	despesas realizadas
unplannedProjectTasksCount	numérico	total de tarefas não planejadas
situation	numérico	0: Inativo, 1: Ativo, 2: Arquivado
createdById	numérico	id do usuário criador
createdBy	texto	nome do usuário criador
tags	texto	lista de tags do projeto
createdIn	data	data de criação
planned	numérico	0: Não planejado, 1: Planejado

Tickets

Objetivo: Listar tickets da empresa relacionada a chave, seguindo filtros definidos.

GET /v1.1/tickets

Endpoint para gestão de tickets de suporte e solicitações.

Filtros

Filtro por	Campo	Tipo	Descrição
Workspace	workspaceId	numérico	ID da Workspace para filtro
Squad	squadId	numérico	ID do SQUAD para filtro
Criação Ini	createdFrom	data	AAAA-MM-DD
Criação Fim	createdTo	data	AAAA-MM-DD
Conclusão	ResolvedDateFrom	data	AAAA-MM-DDTHH:mm:ss
Situação	status	numérico	1: Em atendimento, 2: Aguardando solicitante, 3: Resolvido, 9: Cancelado
Histórico	iterations	numérico	'1' para retornar o histórico de etapas

Descritivo dos campos

Campo	Tipo	Descrição
id	numérico	id único do ticket
subject	texto	Assunto do ticket
link	texto	link do ticket
workspaceId	numérico	id do workspace
workspace	texto	nome do workspace
status	numérico	1: Atendimento, 2: Aguardando, 3: Resolvido, 9: Cancelado
createdIn	data	data e hora da criação
expectDueDate	data	previsto para
priority	numérico	10: Não priorizada a 400: Urgente
priorityGroup	numérico	0 a 100 - indicando prioridade
source	numérico	1: Interno, 2: Externo
type	numérico	1: Solicitação, 2: Dúvida, 3: Correção, 4: Orçamento, 5: Melhoria
concludedIn	data	data/hora da conclusão
reopenCount	numérico	contador de reaberturas
createdById	numérico	id do criador
createdBy	texto	nome do criador
requesterById	numérico	id do solicitante
requesterBy	texto	nome do solicitante
executorId	numérico	id do executor atual
executor	texto	nome do executor atual
executorEmail	texto	email do executor atual
phaseId	numérico	id da etapa atual
phase	texto	etapa atual
actualTime	numérico	tempo apontado em minutos
timeFirstResponse	numérico	tempo (min) entre abertura e primeiro retorno
iterations	numérico	total de iterações com o cliente

Campo	Tipo	Descrição
field	texto	campo alterado
from	texto	valor anterior
to	texto	novo valor
when	data	quando ocorreu a alteração
action	texto	ação realizada

Apontamento de Horas

Objetivo: Listar apontamentos da empresa relacionadas a chave, seguindo filtros definidos.

GET /v1.0/time-trackings

Endpoint para extração de logs de produtividade e esforço.

Filtros

Filtro por	Campo	Tipo	Descrição
Workspace	workspaceId	numérico	ID da Workspace
Squad	squadId	numérico	ID do SQUAD
Criação Ini	createdFrom	data	AAAA-MM-DD
Criação Fim	createdTo	data	AAAA-MM-DD

Descritivo dos campos

Campo	Tipo	Descrição
id	numérico	identificador único
effort	numérico	Tempo total do apontamento em minutos
workspaceId	numérico	id do workspace
workspace	texto	nome do workspace
status	numérico	10: Pendente (timer), 20: Concluído, 30: Cancelado
createdIn	data	data e hora da criação
startDate	data	data e hora da ínicio
endDate	data	data e hora da fim
comment	texto	comentário informado
ctcTaskId	numérico	id da tarefa relacionada
ctcTask	texto	título da tarefa relacionada
ctcTaskTypeId	numérico	id do tipo tarefa
ctcTaskType	texto	título do tipo de tarefa
executorId	texto	id do executor
executor	texto	nome do executor
accomplishedHourlyRate	numérico	valor realizado (custo usuário)
phaseId	numérico	id da etapa
phase	texto	nome da etapa
planningId	numérico	id do plano
planning	texto	nome do plano
adId	numérico	id do anúncio
ad	texto	nome do anúncio
adSetId	numérico	id do grupo anúncio
adSet	texto	nome do grupo anúncio
ticketId	numérico	id do Ticket
ticket	texto	assunto do ticket

Data Driven

Objetivo: Listar dados importados para o eKyte Data-driven. Cada linha representa uma métrica.

GET /v1.0/insights

A leitura é paginada em 500 registros por página.

Filtros

Filtro por	Campo	Tipo	Descrição
Workspace	workspaceId	numérico	ID da Workspace
Squad	squadId	numérico	ID do SQUAD
Data Inicial	startDate	data	AAAA-MM-DD
Data Final	endDate	data	AAAA-MM-DD

Descritivo dos campos

Campo	Tipo	Descrição
externalId	texto	ID de identificação externo
value	numérico	Valor da conversão (custo / leads / etc)
workspaceId	numérico	id do workspace
workspace	texto	nome do workspace
date	data	Data de registro da métrica
updatedIn	data	data da última atualização
endDate	data	data e hora da fim
metric	numérico	id de identificação da métrica
metricName	texto	10: Valor Gasto, 20: Impressões, 21: Alcance, 30: Cliques, 31: Tráfego Total, 32: Sessões, 41: Base Remarketing Google Display, 42: Base Remarketing FB, 43: Base Lista E-mail, 50: Leads, 51: Base e-mails, 60: Apresentação, 70: Proposta, 80: Trial, 90: Conta, 100: Receita, 110: Adicionar ao carrinho, 120: Saldo (Meta Ads)
channelId	numérico	id do canal de conversão
channel	texto	nome do canal canal de conversão
mediaId	numérico	id midia de conversão
media	texto	nome da midia de conversão
sourceChannelId	numérico	id do canal de origem do dado
sourceChannel	texto	nome do canal canal de origem do dado
sourceMediaId	numérico	id midia de de origem do dado
sourceMedia	texto	nome da midia de origem do dado
campaignId	texto	id da campanha
campaign	texto	nome da campanha
adSetId	texto	id do grupo de anúncio
adSet	texto	nome do grupo de anúncio

Respostas de Formulários

Objetivo: Apresentar respostas enviadas em formulários.

GET /v1.0/forms/answers

A leitura é paginada em 50 registros por página. Requer formId.

Descritivo dos campos

Campo	Tipo	Descrição
Id da Resposta	numérico	ID de identificação
Id do Formulário	numérico	Id do formulário
Nome formulário	texto	nome do formulário
Id da tarefa	numérico	id da tarefa relacionada
workspaceId	numérico	id do workspace
workspace	texto	nome do workspace
date	data	Data da criação
Criado por	texto	email do usuário que preencheu
Campos do formulário	texto	Nome do campo: Valor da resposta

Conclusão de Etapas

Objetivo: Retorna dados referentes a conclusão de etapas para as tarefas.

GET /v1.2/activities/performance

A leitura é paginada em 50 registros. Use dateFrom para leitura incremental.

Descritivo dos campos

Campo	Tipo	Descrição
Id	numérico	ID de identificação do registro
Id da tarefa	numérico	id da tarefa
Tarefa	texto	título da tarefa
workspaceId	numérico	id do workspace
workspace	texto	nome do workspace
executor	texto	nome do executor
executorEmail	texto	email do executor
etapa	texto	nome da etapa
fluxo	texto	nome da fluxo
expectedPhaseStartDate	data	Data estimada para início da etapa
expectedPhaseDueDate	data	Data estimada para conclusão da etapa
realPhaseStartDate	data	Data real de início da etapa
realPhaseDueDate	data	Data real de conclusão da etapa
overdue	bool	Indica se etapa foi entregue em atraso

Projetos (Apenas Matriz)

Objetivo: Retornar todos os projetos de uma determinada unidade para empresas MATRIZ.

GET /v1.3/branches/projects

Endpoint exclusivo para empresas do tipo MATRIZ. Requer companyId.

Descritivo dos campos

Campo	Tipo	Descrição
id	numérico	id único do projeto
name	texto	identificação do projeto
workspaceId	numérico	id do workspace
workspace	texto	nome do workspace
alias	texto	alias do projeto
createdIn	data	data e hora da criação
startDate	data	início real
endDate	data	fim real
situation	numérico	0: Inativo, 1: Ativo, 2: Arquivado
workspaceExternalId	numérico	identificador externo (CNPJ)
tasks	array	lista das tarefas do projeto
companyId	numérico	id da empresa

{
  "data": [
    {
      "id": 8682,
      "name": "Criação de Site",
      "tasks": [
        {
          "title": "Site JN Construtora",
          "phases": [
            { "phase": "Design", "actualTime": 350 }
          ]
        }
      ]
    }
  ]
}

Outros Endpoints

GET /v1.0/workspaces - Listar workspaces e seus squads vinculados. Campos: Id, Name, squadId, Active, Description, ExternalId.

GET /v1.0/tags - Tags compartilhadas, de projeto ou data-driven. Campos: Id, Name, Type (0: Padrão, 10: Data Driven, 20: Projeto).

GET /v1.0/task-types - Categorias e fluxos de trabalho configurados. Campos: Id, Name, Workflow, CtcTaskTypeGroup, FlowPhases.

GET /v1.0/squads - Lista os times (squads) da empresa. Campos: Id, Name.

GET /v1.0/users - Dados cadastrais e perfis dos usuários. Campos: Id, Email, Name, Username, ProfileCompany, Position, HourlyRate.

GET /v1.0/insights/organic - Dados de redes sociais. Campos: value, Metric, Frequency, workspaceId, channel, media, postId, ExternalCreatedAt.

GET /v1.0/boards - Quadros e notas da base de conhecimento. Campos: Id, Title, Description, Active, Notes (Id, Title, Content, Status).

Configurações e Origem de Dados

Integração

Autenticação

Códigos de Retorno

Estrutura de Resposta

Requisições

Tarefas

Filtros e Parâmetros

Descritivo dos Campos

Projetos

Filtros

Descritivo dos campos

Tickets

Filtros

Descritivo dos campos

Apontamento de Horas

Filtros

Descritivo dos campos

Data Driven

Filtros

Descritivo dos campos

Respostas de Formulários

Descritivo dos campos

Conclusão de Etapas

Descritivo dos campos

Projetos (Apenas Matriz)

Descritivo dos campos

Outros Endpoints

Leia Também

Lançamento eKyte BI

Rotina de BI

Conectar Power BI

Integração Excel

Gestão Financeira

Nesta página