Endpoint: Listando timeline de negócio

Endpoint que permite a listagem da timeline (interações e ações realizadas) de um negócio específico na plataforma da SULTS.

URL: https://api.sults.com.br/api/v1/expansao/negocio/<negocioId>/timeline

Método: GET

Parâmetros

Headers

Header	Valor
Authorization	<token_de_acesso>
Content-Type	application/json;charset=UTF-8

Path parameters

Parâmetro	Valor
negocioId	Id do negócio, deve ser passado na URL como parâmetro de path

Exemplo

fetch("https://api.sults.com.br/api/v1/expansao/negocio/1/timeline", {
	method: "GET",
	headers: {
		"Authorization":"<token_de_acesso>",
		"Content-Type":"application/json;charset=UTF-8"
	}
})

Resposta

{
	"data": [
		{
			"criado": "2019-08-26T13:28:18Z",
			"pessoa": {
				"id": 108,
				"nome": "User Teste"
			},
			"tipo": 1,
			"atividade": {
				"id": 41,
				"nome": "Reunião",
				"descricaoHtml": "",
				"tipo": {
					"nome": "REUNIAO",
					"id": 2
				},
				"dtAgendado": "2019-08-28T17:00:00Z",
				"dtConcluido": "2021-07-17T23:10:06Z",
				"concluido": true,
				"criador": {
					"nome": "User Teste",
					"id": 108
				},
				"responsavel": {
					"nome": "User Teste",
					"id": 108
				},
				"anexo": [
					{
						"id": 87,
						"nome": "Arquivo.xlsx",
						"url": "https://test.s3.amazonaws.com/treinamento/ExpansaoNegocio/44/Arquivo.xlsx",
						"tamanho": 7019,
						"dtUpload": "2023-08-11T19:17:55Z"
					}
				]
			}
		},
		{
			"criado": "2018-08-27T23:29:22Z",
			"pessoa": {
				"id": 108,
				"nome": "User Teste"
			},
			"tipo": 2,
			"mudancaSituacao": {
				"id": 3,
				"nome": "PERDA"
			}
		},
		{
			"criado": "2021-07-17T23:10:37Z",
			"pessoa": {
				"id": 108,
				"nome": "User Teste"
			},
			"tipo": 4,
			"mudancaEtapa": {
				"etapaAnterior": {
					"id": 5,
					"nome": "Negociação"
				},
				"etapaAtual": {
					"id": 2,
					"nome": "Contato Via email"
				}
			}
		},
		{
			"criado": "2021-11-08T12:49:47Z",
			"pessoa": {
				"id": 108,
				"nome": "User Teste"
			},
			"tipo": 5,
			"anotacao": {
				"id": 359,
				"descricaoHtml": "<p>Descrição Html</p>",
				"dtAnotacao": "2021-11-08T12:49:47Z",
				"editavel": true
			}
		},
		{
			"criado": "2023-08-11T19:17:55Z",
			"pessoa": {
				"id": 108,
				"nome": "User Teste"
			},
			"tipo": 6,
			"anexo": {
				"id": 87,
				"nome": "Arquivo.xlsx",
				"url": "https://test.s3.amazonaws.com/treinamento/ExpansaoNegocio/44/Arquivo.xlsx",
				"tamanho": 7019,
				"dtUpload": "2023-08-11T19:17:55Z"
			}
		},
		{
			"criado": "2021-07-17T23:10:04Z",
			"pessoa": {
				"id": 108,
				"nome": "User Teste"
			},
			"tipo": 9,
			"checkpoint": {
				"id": 6,
				"nome": "Verificar Spam",
				"dtConcluido": "2021-07-17T03:00:00Z",
				"descricaoHtml": "<p>Descrição Html</p>",
				"etapa": {
					"id": 10,
					"nome": "Entrada API"
				}
			}
		},
		{
			"criado": "2021-01-04T04:14:20Z",
			"pessoa": {
				"id": 108,
				"nome": "User Teste"
			},
			"tipo": 10,
			"chamado": {
				"id": 1,
				"nome": "Chamado Teste"
			}
		},
		{
			"criado": "2023-09-14T15:19:03Z",
			"pessoa": {
				"id": 108,
				"nome": "User Teste"
			},
			"tipo": 11,
			"avaliacao": {
				"id": 7,
				"nome": "cliente em potencial",
				"avaliacao": "Sim",
				"dtAvaliacao": "2023-09-14T03:00:00Z",
				"descricaoHtml": "<p>Descrição Html</p>",
				"situacao": 0,
				"avalicaoEtapa": {
					"id": 1,
					"nome": "Prospecção",
					"funil": {
						"id": 1,
						"nome": "Pipeline"
					}
				}
			}
		}
	]
}

Campos da reposta

Campos principais

