Obter métricas de entrega no Segment, por uma API
Retorna as métricas de entrega de um destino para os eventos de uma fonte em um período, cada métrica com seu total e detalhamento. Sem datas, cobre a última hora por minuto.
- Identificador
- segment_get_delivery_metrics
A chamada
POST https://connect.reportei.com/api/tools/segment_get_delivery_metrics/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"destinationId": "<destinationId>",
"sourceId": "<sourceId>"
}
}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âmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| destinationId | string | Sim | Id of the destination, from List destinations or List connected destinations. |
| sourceId | string | Sim | Id of the source linked to the destination: the sourceId that Get destination returns. |
| startTime | string | Não | Start of the period, for example 2026-10-01T00:00:00Z. The default is 1 hour ago with MINUTE, 7 days with HOUR and 30 days with DAY. |
| endTime | string | Não | End of the period. The default is now. |
| granularity | string | Não | Size of each bucket. The default is MINUTE.Valores: DAY, HOUR, MINUTE |
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_delivery_metrics. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Segment
- Listar fontesGETLista as fontes do workspace com id, name, slug, enabled, metadata e labels. Retorna as primeiras 200, porque a conexão não envia paginação; pagination.totalEntries diz se há mais.
- Obter fonteGETRetorna uma fonte com suas configurações, write keys, metadata e labels.
- Listar destinos conectadosGETLista os destinos que recebem dados de uma fonte, com id, name, enabled e metadata. Retorna os primeiros 200, porque a conexão não envia paginação.
- Listar warehouses conectadosGETLista os warehouses que recebem dados de uma fonte. Retorna os primeiros 200, porque a conexão não envia paginação.
- Listar destinosGETLista os destinos do workspace com id, name, enabled, metadata e o sourceId a que cada um pertence. Retorna os primeiros 200, porque a conexão não envia paginação; pagination.totalEntries diz se há mais.
- Obter destinoGETRetorna um destino com suas configurações, metadata e o sourceId a que pertence.
- Listar warehousesGETLista os warehouses do workspace com id, enabled, metadata e settings. Retorna os primeiros 200, porque a conexão não envia paginação; pagination.totalEntries diz se há mais.
- Obter warehouseGETRetorna um warehouse com suas configurações e metadata.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
