Obter analytics no Dub, por uma API

Devolve cliques, leads ou vendas do workspace, de um domínio, link, tag ou pasta, como total, série temporal ou ranking escolhido por groupBy.

Identificador
dub_get_analytics

A chamada

POST https://connect.reportei.com/api/tools/dub_get_analytics/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ãoWhat to count. composite returns clicks, leads and sales together. The default is clicks.Valores: clicks, leads, sales, composite
groupBystringNãocount returns the total, timeseries the values over time, and the others a ranking. The default is count.Valores: count, timeseries, continents, regions, countries, cities, devices, browsers, os, referers, referer_urls, top_links, top_urls, top_domains, top_folders, top_link_tags, utm_sources, utm_mediums, utm_campaigns, utm_terms, utm_contents
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 of the time series, such as America/Sao_Paulo. The default is UTC.
domainstringNãoDomain to filter by, such as dub.sh. With key, a single short link. Several values go separated by commas, and a minus sign before a value excludes it.
keystringNãoSlug of a short link. Goes with domain.
linkIdstringNãoId of a link, from List links. Several values go separated by commas, and a minus sign before a value excludes it.
tagIdstringNãoId of a tag, from List tags. Several values go separated by commas, and a minus sign before a value excludes it.
folderIdstringNãoId of a folder, from List folders. Several values go separated by commas, and a minus sign before a value excludes it.
countrystringNãoTwo-letter ISO 3166-1 country code, such as BR. Several values go separated by commas, and a minus sign before a value excludes it.
devicestringNãoDevice type, such as Desktop, Mobile or Tablet.
refererstringNãoHostname of the referrer, such as google.com.
utm_sourcestringNãoUTM source to filter by.
utm_mediumstringNãoUTM medium to filter by.
utm_campaignstringNãoUTM campaign to filter by.

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_get_analytics. 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.