Nome Atributo	Tipo	Descrição
criado	String	Data em que foi criado o item da timeline do negócio. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
pessoa	Objeto Pessoa simplificado: – id – nome	Pessoa que fez a interação na timeline do negócio.
tipo	Integer referente a um dos valores abaixo: 1 – Atividade 2 – Mudança de Situação 4 – Mudança de etapa 5 – Adição de anotação 6 – Adição de anexo 8 – Envio de email 9 – Checkpoint 10 – Adição de chamado 11 – Avaliação	Tipo da interação na timeline do negócio
atividade	Objeto Atividade	Interação do tipo atividade presente quando tipo for 1
mudancaSituacao	Objeto Mudanca Situação – id – nome	Interação do tipo mudança de situação presente quando o tipo for 2
mudancaEtapa	Objeto MudancaEtapa	Interação do tipo mudancaEtapa presente quando o tipo for 4
anotacao	Objeto Anotação	Interação do tipo anotação presente quando o tipo for 5
anexo	Objeto Anexo	Interação do tipo anexo presente quando o tipo for 6
email	Objeto Email	Interação do tipo envio de email presente quando o tipo for 8
checkpoint	Objeto Checkpoint	Interação do tipo checkpoint presente quando o tipo for 9
chamado	Objeto Chamado simplificado: – id – nome	Interação do tipo chamado presente quando o tipo for 10
avaliacao	Objeto Avaliação	Interação do tipo avaliação presente quando o tipo for 11

Campos do Objeto Atividade

Campo visível apenas quando o campo tipo é igual a 1

Nome Atributo	Tipo	Descrição
id	Integer	Código da atividade
nome	String	Nome da atividade
descricaoHtml	String	Descrição em texto HTML da atividade
tipo	Objeto Tipo da Atividade – id – nome Referente a um dos valores abaixo: 1 – Tarefa 2 – Reunião 3 – Visita 4- Ligação 5 – Email 6 – Mensagem	Tipo da atividade
dtAgendamento	String	Data de agendamento da atividade do negócio. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
dtConcluido	String	Data de conclusão da atividade do negócio. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
concluido	Boolean	Boleano que indica que a atividade foi concluída.
criador	Objeto Pessoa simplificado: – id – nome	Pessoa que criou atividade
responsavel	Objeto Pessoa simplificado: – id – nome	Pessoa responsavel por realizar a tividade
anexo	Objeto Anexo	Anexos da atividade

Campos do Objeto Anotação

Nome Atributo	Tipo	Descrição
id	Integer	Código da anotação
descricaoHtml	String	Descrição em texto HTML da anotação
editavel	Boolean	Indica se a anotação pode ser editada.
dtAnotacao	String	Data de anotação. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z

Campos do Objeto Email

Nome Atributo	Tipo	Descrição
id	Integer	Código do email
assunto	String	Assunto do email
mensagemHtml	String	Mensagem em texto HTML do email
dtEnviado	String	Data de envio do email. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
remetente	String	Remetente do email
destinatario	String	Destinatario do email

Campos do Objeto Checkpoint

Nome Atributo	Tipo	Descrição
id	Integer	Código do checkpoint
nome	String	Nome do checkpoint
descricaoHtml	String	Descrição em texto HTML do checkpoint
dtConcluido	String	Data de conclusão do checkpointl. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
etapa	Objeto Etapa	Etapa ao qual o checkpoint foi criado.

Campos do Objeto Etapa

Nome Atributo	Tipo	Descrição
id	Integer	Código da etapa
nome	String	Nome da etapa
funil	Objeto Funil – id – nome	Funil da etapa

Campos do Objeto Anexo

Nome Atributo	Tipo	Descrição
id	Integer	Código do anexo
nome	String	Nome do arquivo
dtUpload	String	Data em que foi realizado o upload do arquivo. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
url	String	Url do anexo
tamanho	Integer	Tamanho em bytes do anexo

Campos do Objeto Avaliacao

Nome Atributo	Tipo	Descrição
id	Integer	Código da avaliação
nome	String	Nome da avaliação
avaliacao	String	Texto com a resposta da avaliação
descricaoHtml		Descrição em texto HTML da avaliação
situacao	Integer referente a um dos valores abaixo: 0 – Aberto 1 – Positivo 2 – Negativo	Integer que informa a situação da avaliação
dtAvaliacao	String	Data em que foi realizado a avaliação. A data é apresentada no formato UTC ISO 8601. Exemplo: 2022-06-27T14:02:55Z
avalicaoEtapa	Objeto Etapa simplificado – id – nome	Etapa na qual foi criada a avaliação

Campos do Objeto MudançaEtapa

Nome Atributo	Tipo	Descrição
etapaAnterior	Objeto Etapa simplificado – id – nome	Etapa anterior a mudança de etapa do negócio
etapaAtual	Objeto Etapa simplificado – id – nome	Nova etpa do negócio

Atualizado em 28/03/2024