Guia Completo da APIde Dados de Rastreamento

Aprenda como extrair insights poderosos dos seus dados de rastreamento usando nossa API avançada

O que são Dados de Rastreamento?
Entenda quais dados você pode coletar

Visualizações de Página

Acompanhe interações dos visitantes com suas páginas

Eventos do Usuário

Monitore cliques, envio de formulários e eventos customizados

Conversões

Meça compras, leads e conclusões de objetivos

Atribuição

Entenda fontes de tráfego e performance de campanhas

Estrutura Básica da Requisição
A base de toda chamada da API

Endpoint da API

Faça suas requisições POST para:

https://api.metrito.com.br/v3/data-provider/query

Estrutura do JSON:

json
{
    "project_id": "ID_DO_SEU_PROJETO",
    "source_key": "tracking",
    "fields": ["CAMPOS_QUE_VOCE_QUER"],
    "interval_start": "DATA_INICIO",
    "interval_end": "DATA_FIM",
    "time_dimension": "event_time"
}
📋 Headers Necessários
Content-Type: application/json
Authorization: Bearer SEU_TOKEN
✅ Método HTTP
POST

Todas as consultas devem usar o método POST

📊 Métricas (Measures)
Valores numéricos e contadores que você pode consultar

O que são Métricas?

Métricas são valores numéricos calculados baseados nos seus dados de rastreamento. Elas representam contagens, somas ou médias de eventos específicos que ocorreram no seu site.

Métricas Gerais

event_countTotal de eventos registrados
unique_event_countEventos únicos (baseado no ID do lead)

Métricas de Página

unique_pageviewsVisualizações de página únicas (baseado no ID do lead)
pageviewsTotal de eventos de visualização de página

Métricas de Eventos Específicos

content_views
Conteúdo
Eventos ViewContent
initiate_checkout
Checkout
Eventos InitiateCheckout
add_to_cart
Carrinho
Eventos AddToCart
purchase
Compra
Eventos Purchase
lead
Lead
Eventos de captura de leads
custom_events
Custom
Todos os eventos customizados
🏷️ Dimensões
Atributos e propriedades para segmentar seus dados

O que são Dimensões?

Dimensões são atributos descritivos dos seus dados que permitem segmentar e filtrar informações. Elas fornecem contexto sobre quando, onde e como os eventos ocorreram.

Informações do Evento

id
event_id
event_name
event_time
created
domain
url
referrer

Parâmetros UTM

utm_campaign
utm_medium
utm_content
utm_term

Cookies de Rastreamento

ga_cookie
fbp_cookie
gcl_au_cookie

Metadados da Página

meta_page_title
meta_page_favicon
meta_page_language
meta_page_description
meta_source
meta_request_headers
meta_geolocation
Exemplos Práticos

Casos de Uso Reais

Veja exemplos práticos de como usar a API para extrair insights valiosos dos seus dados

Exemplo 1: Análise Completa de Visualizações
Obtenha dados abrangentes de page views com títulos e domínios
json
{
    "project_id": "SEU_PROJECT_ID",
    "source_key": "tracking",
    "fields": [
        "unique_pageviews",
        "pageviews",
        "url",
        "meta_page_title",
        "domain"
    ],
    "interval_start": "2025-01-01",
    "interval_end": "2025-01-31",
    "time_dimension": "event_time"
}

O que você vai obter:

Contagem de visualizações e visualizações únicas
URL e título de cada página
Domínio onde os eventos ocorreram
Dados agrupados por página no período especificado
Exemplo 2: Análise de Origem de Tráfego
Analise o tráfego por origem com parâmetros UTM completos
json
{
    "project_id": "SEU_PROJECT_ID",
    "source_key": "tracking",
    "fields": [
        "event_count",
        "unique_event_count",
        "utm_campaign",
        "utm_medium",
        "utm_content",
        "utm_term",
        "referrer"
    ],
    "interval_start": "2025-01-01",
    "interval_end": "2025-01-31",
    "time_dimension": "event_time"
}

Perfeito para:

Avaliação de performance de campanhas
Atribuição de fonte de tráfego
Análise de ROI de marketing
Comparação de efetividade de canais
Exemplo 3: Funil de Conversão Completo
Acompanhe cada etapa da jornada do seu cliente
json
{
    "project_id": "SEU_PROJECT_ID",
    "source_key": "tracking",
    "fields": [
        "content_views",
        "add_to_cart",
        "initiate_checkout",
        "purchase",
        "lead",
        "event_name",
        "url"
    ],
    "interval_start": "2025-01-01",
    "interval_end": "2025-01-31",
    "time_dimension": "event_time"
}

Insights que você pode extrair:

Taxa de conversão entre cada etapa do funil
Identificação de pontos de abandono
Páginas de produto mais efetivas
Oportunidades de otimização da jornada do cliente
Filtros Avançados
Refine suas consultas com operadores poderosos

Operadores Disponíveis

OperadorDescriçãoExemplo de Uso
EQUALExatamente igualFiltrar evento específico
NOT_EQUALDiferente deExcluir eventos específicos
CONTAINSContém textoURLs que contêm "/blog/"
NOT_CONTAINSNão contémURLs sem "/admin/"
STARTS_WITHComeça comURLs que começam com "https://"
ENDS_WITHTermina comURLs que terminam com ".html"
INEm uma listaMúltiplos valores
NOT_INNão está na listaExcluir múltiplos valores

Exemplo de Filtro: Análise de Eventos Específicos

