Bitly

Bitly Bitlinks API

Create, expand, update, archive and delete Bitlinks, list them by group, and read per-link click, engagement, country, city, device and referrer metrics. 21 operation(s), extracted verbatim from the OpenAPI Bitly publishes at https://dev.bitly.com/v4/v4.json.

GitHub OpenAPI

Operations 21

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /bitlinks/{bitlink}/engagements Get a Bitlink's engagements over time · Get Engagement Counts for a Bitlink #
Ask an LLM
“Can I see clicks, QR scans and button clicks for a link broken out per day?”
“What does engagement over time look like for one link, including scans?”
Tell an agent
Show engagement counts per {unit} for {bitlink} over the last {units} periods.
Chart clicks, scans and button clicks for {bitlink} by {unit}.
GET /bitlinks/{bitlink}/engagements/summary Get a Bitlink's total engagements · Get an Engagement Count Summary for a Bitlink #
Ask an LLM
“What is the combined total of clicks and scans on one link?”
“Can I get a single engagement number for a link over a period?”
Tell an agent
Give me the total engagements for {bitlink} over the last {units} {unit}s.
Sum all clicks and scans on {bitlink} into one engagement total by {unit}.
GET /bitlinks/{bitlink}/countries Get a Bitlink's clicks by country · Get Metrics for a Bitlink by Country #
Ask an LLM
“Which countries are the clicks on my short link coming from?”
“Can I see the top countries clicking a specific link?”
Tell an agent
Break down clicks on {bitlink} by country over the last {units} {unit}s.
Show the top {size} countries clicking {bitlink} by {unit}.
GET /bitlinks/{bitlink}/cities Get a Bitlink's clicks by city · Get Metrics for a Bitlink by City #
Ask an LLM
“What cities are people clicking my link from?”
“Can I find the top cities for traffic on one short link?”
Tell an agent
Break down clicks on {bitlink} by city over the last {units} {unit}s.
List the top {size} cities clicking {bitlink} by {unit}.
GET /bitlinks/{bitlink}/devices Get a Bitlink's clicks by device type · Get Metrics for a Bitlink by Device Type #
Ask an LLM
“Are people clicking my link mostly on mobile or desktop?”
“Which device types generate the clicks on a specific Bitlink?”
Tell an agent
Break down clicks on {bitlink} by device type over the last {units} {unit}s.
Show mobile versus desktop clicks for {bitlink} by {unit}.
GET /bitlinks/{bitlink}/referrers Get a Bitlink's clicks by referrer · Get Metrics for a Bitlink by Referrers #
Ask an LLM
“Which referring sources are sending clicks to my link?”
“Can I see referrer click counts for one short link?”
Tell an agent
Break down clicks on {bitlink} by referrer over the last {units} {unit}s.
List the top {size} referrers for {bitlink} by {unit}.
GET /bitlinks/{bitlink}/referrer_name Get a Bitlink's clicks by referrer name · Get Metrics for a Bitlink by Referrer Name #
Ask an LLM
“Can I see my link's referrer clicks grouped by the referrer's name, like a named app or site?”
“What named referrers are driving clicks to a Bitlink?”
Tell an agent
Group clicks on {bitlink} by referrer name over the last {units} {unit}s.
Show the top {size} referrer names for {bitlink} by {unit}.
GET /bitlinks/{bitlink}/referring_domains Get a Bitlink's clicks by referring domain · Get Metrics for a Bitlink by Referring Domains #
Ask an LLM
“Which websites (domains) are linking visitors to my short link?”
“Can I rank referring domains for one Bitlink by click count?”
Tell an agent
Break down clicks on {bitlink} by referring domain over the last {units} {unit}s.
List the top {size} referring domains for {bitlink} by {unit}.
GET /bitlinks/{bitlink}/referrers_by_domains Get a Bitlink's referrers grouped by domain · Get Metrics for a Bitlink by Referrers by Domain #
Ask an LLM
“Can I see the individual referrers for my link nested under each referring domain?”
“What pages within each referring domain are sending clicks to a link?”
Tell an agent
Show referrers for {bitlink} grouped under their domains over the last {units} {unit}s.
Group the referrer URLs clicking {bitlink} by domain, per {unit}.
GET /groups/{group_guid}/bitlinks List and search a group's Bitlinks · Retrieve Bitlinks by Group #
Ask an LLM
“How do I list all the short links in one of my groups?”
“Can I search my links by tag, campaign or creation date?”
Tell an agent
List the Bitlinks in group {group_guid}.
Search group {group_guid} for links matching {query}.
PATCH /groups/{group_guid}/bitlinks Bulk archive or retag up to 100 Bitlinks · Bulk update bitlinks #
Ask an LLM
“Can I archive a batch of short links at once instead of one by one?”
“How do I add or remove a tag across many links in a group?”
Tell an agent
Archive these links in group {group_guid}: {links}.
In group {group_guid}, add tags {add_tags} to links {links}.
GET /groups/{group_guid}/engagements/sorted/top Rank a group's links and standalone QR codes by engagement · Retrieve Top Links and Decoupled QR Codes by Engagements #
Ask an LLM
“Which links and standalone QR codes in my group got the most engagement, ranked together?”
“Can I compare decoupled QR codes and Bitlinks in a single top-performers list?”
Tell an agent
Rank the top {size} links and decoupled QR codes in group {group_guid} by engagement.
Show group {group_guid}'s combined link and standalone QR code leaderboard for the last {units} {unit}s.

Documentation

📖
Documentation
https://dev.bitly.com/api-reference
📖
APIReference
https://dev.bitly.com/api-reference
📖
GettingStarted
https://dev.bitly.com/docs/getting-started/introduction

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/openapi/bitly-bitlinks-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/collections/bitly-bitlinks-api.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/collections/bitly-bitlinks-api.opencollection.json
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/overlays/bitly-bitlinks-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/bitly:bitly-bitlinks-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

bitly-bitlinks-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 4.0.0
  title: Bitly Bitlinks API
  termsOfService: https://bitly.com/pages/terms-of-service
  contact:
    url: https://bitly.is/API-support
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  x-logo:
    url: /v4/header-logo.png
  description: 'Bitlinks are shortened links. They could begin with the bit.ly domain or your own custom branded short domain (BSD).


    **Related Operations:**

    - POST /bitlinks - Create a new bitlink or add a custom keyword to an existing bitlink

    - PATCH /bitlinks/{bitlink} - Redirect an existing bitlink'
servers:
- url: https://api-ssl.bitly.com/v4
security:
- bearerAuth: []
tags:


# --- truncated at 32 KB (72 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/openapi/bitly-bitlinks-api-openapi.yml