Obter volume de eventos no Segment, por uma API

Retorna quantos eventos o workspace recebeu por intervalo em um período, opcionalmente agrupados e filtrados por fonte, nome do evento e tipo de evento.

Identificador
segment_get_events_volume

A chamada

POST https://connect.reportei.com/api/tools/segment_get_events_volume/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "granularity": "DAY",
    "startTime": "<startTime>",
    "endTime": "<endTime>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
granularitystringSimSize of each bucket.Valores: DAY, HOUR, MINUTE
startTimestringSimStart of the period, inclusive, as ISO 8601, for example 2026-10-01T00:00:00Z.
endTimestringSimEnd of the period, exclusive, as ISO 8601. Segment recommends staying 1 minute behind the clock.
groupByarrayNãoDimensions to group the counts by.
sourceIdarrayNãoOnly these sources, by id, from List sources.
eventNamearrayNãoOnly these event names.
eventTypearrayNãoOnly these event types, such as track, identify or page.

Conexões possíveis

O seu cliente conecta a conta do Segment uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/segment_get_events_volume. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Segment

Ver as 11 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

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