json
{
    "project_id": "SEU_PROJECT_ID",
    "source_key": "tracking",
    "fields": [
        "event_count",
        "event_name",
        "url",
        "meta_page_title",
        "utm_campaign"
    ],
    "filters": [
        {
            "field": "event_name",
            "operator": "IN",
            "value": ["Purchase", "Lead", "AddToCart"]
        },
        {
            "field": "utm_campaign",
            "operator": "NOT_EQUAL",
            "value": [null]
        }
    ],
    "interval_start": "2025-01-01",
    "interval_end": "2025-01-31",
    "time_dimension": "event_time"
}
Casos de Uso

Implementações Avançadas

Exemplos de implementações mais complexas para casos específicos

Dashboard de Performance
Obtenha todas as métricas principais em uma única requisição
json
{
    "project_id": "SEU_PROJECT_ID",
    "source_key": "tracking",
    "fields": [
        "event_count",
        "unique_event_count",
        "unique_pageviews",
        "pageviews",
        "content_views",
        "add_to_cart",
        "purchase",
        "lead"
    ],
    "interval_start": "2025-01-01",
    "interval_end": "2025-01-31",
    "time_dimension": "event_time"
}
Análise de Atribuição
Entenda quais campanhas geram conversões
json
{
    "project_id": "SEU_PROJECT_ID",
    "source_key": "tracking",
    "fields": [
        "purchase",
        "lead",
        "add_to_cart",
        "utm_campaign",
        "utm_medium",
        "utm_content",
        "utm_term"
    ],
    "filters": [{
        "field": "utm_campaign",
        "operator": "NOT_EQUAL",
        "value": [null]
    }],
    "interval_start": "2025-01-01",
    "interval_end": "2025-01-31",
    "time_dimension": "event_time"
}
Dicas Importantes e Limitações
Informações essenciais para usar a API corretamente

📋Campos Disponíveis

Apenas campos com available: true podem ser usados
Campos internos como tracking_container_id não são acessíveis
Consulte a documentação da API para a lista mais recente

🔢Diferenças entre Métricas

unique_pageviews: Conta eventos PageView
pageviews: Conta visualizações únicas por lead
event_count: Total de todos os eventos
unique_event_count: Eventos únicos por lead

Otimização de Performance

Períodos muito longos podem causar timeouts
Muitos campos podem aumentar o tempo de resposta
Considere paginação para grandes volumes de dados
Use filtros para reduzir o processamento

📅Formatação de Dados

Sempre use formato ISO de data: YYYY-MM-DD
time_dimension deve sempre ser "event_time"
Considere fusos horários ao interpretar resultados
Valores nulos podem aparecer para campos opcionais
Exemplo Completo de Implementação
Código JavaScript completo para começar imediatamente
javascript
async function obterDadosTrackingCompleto() {
    const apiUrl = 'https://api.metrito.com.br/v3/data-provider/query';
    
    const requisicao = {
        project_id: "SEU_PROJECT_ID",
        source_key: "tracking",
        fields: [
            "event_count",
            "unique_event_count",
            "unique_pageviews",
            "purchase",
            "lead",
            "url",
            "meta_page_title",
            "utm_campaign",
            "utm_medium",
            "event_name"
        ],
        filters: [
            {
                field: "event_name",
                operator: "IN",
                value: ["PageView", "Purchase", "Lead"]
            }
        ],
        interval_start: "2025-01-01",
        interval_end: "2025-01-31",
        time_dimension: "event_time"
    };

    try {
        const response = await fetch(apiUrl, {
            method: 'POST',
            headers: {
                'Content-Type': 'application/json',
                'Authorization': 'Bearer SEU_TOKEN_AQUI'
            },
            body: JSON.stringify(requisicao)
        });

        if (!response.ok) {
            throw new Error(`Erro HTTP: ${response.status}`);
        }

        const dados = await response.json();
        console.log('✅ Dados de tracking obtidos com sucesso:', dados);
        
        // Processar dados por tipo de evento
        const dadosAgrupados = dados.reduce((acc, item) => {
            const evento = item.event_name;
            if (!acc[evento]) {
                acc[evento] = [];
            }
            acc[evento].push(item);
            return acc;
        }, {});

        // Exibir resultados organizados
        Object.keys(dadosAgrupados).forEach(evento => {
            console.log(`\n📊 === ${evento} ===`);
            dadosAgrupados[evento].forEach(item => {
                console.log(`🔗 URL: ${item.url}`);
                console.log(`📄 Título: ${item.meta_page_title}`);
                console.log(`📈 Eventos: ${item.event_count}`);
                console.log(`🎯 Campanha: ${item.utm_campaign || 'N/A'}`);
                console.log('---');
            });
        });
        
        return dados;
        
    } catch (erro) {
        console.error('❌ Erro ao buscar dados:', erro);
        throw erro;
    }
}

// Executar a função
obterDadosTrackingCompleto()
    .then(dados => {
        console.log('🎉 Processo finalizado! Total de registros:', dados.length);
    })
    .catch(erro => {
        console.error('💥 Falha na execução:', erro.message);
    });

Como usar este código:

Substitua 'SEU_PROJECT_ID' pelo ID real do seu projeto
Substitua 'SEU_TOKEN_AQUI' pelo seu token de API válido
Ajuste as datas conforme o período que você quer analisar
Modifique os campos e filtros conforme sua necessidade
Pronto para Extrair Insights Poderosos!
Você agora tem todo o conhecimento necessário

✅ O que você aprendeu

Lista completa de métricas disponíveis
Todas as dimensões consultáveis
Parâmetros UTM e cookies de rastreamento
Metadados de página e geolocalização
Filtros avançados e operadores
Exemplos de implementação real