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âmetroTipoObrigatórioDescrição
eventstringNãoKind of event. The default is clicks.Valores: clicks, leads, sales
intervalstringNãoPeriod 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
startstringNãoStart of the period. Takes precedence over interval.
endstringNãoEnd of the period. Defaults to now.
timezonestringNãoIANA time zone, such as America/Sao_Paulo. The default is UTC.
domainstringNãoDomain to filter by, such as dub.sh. With key, a single short link.
keystringNãoSlug of a short link. Goes with domain.
linkIdstringNãoId of a link, from List links.
tagIdstringNãoId of a tag, from List tags.
folderIdstringNãoId of a folder, from List folders.
pageintegerNãoPage number, starting at 1.
limitintegerNãoEvents per page, up to 1000. The default is 100.
sortOrderstringNãoOrder 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.

Veja o Connect aplicado ao seu produto.

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