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

ParameterTypeRequiredDescription
eventstringNoWhat to count. composite returns clicks, leads and sales together. The default is clicks.Values: clicks, leads, sales, composite
groupBystringNocount 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
intervalstringNoPeriod 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
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.

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

See all 10 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.