Listar eventos no Dub, por uma API
Lista eventos de clique, lead ou venda um a um, com horário, link e detalhes do clique e, para leads e vendas, o cliente. Exige o plano Business ou superior.
- Identificador
- dub_list_events
A chamada
POST https://connect.reportei.com/api/tools/dub_list_events/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"event": "clicks"
}
}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 |
|---|---|---|---|
| event | string | Não | Kind of event. The default is clicks.Valores: clicks, leads, sales |
| interval | string | Não | Period ending now: mtd, qtd and ytd start at the beginning of the month, quarter or year. Ignored when start is sent.Valores: 24h, 7d, 30d, 90d, 1y, mtd, qtd, ytd, all |
| start | string | Não | Start of the period. Takes precedence over interval. |
| end | string | Não | End of the period. Defaults to now. |
| timezone | string | Não | IANA time zone, such as America/Sao_Paulo. The default is UTC. |
| domain | string | Não | Domain to filter by, such as dub.sh. With key, a single short link. |
| key | string | Não | Slug of a short link. Goes with domain. |
| linkId | string | Não | Id of a link, from List links. |
| tagId | string | Não | Id of a tag, from List tags. |
| folderId | string | Não | Id of a folder, from List folders. |
| page | integer | Não | Page number, starting at 1. |
| limit | integer | Não | Events per page, up to 1000. The default is 100. |
| sortOrder | string | Não | Order by time. The default is desc, newest first.Valores: asc, desc |
Conexões possíveis
O seu cliente conecta a conta do Dub uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
OAuth com o app do seu produto
Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/dub, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.
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/dub_list_events. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Dub
- Listar linksGETLista os links curtos do workspace com destino, tags, pasta, parâmetros UTM e as contagens de cliques, leads e vendas. Para a próxima página, envie o id do último link.
- Obter linkGETDevolve um link curto com as contagens de cliques, leads e vendas. Envie domain e key juntos, como dub.sh e abc123 para dub.sh/abc123, ou envie linkId.
- Criar linkPOSTEncurta uma URL e devolve o link curto em shortLink, com seu id. Sem domain usa o domínio principal do workspace, ou dub.sh se não houver.
- Atualizar linkPATCHAltera um link curto; só os campos enviados mudam. Um novo domain ou key muda o próprio link curto, e archived true oculta o link de Listar links.
- Obter analyticsGETDevolve cliques, leads ou vendas do workspace, de um domínio, link, tag ou pasta, como total, série temporal ou ranking escolhido por groupBy.
- Listar domíniosGETLista os domínios personalizados do workspace, cujo slug vai no argumento domain das tools de link. As páginas começam em 1, e uma página menor que pageSize é a última.
- Listar tagsGETLista as tags do workspace com seus ids e cores. As páginas começam em 1, e uma página menor que pageSize é a última.
- Criar tagPOSTCria uma tag para organizar links, como uma campanha ou um cliente. A resposta traz o id que vai em tagIds.
Veja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
