Listar eventos en Dub, con una API
Lista eventos de clic, lead o venta uno por uno, con hora, enlace y detalles del clic y, para leads y ventas, el cliente. Exige el plan Business o superior.
- Identificador
- dub_list_events
La llamada
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"
}
}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ámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| event | string | No | Kind of event. The default is clicks.Valores: clicks, leads, sales |
| interval | string | No | 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 | No | Start of the period. Takes precedence over interval. |
| end | string | No | End of the period. Defaults to now. |
| timezone | string | No | IANA time zone, such as America/Sao_Paulo. The default is UTC. |
| domain | string | No | Domain to filter by, such as dub.sh. With key, a single short link. |
| key | string | No | Slug of a short link. Goes with domain. |
| linkId | string | No | Id of a link, from List links. |
| tagId | string | No | Id of a tag, from List tags. |
| folderId | string | No | Id of a folder, from List folders. |
| page | integer | No | Page number, starting at 1. |
| limit | integer | No | Events per page, up to 1000. The default is 100. |
| sortOrder | string | No | Order by time. The default is desc, newest first.Valores: asc, desc |
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_list_events. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de Dub
- Listar enlacesGETLista los enlaces cortos del workspace con destino, etiquetas, carpeta, parámetros UTM y los conteos de clics, leads y ventas. Para la página siguiente, envía el id del último enlace.
- Obtener enlaceGETDevuelve un enlace corto con los conteos de clics, leads y ventas. Envía domain y key juntos, como dub.sh y abc123 para dub.sh/abc123, o envía linkId.
- Crear enlacePOSTAcorta una URL y devuelve el enlace corto en shortLink, con su id. Sin domain usa el dominio principal del workspace, o dub.sh si no hay.
- Actualizar enlacePATCHCambia un enlace corto; solo cambian los campos enviados. Un nuevo domain o key cambia el propio enlace corto, y archived en true oculta el enlace de Listar enlaces.
- Obtener analíticasGETDevuelve clics, leads o ventas del workspace, de un dominio, enlace, etiqueta o carpeta, como total, serie temporal o ranking elegido por groupBy.
- Listar dominiosGETLista los dominios personalizados del workspace, cuyo slug va en el argumento domain de las tools de enlace. Las páginas empiezan en 1, y una página menor que pageSize es la última.
- Listar etiquetasGETLista las etiquetas del workspace con sus ids y colores. Las páginas empiezan en 1, y una página menor que pageSize es la última.
- Crear etiquetaPOSTCrea una etiqueta para organizar enlaces, como una campaña o un cliente. La respuesta trae el id que va en tagIds.
Mira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
