Metrics

Métricas do GoHighLevel pela API

Seu cliente conecta a conta do GoHighLevel e seu produto consulta 45 métricas pelo mesmo endpoint das outras plataformas. Cada métrica tem um identificador (reference_key) que vai na chamada.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "comparison_start": "2026-09-01",
  "comparison_end": "2026-09-30",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "ghl:total_contacts",
      "component": "number_v1",
      "metrics": [
        "total_contacts"
      ],
      "dimensions": [
        "contacts"
      ]
    }
  ]
}
Exemplo: "Total de contatos criados" em outubro, comparado a setembro.

Mais exemplos de chamadas no GoHighLevel

O mesmo endpoint para cada tipo de métrica. Os campos metrics e dimensions de cada item vêm do catálogo da plataforma (GET /api/metrics/{integration_slug}).

Gráfico

Contatos ao longo do tempo

Evolução de novos contatos durante o período.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "ghl:contacts_over_time",
      "component": "chart_v1",
      "metrics": [
        "new_contacts"
      ],
      "dimensions": [
        "date"
      ]
    }
  ]
}

Tabela

Principais oportunidades

Lista das oportunidades de maior valor no período.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "ghl:top_opportunities",
      "component": "datatable_v1",
      "metrics": [
        "value",
        "stage",
        "status",
        "created_at"
      ],
      "dimensions": [
        "opportunity_name"
      ]
    }
  ]
}

Número

Novos contatos

Número de novos contatos adicionados no período selecionado.

POST /api/metrics/get-data
Authorization: Bearer <merchant token>
x-customer-token: <customer token>

{
  "customer_integration": "<connection uuid>",
  "start": "2026-10-01",
  "end": "2026-10-31",
  "metrics": [
    {
      "id": "m1",
      "reference_key": "ghl:new_contacts",
      "component": "number_v1",
      "metrics": [
        "new_contacts"
      ],
      "dimensions": [
        "contacts"
      ]
    }
  ]
}

Números

26 métricas

  • Total de contatos criados

    Total de contatos criados até a data atual (todos os tempos).

    ghl:total_contacts
  • Novos contatos

    Número de novos contatos adicionados no período selecionado.

    ghl:new_contacts
  • Contatos com e-mail

    Quantidade de contatos que possuem endereço de e-mail cadastrado.

    ghl:contacts_with_email
  • Contatos sem e-mail

    Quantidade de contatos que não possuem endereço de e-mail cadastrado.

    ghl:contacts_without_email
  • Contatos com número de telefone

    Quantidade de contatos que possuem número de telefone cadastrado.

    ghl:contacts_with_phone
  • Contatos sem número de telefone

    Quantidade de contatos que não possuem número de telefone cadastrado.

    ghl:contacts_without_phone
  • Total de oportunidades criadas

    Total de oportunidades (negócios) criadas no período.

    ghl:total_opportunities
  • Oportunidades em aberto

    Número de oportunidades com status Em Aberto no período selecionado.

    ghl:open_opportunities
  • Valor das oportunidades em aberto

    Valor monetário total de todas as oportunidades em aberto no período selecionado.

    ghl:open_value
  • Oportunidades ganhas

    Número de oportunidades ganhas no período selecionado.

    ghl:won_opportunities
  • Oportunidades perdidas

    Número de oportunidades perdidas no período selecionado.

    ghl:lost_opportunities
  • Oportunidades abandonadas

    Número de oportunidades com status Abandonado no período selecionado.

    ghl:abandoned_opportunities
  • Valor total das oportunidades

    Valor monetário total de todas as oportunidades criadas no período selecionado.

    ghl:total_value
  • Valor das oportunidades ganhas

    Valor monetário total das oportunidades ganhas no período selecionado.

    ghl:won_value
  • Valor das oportunidades perdidas

    Valor monetário total das oportunidades perdidas no período selecionado.

    ghl:lost_value
  • Valor das oportunidades abandonadas

    Valor monetário total das oportunidades abandonadas no período selecionado.

    ghl:abandoned_value
  • Taxa de conversão

    Porcentagem de oportunidades ganhas em relação ao total de oportunidades.

    ghl:conversion_rate
  • Taxa de ganho

    Porcentagem de oportunidades ganhas em relação ao total de oportunidades fechadas (ganhas + perdidas). Taxa de ganho = Ganhas ÷ (Ganhas + Perdidas).

    ghl:win_rate
  • Ticket médio das oportunidades ganhas

    Valor monetário médio das oportunidades ganhas no período selecionado.

    ghl:average_won_value
  • Tempo médio para fechar oportunidade

    Número médio de dias desde a criação da oportunidade até o fechamento (ganha ou perdida).

    ghl:average_close_time
  • Mensagens enviadas

    Número total de mensagens (SMS/E-mail) enviadas pelo GoHighLevel no período selecionado.

    ghl:messages_sent
  • Total de conversas

    Número total de conversas ativas no período selecionado.

    ghl:total_conversations
  • Novas conversas no período

    Número de novas conversas iniciadas no período selecionado.

    ghl:new_conversations
  • Conversas não lidas

    Número de conversas que possuem mensagens não lidas.

    ghl:unread_conversations
  • Total de mensagens não lidas

    Contagem total de mensagens não lidas em todas as conversas.

    ghl:total_unread_messages
  • Total de conversas não atribuídas

    Número de conversas ainda não atribuídas a nenhum membro da equipe.

    ghl:unassigned_conversations

