
1. Add your CV CRM access
- In the Sources tab, click on the “Add source” button located on the top right of your screen. Then, select the CV CRM option from the list of connectors.
-
Click Next and you’ll be prompted to add the connector configuration:
- Email: the email address used to authenticate against the API service. This should be a valid email address with enough permissions to access the CV CRM data you want to extract. The email should be in the format
user@example.com. - API token: the authentication token required to access the API service. Please check this documentation to find more information about how to generate the token.
- Company subdomain: the subdomain identifier for your company account. For example, if your CRM URL is
https://mycompany.cvcrm.com.br, then your company subdomain would bemycompany. - Start date: the date from which you want to begin synchronizing data. This defines the earliest point in time for historical extraction. Any data created or modified before this date will not be included in the synchronization.
- Email: the email address used to authenticate against the API service. This should be a valid email address with enough permissions to access the CV CRM data you want to extract. The email should be in the format
- Click Next.
2. Select your CV CRM data streams
- The next step is letting us know which streams you want to bring. You can select entire groups of streams or only a subset of them.
- Click Next.
3. Configure your CV CRM data streams
-
Customize how you want your data to appear in your catalog. Select the desired layer where the data will be placed, a name for each table (which will effectively contain the fetched data) and the type of sync.
- Layer: choose between the existing layers on your catalog. This is where you will find your new extracted tables as the extraction runs successfully.
- Table name: we suggest a name, but feel free to customize it. You have the option to add a prefix to all tables at once and make this process faster!
- Sync Type: depending on the data you are bringing to the lake, you can choose between INCREMENTAL and FULL_TABLE. Read more about Sync Types here.
- Click Next.
4. Configure your CV CRM data source
- Describe your data source for easy identification within your organization. You can inform things like what data it brings, to which team it belongs, etc.
- To define your Trigger, consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times).
-
Optionally, you can define some additional settings (if available).
- Configure Delta Log Retention and determine for how log we should store old states of this table as it gets updated. Read more about this resource here.
- Determine when to execute an Additional Full Sync. This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.
Check your new source!
- Click Done to finalize the setup. Once completed, you’ll receive confirmation that your new source is set up!
- You can view your new source on the Sources page. Now, for you to be able to see it on your Catalog, you have to wait for the pipeline to run. You can now monitor it on the Sources page to see its execution and completion. If needed, manually trigger the pipeline by clicking on the refresh icon. Once executed, your new table will appear in the Catalog section.
If you encounter any issues, reach out to us via Slack, and we’ll gladly assist you!
Streams and Fields
Below you’ll find all available data streams from CV CRM and their corresponding key fields:Leads
Leads
leads.Endpoint:/cvdw/leads
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidleadidsituacaosituacao
Additional Fields
Additional Fields
additional_fields.Endpoint:/cvdw/campos_adicionais
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidcampocampo_nomeidfuncionalidade
Sales
Sales
sales.Endpoint:/cvdw/vendas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidreservadata_reservadata_venda
Reservas
Reservas
reservas.Endpoint:/cvdw/reservas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidreservacodigointernonumero_venda
Reservas Flags
Reservas Flags
reservas_flags.Endpoint:/cvdw/reservas/registros/flags
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidreservadata_criacao_reservaempreendimento
Pre Cadastros
Pre Cadastros
pre_cadastros.Endpoint:/cvdw/precadastros
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidprecadastrocodigointernoidsituacao
Leads Visitas
Leads Visitas
leads_visitas.Endpoint:/cvdw/leads/visitas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidtarefadata_caddata
Corretores
Corretores
corretores.Endpoint:/cvdw/corretores
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoativo_loginidcorretoridimobiliaria
Imobiliarias
Imobiliarias
imobiliarias.Endpoint:/cvdw/imobiliarias
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoativo_painelidimobiliariadata_cad
Pessoas
Pessoas
pessoas.Endpoint:/cvdw/pessoas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidpessoaidpessoa_intidpessoa_legado
Empreendimentos
Empreendimentos
empreendimentos.Endpoint:/cadastros/empreendimentos
- Full table (no replication key configured)
- Primary key(s):
idempreendimento
idempreendimentoidempreendimento_intreferencia_externanomeregiaocidade
Campanhas Ativacao
Campanhas Ativacao
campanhas_ativacao.Endpoint:/cvdw/campanhas_ativacao
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidcampanha_leadidcampanhacampanha_nome
Unidades
Unidades
unidades.Endpoint:/cvdw/unidades
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataidempreendimentoidempreendimento_intnome_empreendimentoidtipo_empreendimento
Distratos
Distratos
distratos.Endpoint:/cvdw/distratos
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidreservaaprovadadata_cad
Leads Interacoes
Leads Interacoes
leads_interacoes.Endpoint:/cvdw/leads/interacoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidinteracaoidleaddata_cad
Leads Tarefas
Leads Tarefas
leads_tarefas.Endpoint:/cvdw/leads/tarefas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidtarefadata_caddata
Leads Historico Situacoes
Leads Historico Situacoes
leads_historico_situacoes.Endpoint:/cvdw/leads/historico/situacoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidhistoricoidleaddata_cad
Comissoes
Comissoes
comissoes.Endpoint:/cvdw/comissoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidcomissaosituacaoidsituacao
Atendimentos
Atendimentos
atendimentos.Endpoint:/cvdw/atendimentos
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidatendimentoprotocolodata_cad
Assistencias
Assistencias
assistencias.Endpoint:/cvdw/assistencias
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidassistenciaidclientedocumento_cliente
Leads Conversoes
Leads Conversoes
leads_conversoes.Endpoint:/cvdw/leads/conversoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidlead_conversaoidleadnome
Repasses
Repasses
repasses.Endpoint:/cvdw/repasses
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_datadata_cadultima_atualizacaodata_modificacao_situacaoidreserva
Leads Workflow Tempo
Leads Workflow Tempo
leads_workflow_tempo.Endpoint:/cvdw/leads/workflow/tempo
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidtempoidleadidsituacao
Reservas Condicoes
Reservas Condicoes
reservas_condicoes.Endpoint:/cvdw/reservas/condicoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidreservascondicoesidreservaserie
Reservas Contratos
Reservas Contratos
reservas_contratos.Endpoint:/cvdw/reservas/contratos
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidreservacontratoidreservadata_cad
Reservas Sienge
Reservas Sienge
reservas_sienge.Endpoint:/cvdw/reservas/sienge
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativodata_cadidsienge_reservaidreserva
Leads Corretores
Leads Corretores
leads_corretores.Endpoint:/cvdw/leads/corretores
- Incremental replication key:
referencia_data - Primary key(s):
idlead, idcorretor, data_cad
referenciareferencia_dataativoidleaddata_cadidcorretor
Unidades Situacao
Unidades Situacao
unidades_situacao.Endpoint:/cvdw/unidades/situacao
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataidempreendimentoidempreendimento_intnome_empreendimentoidtipo_empreendimento
Pre Cadastros Historico Situacoes
Pre Cadastros Historico Situacoes
pre_cadastros_historico_situacoes.Endpoint:/cvdw/precadastro/historico/situacoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidhistoricoidprecadastrodata_cad
Distribuicao Leads
Distribuicao Leads
distribuicao_leads.Endpoint:/cvdw/distribuicao/leads
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoid_logrecebido_emid_fila
Empreendimentos Cvbot
Empreendimentos Cvbot
empreendimentos_cvbot.Endpoint:/cvbot/empreendimentos
- Full table (no replication key configured)
- Primary key(s):
idempreendimento
idempreendimentonomeenderecocidadeestadodata_entrega
Empreendimentos Unidades Cvbot
Empreendimentos Unidades Cvbot
empreendimentos_unidades_cvbot.Endpoint:/cvbot/empreendimentos/{idempreendimento}/unidades
- Full table (no replication key configured)
- Primary key(s):
idunidade
idunidadenomearea_privativavagas_garagemandararea_comum
Pessoas Profissional
Pessoas Profissional
pessoas_profissional.Endpoint:/cvdw/pessoas/profissional
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidpessoaidpessoa_inttrabalho_nome_empresa
Tipologias Unidades
Tipologias Unidades
tipologias_unidades.Endpoint:/configuracoes/tipologias-unidades
- Full table (no replication key configured)
- Primary key(s):
idtipologia
idtipologianomeativo_paineldata_cad
Reservas Associados
Reservas Associados
reservas_associados.Endpoint:/cvdw/reservas/associados
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidassociadoidreservaidpessoa
Usuarios Administrativos
Usuarios Administrativos
usuarios_administrativos.Endpoint:/cvdw/usuarios_administrativos
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidusuarioativo_paineltipo_login
Pesquisas
Pesquisas
pesquisas.Endpoint:/cvdw/pesquisas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidpesquisadata_iniciodata_fim
Pesquisas Perguntas
Pesquisas Perguntas
pesquisas_perguntas.Endpoint:/cvdw/pesquisas/perguntas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidpesquisa_perguntaidperguntanome_pergunta
Pesquisas Respostas
Pesquisas Respostas
pesquisas_respostas.Endpoint:/cvdw/pesquisas/respostas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativodata_respostaidpesquisaidpergunta
Assistencias Itens
Assistencias Itens
assistencias_itens.Endpoint:/cvdw/assistencias/itens
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidassistencia_itemidassistenciaitem
Assistencias Workflow Tempo
Assistencias Workflow Tempo
assistencias_workflow_tempo.Endpoint:/cvdw/assistencias/workflow/tempo
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidtempoidassistenciaidsituacao
Assistencias Itens Workflow Tempo
Assistencias Itens Workflow Tempo
assistencias_itens_workflow_tempo.Endpoint:/cvdw/assistencias/itens/workflow/tempo
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidtempoidassistenciaidsituacao
Assistencias Visitas Workflow Tempo
Assistencias Visitas Workflow Tempo
assistencias_visitas_workflow_tempo.Endpoint:/cvdw/assistencias/visitas/workflow/tempo
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidtempoidvisitaidsituacao
Atendimentos Respostas
Atendimentos Respostas
atendimentos_respostas.Endpoint:/cvdw/atendimentos/respostas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidrespostaidatendimentoidusuario
Atendimentos Workflow Tempo
Atendimentos Workflow Tempo
atendimentos_workflow_tempo.Endpoint:/cvdw/atendimentos/workflow/tempo
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidtempoidatendimentoidsituacao
Atendimentos Interacoes
Atendimentos Interacoes
atendimentos_interacoes.Endpoint:/cvdw/atendimentos/interacoes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidinteracaoidatendimentoidusuario
Unidades Precos
Unidades Precos
unidades_precos.Endpoint:/cvdw/unidades/precos
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidunidadeunidadevalor_avaliacao
Atendimentos Times
Atendimentos Times
atendimentos_times.Endpoint:/cvdw/atendimentos/times
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidtimeidgestorgestor
Atendimentos Times Integrantes
Atendimentos Times Integrantes
atendimentos_times_integrantes.Endpoint:/cvdw/atendimentos/times/integrantes
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidintegranteidtimetime
Atendimentos Tarefas
Atendimentos Tarefas
atendimentos_tarefas.Endpoint:/cvdw/atendimentos/tarefas
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidatendimentoprotocolodata_cad
Reservas Workflow Tempo
Reservas Workflow Tempo
reservas_workflow_tempo.Endpoint:/cvdw/reservas/workflow/tempo
- Incremental replication key:
referencia_data - Primary key(s):
referencia
referenciareferencia_dataativoidtempoidreservaidsituacaosituacaosiglatempodata_cad