Obtenir les analytics avec l'API Dub
Renvoie clics, leads ou ventes du workspace, d'un domaine, lien, tag ou dossier, en total, série temporelle ou classement choisi par groupBy.
- Identifiant
- dub_get_analytics
L'appel
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"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| event | string | Non | What to count. composite returns clicks, leads and sales together. The default is clicks.Valeurs : clicks, leads, sales, composite |
| groupBy | string | Non | count returns the total, timeseries the values over time, and the others a ranking. The default is count.Valeurs : 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 |
| interval | string | Non | Period ending now: mtd, qtd and ytd start at the beginning of the month, quarter or year. Ignored when start is sent.Valeurs : 24h, 7d, 30d, 90d, 1y, mtd, qtd, ytd, all |
| start | string | Non | Start of the period. Takes precedence over interval. |
| end | string | Non | End of the period. Defaults to now. |
| timezone | string | Non | IANA time zone of the time series, such as America/Sao_Paulo. The default is UTC. |
| domain | string | Non | Domain 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. |
| key | string | Non | Slug of a short link. Goes with domain. |
| linkId | string | Non | Id of a link, from List links. Several values go separated by commas, and a minus sign before a value excludes it. |
| tagId | string | Non | Id of a tag, from List tags. Several values go separated by commas, and a minus sign before a value excludes it. |
| folderId | string | Non | Id of a folder, from List folders. Several values go separated by commas, and a minus sign before a value excludes it. |
| country | string | Non | Two-letter ISO 3166-1 country code, such as BR. Several values go separated by commas, and a minus sign before a value excludes it. |
| device | string | Non | Device type, such as Desktop, Mobile or Tablet. |
| referer | string | Non | Hostname of the referrer, such as google.com. |
| utm_source | string | Non | UTM source to filter by. |
| utm_medium | string | Non | UTM medium to filter by. |
| utm_campaign | string | Non | UTM campaign to filter by. |
Connexions possibles
Votre client connecte son compte Dub une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
OAuth avec l'app de votre produit
Vous enregistrez une fois l'app OAuth de votre produit, avec POST /api/merchants/credentials/dub, et votre client autorise le compte sur un écran de consentement. Connect renouvelle le token avant son expiration.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/dub_get_analytics. Il devient la définition de tool de votre agent sans conversion.
Autres tools Dub
- Lister les liensGETListe les liens courts du workspace avec destination, tags, dossier, paramètres UTM et les nombres de clics, leads et ventes. Pour la page suivante, envoyez l'id du dernier lien.
- Obtenir un lienGETRenvoie un lien court avec les nombres de clics, leads et ventes. Envoyez domain et key ensemble, comme dub.sh et abc123 pour dub.sh/abc123, ou envoyez linkId.
- Créer un lienPOSTRaccourcit une URL et renvoie le lien court dans shortLink, avec son id. Sans domain il utilise le domaine principal du workspace, ou dub.sh s'il n'y en a pas.
- Mettre à jour un lienPATCHModifie un lien court ; seuls les champs envoyés changent. Un nouveau domain ou key change le lien court lui-même, et archived à true masque le lien de Lister les liens.
- Lister les événementsGETListe les événements de clic, lead ou vente un par un, avec l'heure, le lien et les détails du clic et, pour les leads et ventes, le client. Exige le plan Business ou supérieur.
- Lister les domainesGETListe les domaines personnalisés du workspace, dont le slug va dans l'argument domain des tools de lien. Les pages commencent à 1, et une page plus courte que pageSize est la dernière.
- Lister les tagsGETListe les tags du workspace avec leurs ids et couleurs. Les pages commencent à 1, et une page plus courte que pageSize est la dernière.
- Créer un tagPOSTCrée un tag pour organiser les liens, comme une campagne ou un client. La réponse contient l'id qui va dans tagIds.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