Gráficos

12 métricas

  • Contatos ao longo do tempo

    Evolução de novos contatos durante o período.

    ghl:contacts_over_time
  • Oportunidades ao longo do tempo

    Evolução do número de oportunidades criadas durante o período.

    ghl:opportunities_over_time
  • Valor ao longo do tempo

    Evolução do valor total de oportunidades durante o período.

    ghl:value_over_time
  • Conversas ao longo do tempo

    Evolução do número de conversas durante o período.

    ghl:conversations_over_time
  • Oportunidades por estágio do pipeline

    Resumo de oportunidades agrupadas por estágio do pipeline.

    ghl:opportunities_by_stage
  • Quantidade de oportunidades por status

    Número de oportunidades agrupadas por status (aberto, ganho, perdido, abandonado).

    ghl:opportunities_by_status
  • Contatos por origem

    Distribuição de contatos por origem de aquisição.

    ghl:contacts_by_source
  • Contagem de contatos por tags

    Distribuição de contatos agrupados pelas tags atribuídas.

    ghl:contacts_by_tags
  • Contagem de contatos por tipo

    Distribuição de contatos agrupados por tipo de contato.

    ghl:contacts_by_type
  • Contatos por usuário responsável

    Contatos mapeados pelos usuários aos quais estão atribuídos.

    ghl:contacts_by_assignee
  • Distribuição de conversas por canal

    Distribuição de conversas por tipo de canal (SMS, E-mail, etc.).

    ghl:conversations_by_type
  • Conversas por responsável

    Número de conversas atribuídas a cada membro da equipe.

    ghl:conversations_by_assignee

Tabelas

7 métricas

  • Principais oportunidades

    Lista das oportunidades de maior valor no período.

    ghl:top_opportunities
  • Oportunidades por estágio do pipeline

    Resumo de oportunidades agrupadas por estágio do pipeline.

    ghl:pipeline_by_stage
  • Oportunidades perdidas por motivo

    Divisão das oportunidades perdidas pelo motivo da perda.

    ghl:lost_by_reason
  • Principais origens de contatos criados

    Principais origens de criação de contatos mostrando a contagem por origem.

    ghl:contacts_by_source_table
  • Contatos por nome da empresa

    Contatos distribuídos por diferentes nomes de empresa.

    ghl:contacts_by_company
  • Contatos por usuário responsável

    Contatos distribuídos pelo membro da equipe responsável.

    ghl:contacts_by_assignee_table
  • Conversas atribuídas

    Número de conversas atribuídas a cada membro da equipe.

    ghl:conversations_by_assignee_table

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.