List events with the Dub API

Lists 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.

Identifier
dub_list_events

The request

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

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
eventstringNoKind of event. The default is clicks.Values: clicks, leads, sales
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, such as America/Sao_Paulo. The default is UTC.
domainstringNoDomain to filter by, such as dub.sh. With key, a single short link.
keystringNoSlug of a short link. Goes with domain.
linkIdstringNoId of a link, from List links.
tagIdstringNoId of a tag, from List tags.
folderIdstringNoId of a folder, from List folders.
pageintegerNoPage number, starting at 1.
limitintegerNoEvents per page, up to 1000. The default is 100.
sortOrderstringNoOrder by time. The default is desc, newest first.Values: asc, desc

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_list_events. 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.