Obtener analíticas en Dub, con una API

Devuelve clics, leads o ventas del workspace, de un dominio, enlace, etiqueta o carpeta, como total, serie temporal o ranking elegido por groupBy.

Identificador
dub_get_analytics

La llamada

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"
  }
}

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
eventstringNoWhat to count. composite returns clicks, leads and sales together. The default is clicks.Valores: clicks, leads, sales, composite
groupBystringNocount 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
intervalstringNoPeriod 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
startstringNoStart of the period. Takes precedence over interval.
endstringNoEnd of the period. Defaults to now.
timezonestringNoIANA time zone of the time series, such as America/Sao_Paulo. The default is UTC.
domainstringNoDomain 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.
keystringNoSlug of a short link. Goes with domain.
linkIdstringNoId of a link, from List links. Several values go separated by commas, and a minus sign before a value excludes it.
tagIdstringNoId of a tag, from List tags. Several values go separated by commas, and a minus sign before a value excludes it.
folderIdstringNoId of a folder, from List folders. Several values go separated by commas, and a minus sign before a value excludes it.
countrystringNoTwo-letter ISO 3166-1 country code, such as BR. Several values go separated by commas, and a minus sign before a value excludes it.
devicestringNoDevice type, such as Desktop, Mobile or Tablet.
refererstringNoHostname of the referrer, such as google.com.
utm_sourcestringNoUTM source to filter by.
utm_mediumstringNoUTM medium to filter by.
utm_campaignstringNoUTM campaign to filter by.

Conexiones posibles

Tu cliente conecta su cuenta de Dub una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

OAuth con la app de tu producto

Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/dub, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/dub_get_analytics. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Dub

Ver las 10 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.