Visão geral
Os dados da integração Moskit sincronizados na V4MOS.AI, pelos endpoints da própria integração
A API Moskit da V4MOS.AI entrega os registros brutos sincronizados das contas Moskit conectadas à sua organização: negócios, movimentações de etapa, contatos, funis, etapas, motivos de perda, campos personalizados e usuários. As linhas vêm como foram sincronizadas, com os nomes de coluna do data warehouse (snake_case), prontas para levar ao seu BI. Todos os endpoints usam o prefixo /v1/moskit e seguem a mesma autenticação, paginação e formato de resposta.
Primeiros passos
URL base: https://data.v4mos.ai. Toda chamada exige suas credenciais de API e o organizationId — veja Autenticação.
- Conecte a integração Moskit em app.v4mos.ai (Contas conectadas) e aguarde a primeira sincronização.
- Chame qualquer endpoint abaixo com o seu
organizationId, por exemploGET /v1/moskit/deals?organizationId=…. - Toda linha traz
integration_ideintegration_name: a conta conectada de onde ela veio. Para ler uma conta só, passe esse valor emintegrationId.
Endpoints disponíveis
- getNegócios
/v1/moskit/dealsUma linha por negócio: etapa, status, valor (em centavos), data de fechamento e previsão de fechamento, contato, empresa, responsável,… - getMovimentações de etapa
/v1/moskit/deal-stage-movementsUma linha por mudança de etapa de um negócio: etapa anterior e atual. - getContatos
/v1/moskit/contactsUma linha por contato: criador, responsável, fonte e origem. - getFunis
/v1/moskit/pipelinesUma linha por funil, com a prioridade. - getEtapas
/v1/moskit/stagesUma linha por etapa do funil, com a prioridade. - getMotivos de perda
/v1/moskit/lost-reasonsUma linha por motivo de perda de negócio. - getCampos personalizados
/v1/moskit/custom-fieldsUma linha por definição de campo personalizado: tipo, módulo e indicador de ativo. - getUsuários
/v1/moskit/usersUma linha por usuário da conta, com a equipe e o indicador de ativo.
Recursos
| Endpoint | O que é cada linha | Filtro dateFrom / dateTo |
|---|---|---|
GET /v1/moskit/deals | Uma linha por negócio: etapa, status, valor (em centavos), data de fechamento e previsão de fechamento, contato, empresa, responsável, fonte e origem. | date_created |
GET /v1/moskit/deal-stage-movements | Uma linha por mudança de etapa de um negócio: etapa anterior e atual. | date_created |
GET /v1/moskit/contacts | Uma linha por contato: criador, responsável, fonte e origem. | date_created |
GET /v1/moskit/pipelines | Uma linha por funil, com a prioridade. | date_created |
GET /v1/moskit/stages | Uma linha por etapa do funil, com a prioridade. | date_created |
GET /v1/moskit/lost-reasons | Uma linha por motivo de perda de negócio. | date_created |
GET /v1/moskit/custom-fields | Uma linha por definição de campo personalizado: tipo, módulo e indicador de ativo. | — |
GET /v1/moskit/users | Uma linha por usuário da conta, com a equipe e o indicador de ativo. | date_created |
Paginação e filtros
page(padrão 1) elimit(padrão 500, máximo 5000).meta.hasNextPagediz se existe outra página; as linhas vêm sempre na mesma ordem, então avance as páginas até ele serfalse.dateFrom/dateTo(YYYY-MM-DD, inclusivos) filtram pela coluna de data indicada na tabela acima. Recursos sem coluna de data recusam esses parâmetros.integrationIdmantém só as linhas de uma conta conectada.- As respostas ficam em cache por 30 minutos e os dados são sincronizados uma vez por dia — veja Sincronização de dados.
Dados pessoais
Alguns recursos da integração Moskit trazem dados pessoais dos seus clientes e contatos (como e-mail). Armazene e trate esses dados conforme a LGPD e a sua política de privacidade.
Formato da resposta
{
"data": [{ "...": "um objeto por linha, com as colunas listadas em cada endpoint" }],
"meta": {
"page": 1,
"limit": 500,
"hasNextPage": true,
"hasPreviousPage": false
}
}Valores monetários e contadores grandes (campos format: decimal e format: int64 no schema de cada endpoint) chegam como texto, por exemplo "125.50", para não perder precisão. Converta para um tipo decimal do seu lado.