Skip to main content
GET
Consultar indicadores por etapa

Autorizações

Authorization
string
header
obrigatório

Token da API no formato sk_live_….

Parâmetros de consulta

page
integer
padrão:1

Número da página, começando em 1. Um valor inválido é tratado como 1.

Intervalo obrigatório: x >= 1
perPage
integer
padrão:20

Quantidade de itens por página. O máximo depende do ambiente (padrão 100).

Intervalo obrigatório: 1 <= x <= 100
boardId
integer

Limita os indicadores a um painel. Sem o parâmetro, considera todos os painéis que você pode ver.

dateFrom
string<date>

Início do período analisado. O dia começa no fuso da sua empresa.

dateTo
string<date>

Fim do período analisado. O dia termina às 23:59:59 no fuso da sua empresa.

won
enum<string>
padrão:all

Filtra pela situação do card: won ganhos, lost perdidos, inProgress em andamento, all todos.

Opções disponíveis:
all,
won,
lost,
inProgress

Resposta

200 - application/json

OK

data
object[]
meta
object
Exemplo: