Bitly

Bitly Groups API

Manage groups (workspaces) — preferences, tags, shorten counts, exports, feature usage and historical usage — plus the full group-level click, scan and engagement analytics surface. 28 operation(s), extracted verbatim from the OpenAPI Bitly publishes at https://dev.bitly.com/v4/v4.json.

GitHub OpenAPI

Operations 28

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 /groups List groups · Retrieve Groups #
Ask an LLM
“What groups do I have access to in Bitly?”
“Can I list only the groups inside one organization?”
Tell an agent
List all my groups.
Show the groups in organization {organization_guid}.
PATCH /groups/{group_guid} Rename a group or change its domains · Update a Group #
Ask an LLM
“Can I rename one of my groups?”
“How do I change which branded short domains a group can use?”
Tell an agent
Rename group {group_guid} to {name}.
Set the branded short domains for group {group_guid} to {bsds}.
GET /groups/{group_guid} Get a group's details · Retrieve a Group #
Ask an LLM
“Which organization and branded domains does a particular group use?”
“How do I look up a single group by its GUID?”
Tell an agent
Show group {group_guid}.
Fetch the name, organization and domains of group {group_guid}.
GET /groups/{group_guid}/tags List tags used in a group · Retrieve Tags by Group #
Ask an LLM
“What tags are my team using on links in a group?”
“Can I get the tags used on QR codes instead of links, and is there a cap on how many come back?”
Tell an agent
List the tags used in group {group_guid}.
Show group {group_guid}'s {type} tags.
GET /groups/{group_guid}/preferences Get a group's preferences · Retrieve Group Preferences #
Ask an LLM
“Which domain does a group shorten links with by default?”
“Where can I see a group's saved preferences?”
Tell an agent
Show the preferences for group {group_guid}.
Tell me which default domain group {group_guid} prefers.
PATCH /groups/{group_guid}/preferences Set a group's default domain · Update Group Preferences #
Ask an LLM
“How do I make a group shorten links on my branded domain by default?”
“Can I change a group's preferred short domain?”
Tell an agent
Set group {group_guid}'s default domain to {domain_preference}.
Change the preferred short domain for group {group_guid} to {domain_preference}.
GET /groups/{group_guid}/shorten_counts Count links shortened in a group over time · Retrieve Group Shorten Counts #
Ask an LLM
“How many links has one group shortened per day recently?”
“Can I track a group's link creation volume over time?”
Tell an agent
Show how many links group {group_guid} shortened per {unit} over the last {units} periods.
Get group {group_guid}'s shorten counts for all time by {unit}.
GET /groups/{group_guid}/countries Get a group's click traffic by country · Get Click Metrics for a Group by Country #
Ask an LLM
“Which countries does the click traffic across a whole group come from?”
“Can I see the geographic origin of clicks for a group, by country?”
Tell an agent
Show where group {group_guid}'s click traffic originates, by country, over the last {units} {unit}s.
Get the top {size} origin countries for clicks in group {group_guid} by {unit}.
GET /groups/{group_guid}/cities Get a group's click traffic by city · Get Click Metrics for a Group by City #
Ask an LLM
“What cities does a group's overall click traffic originate from?”
“Can I map a group's click origins at city level?”
Tell an agent
Show where group {group_guid}'s click traffic originates, by city, over the last {units} {unit}s.
Get the top {size} origin cities for clicks in group {group_guid} by {unit}.
GET /groups/{group_guid}/devices Get a group's click traffic by device type · Get Click Metrics for a Group by Device Type #
Ask an LLM
“What mix of device types generates the click traffic for a group?”
“Is a group's audience clicking mostly on phones or computers?”
Tell an agent
Show the device types generating click traffic for group {group_guid} over the last {units} {unit}s.
Get group {group_guid}'s click traffic device mix, top {size}, by {unit}.
GET /groups/{group_guid}/referring_networks Get a group's clicks by referring network · Get Click Metrics for a Group by Referring Networks #
Ask an LLM
“Which social networks and referring networks drive clicks to a group's links?”
“Can I see group click metrics broken down by referring network?”
Tell an agent
Break down group {group_guid}'s clicks by referring network over the last {units} {unit}s.
List the top {size} referring networks for group {group_guid} by {unit}.
GET /groups/{group_guid}/referrers Get a group's click traffic by referrer · Get Click Metrics for a Group by Referrer #
Ask an LLM
“Which referrers send the most click traffic to a group overall?”
“Can I get group-wide click metrics by referrer?”
Tell an agent
Show group {group_guid}'s click traffic metrics by referrer over the last {units} {unit}s.
Get the top {size} referrers of click traffic in group {group_guid} by {unit}.
GET /groups/{group_guid}/engagements/top Rank a group's links by engagement · Get Group Top Performing Links by Engagement #
Ask an LLM
“Which links in my group have the most engagement, counting clicks and scans?”
“Can I get the top performing links in a group by engagement?”
Tell an agent
Show the top {size} links by engagement in group {group_guid} over the last {units} {unit}s.
Rank group {group_guid}'s links by engagement per {unit}.
GET /groups/{group_guid}/engagements/over_time Get a group's engagements over time · Get Group Metrics Over Time #
Ask an LLM
“How has engagement across all links in a group trended week to week?”
“Can I chart a group's total engagements over time?”
Tell an agent
Chart engagements per {unit} for all links in group {group_guid} over the last {units} periods.
Show group {group_guid}'s engagement trend ending {unit_reference}.
GET /groups/{group_guid}/clicks Count clicks on a group's Bitlinks · Get clicks by group #
Ask an LLM
“How many clicks have all the Bitlinks in a group received?”
“What is the click count for a group over the last 30 days?”
Tell an agent
Count clicks on the Bitlinks in group {group_guid} for the last {units} {unit}s.
Get the group click count for {group_guid} by {unit}.
POST /groups/{group_guid}/exports Export a group's links, QR codes or metrics as CSV · Create an inline CSV export for a group #
Ask an LLM
“Can I download a CSV of all the links or QR codes in a group?”
“How many rows can a CSV export include, and what happens when there are more?”
Tell an agent
Export group {group_guid} as a {export_type} CSV.
Export engagement metrics for {bitlinks} in group {group_guid} as CSV, as {export_type}, from {unix_from} to {unix_to}.
GET /groups/{group_guid}/feature_usage Check a group's current feature limit usage · Get limit usage for a group #
Ask an LLM
“How much of each feature limit has a group used so far?”
“Can I check a group's current usage for just one named limit?”
Tell an agent
Show group {group_guid}'s current feature limit usage.
Check current usage of the {name} limit for group {group_guid}.
GET /groups/{group_guid}/historical_usage Get a group's historical limit usage · Get historical usage for a group #
Ask an LLM
“How did a group's usage of a limit change over past months?”
“Can I see daily, weekly or monthly usage history between two dates?”
Tell an agent
Show group {group_guid}'s historical {name} usage from {start_date} to {end_date}.
Get monthly-style usage history for limit {name} in group {group_guid}, grouped by {unit}.
GET /groups/{group_guid}/links/clicks/over_time Chart link clicks over time for a group · Get Group Link Clicks Over Time #
Ask an LLM
“Can I chart link clicks per day across every link in a group?”
“What does the link-clicks timeline look like for a whole group?”
Tell an agent
Chart link clicks per {unit} for all links in group {group_guid} over the last {units} periods.
Show group {group_guid}'s link-click timeline ending {unit_reference}.
GET /groups/{group_guid}/links/clicks/devices Get link clicks by device for a group's links · Get Group Link Clicks by Device #
Ask an LLM
“In the link-clicks report for a group, how do clicks split across devices?”
“Can I see link clicks by device for all links in a group?”
Tell an agent
Break down link clicks for every link in group {group_guid} by device, last {units} {unit}s.
Get the link-clicks-by-device report for group {group_guid}, top {size}, by {unit}.
GET /groups/{group_guid}/links/clicks/referrers Get link clicks by referrer for a group's links · Get Group Link Clicks by Referrer #
Ask an LLM
“In the link-clicks report, which referrers account for clicks on all of a group's links?”
“Can I pull link clicks by referrer across every link in a group?”
Tell an agent
Break down link clicks for every link in group {group_guid} by referrer, last {units} {unit}s.
Get the link-clicks-by-referrer report for group {group_guid}, top {size}, by {unit}.
GET /groups/{group_guid}/links/clicks/countries Get link clicks by country for a group's links · Get Group Link Clicks by Country #
Ask an LLM
“In the link-clicks report, how are clicks on all of a group's links spread across countries?”
“Can I pull link clicks by country for every link in a group?”
Tell an agent
Break down link clicks for every link in group {group_guid} by country, last {units} {unit}s.
Get the link-clicks-by-country report for group {group_guid}, top {size}, by {unit}.
GET /groups/{group_guid}/links/clicks/cities Get link clicks by city for a group's links · Get Group Link Clicks by City #
Ask an LLM
“In the link-clicks report, which cities do clicks on a group's links come from?”
“Can I pull link clicks by city for every link in a group?”
Tell an agent
Break down link clicks for every link in group {group_guid} by city, last {units} {unit}s.
Get the link-clicks-by-city report for group {group_guid}, top {size}, by {unit}.
GET /groups/{group_guid}/links/clicks/top Rank a group's links by clicks · Get Group Top Performing Links by Click #
Ask an LLM
“Which links in a group got the most clicks, not counting scans?”
“Can I get the top performing links in a group ranked by click count?”
Tell an agent
Show the top {size} links by clicks in group {group_guid} over the last {units} {unit}s.
Rank group {group_guid}'s links by click count per {unit}.
GET /groups/{group_guid}/codes/scans/over_time Chart QR code scans over time for a group · Get Scan Metrics for a Group Over Time #
Ask an LLM
“How have QR code scans across a group trended over time?”
“Can I chart daily scans for all of a group's QR codes?”
Tell an agent
Chart QR code scans per {unit} for group {group_guid} over the last {units} periods.
Show group {group_guid}'s QR scan timeline ending {unit_reference}.
GET /groups/{group_guid}/codes/scans/countries Get a group's QR code scans by country · Get Scan Metrics for a Group by Country #
Ask an LLM
“Which countries are a group's QR codes scanned in?”
“Can I break down all QR scans in a group by country?”
Tell an agent
Break down QR code scans in group {group_guid} by country over the last {units} {unit}s.
Show group {group_guid}'s QR scans per country by {unit}.
GET /groups/{group_guid}/codes/scans/cities Get a group's QR code scans by city · Get Scan Metrics for a Group by City #
Ask an LLM
“In which cities are a group's QR codes being scanned?”
“Can I break down all QR scans in a group by city?”
Tell an agent
List the cities where QR codes in group {group_guid} were scanned during the last {units} {unit}s.
Show group {group_guid}'s QR scans per city by {unit}.
GET /groups/{group_guid}/codes/scans/top Rank a group's QR codes by scans · Get Top Performing QR Codes for a Group #
Ask an LLM
“Which QR codes in my group are scanned the most?”
“Can I rank only standalone (decoupled) QR codes by scan count?”
Tell an agent
Show the top-scanned QR codes in group {group_guid} over the last {units} {unit}s.
Rank group {group_guid}'s QR codes by decoupled scan count, with decoupled set to {decoupled}, by {unit}.

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-groups-api-openapi.yml

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/collections/bitly-groups-api.postman_collection.json
🔗
OpenCollection
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/collections/bitly-groups-api.opencollection.json
🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/bitly/refs/heads/main/overlays/bitly-groups-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-groups-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-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 4.0.0
  title: Bitly Groups 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: Groups are subdivisions within organizations. Every user will be in at least one group, and every shortened link will be in one group. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.
servers:
- url: https://api-ssl.bitly.com/v4
security:
- bearerAuth: []
tags:


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