Get Bitlink clicks summary with the Bitly API

Returns the total clicks of a Bitlink in a window, in total_clicks. unit and units set the window: unit day with units 30 is the 30 days up to unit_reference.

Identifier
bitly_get_bitlink_clicks_summary

The request

POST https://connect.reportei.com/api/tools/bitly_get_bitlink_clicks_summary/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "bitlink": "<bitlink>",
    "unit": "minute",
    "units": 1
  }
}

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
bitlinkstringYesThe id of the link, from List Bitlinks or Create Bitlink: the domain and the back-half without https://, like bit.ly/3AbCdEf.
unitstringYesUnit of time of the window.Values: minute, hour, day, week, month
unitsintegerYesHow many units the window has, counting back from unit_reference. -1 is the whole history.
unit_referencestringNoISO-8601 time the window ends at, like 2026-10-01T00:00:00+0000, sent as plain text. The default is now.

Supported connections

Your customer connects their Bitly account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/bitly, 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/bitly_get_bitlink_clicks_summary. It becomes your agent's tool definition with no conversion.

Other Bitly tools

See all 11 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.