Get analytics with the Dub API
Returns clicks, leads or sales of the workspace, a domain, a link, a tag or a folder, as a total, a time series or a ranking chosen by groupBy. Without start and interval it covers the last 24 hours, and it needs the Pro plan or higher.
- Identifier
- dub_get_analytics
The request
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"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| event | string | No | What to count. composite returns clicks, leads and sales together. The default is clicks.Values: clicks, leads, sales, composite |
| groupBy | string | No | count returns the total, timeseries the values over time, and the others a ranking. The default is count.Values: 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 | No | Period ending now: mtd, qtd and ytd start at the beginning of the month, quarter or year. Ignored when start is sent.Values: 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 of the time series, 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. Several values go separated by commas, and a minus sign before a value excludes it. |
| key | string | No | Slug of a short link. Goes with domain. |
| linkId | string | No | Id of a link, from List links. Several values go separated by commas, and a minus sign before a value excludes it. |
| tagId | string | No | Id of a tag, from List tags. Several values go separated by commas, and a minus sign before a value excludes it. |
| folderId | string | No | Id of a folder, from List folders. Several values go separated by commas, and a minus sign before a value excludes it. |
| country | string | No | 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 | No | Device type, such as Desktop, Mobile or Tablet. |
| referer | string | No | Hostname of the referrer, such as google.com. |
| utm_source | string | No | UTM source to filter by. |
| utm_medium | string | No | UTM medium to filter by. |
| utm_campaign | string | No | UTM campaign to filter by. |
Supported connections
Your customer connects their Dub account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/dub, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/dub_get_analytics. It becomes your agent's tool definition with no conversion.
Other Dub tools
- List linksGETLists the short links of the workspace with destination, tags, folder, UTM parameters and the counts of clicks, leads and sales. For the next page, send the id of the last link as startingAfter; a page shorter than pageSize is the last one.
- Get linkGETReturns one short link with its counts of clicks, leads and sales. Send domain and key together, such as dub.sh and abc123 for dub.sh/abc123, or send linkId.
- Create linkPOSTShortens a URL and returns the short link in shortLink, with its id. Without domain it uses the primary domain of the workspace, or dub.sh when there is none, and without key Dub picks a random 7-character slug.
- Update linkPATCHChanges a short link; only the fields sent change. A new domain or key changes the short link itself, and archived true hides the link from List links.
- List eventsGETLists click, lead or sale events one by one, with time, link and click details and, for leads and sales, the customer; it needs the Business plan or higher. Without start and interval it covers the last 24 hours, and a page shorter than limit is the last one.
- List domainsGETLists the custom domains of the workspace, whose slug goes in the domain argument of the link tools. Pages start at 1, and a page shorter than pageSize is the last one.
- List tagsGETLists the tags of the workspace with their ids and colors. Pages start at 1, and a page shorter than pageSize is the last one.
- Create tagPOSTCreates a tag to organize links, such as a campaign or a client. The response has the id that goes in tagIds.
See Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
