How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

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.

Bitly Groups API is one of 11 APIs that Bitly publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 28 operations across 26 paths, and defines 53 schemas. It is described by OpenAPI 3.0.0, at version 4.0.0.

Requests are made against a single base URL, https://api-ssl.bitly.com/v4.

28 operations 26 paths 53 schemas 25 GET2 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
4.0.0
Base URL
https://api-ssl.bitly.com/v4
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Bitly Groups API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 28

Across 26 paths, the API surfaces 28 operations — 25 GET, 2 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Groups 28

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…

GET
/groups
Retrieve Groups
getGroups 1 param → 200400403404422429500503
PATCH
/groups/{group_guid}
Update a Group
updateGroup 1 param body → 200400403404422500503
GET
/groups/{group_guid}
Retrieve a Group
getGroup 1 param → 200403404429500503
GET
/groups/{group_guid}/tags
Retrieve Tags by Group
getGroupTags 2 params → 200400403404429500503
GET
/groups/{group_guid}/preferences
Retrieve Group Preferences
getGroupPreferences 1 param → 200403404500503
PATCH
/groups/{group_guid}/preferences
Update Group Preferences
updateGroupPreferences 1 param body → 200400403404422429500503
GET
/groups/{group_guid}/shorten_counts
Retrieve Group Shorten Counts
getGroupShortenCounts 4 params → 200403404429500503
GET
/groups/{group_guid}/countries
Get Click Metrics for a Group by Country
getGroupMetricsByCountries 5 params → 200403404429500503
GET
/groups/{group_guid}/cities
Get Click Metrics for a Group by City
getGroupMetricsByCities 5 params → 200402403404429500503
GET
/groups/{group_guid}/devices
Get Click Metrics for a Group by Device Type
getGroupMetricsByDevices 5 params → 200402403404429500503
GET
/groups/{group_guid}/referring_networks
Get Click Metrics for a Group by Referring Networks
GetGroupMetricsByReferringNetworks 5 params → 200403404500503
GET
/groups/{group_guid}/referrers
Get Click Metrics for a Group by Referrer
GetGroupMetricsByReferrer 5 params → 200403404429500503
GET
/groups/{group_guid}/engagements/top
Get Group Top Performing Links by Engagement
getGroupTopMetrics 5 params → 200400403500503
GET
/groups/{group_guid}/engagements/over_time
Get Group Metrics Over Time
getGroupMetricsOverTime 4 params → 200400403500503
GET
/groups/{group_guid}/clicks
Get clicks by group
getGroupClicks 4 params → 200400402403429500503
POST
/groups/{group_guid}/exports
Create an inline CSV export for a group
postCreateGroupExport 1 param body → 200400402403422500503
GET
/groups/{group_guid}/feature_usage
Get limit usage for a group
getGroupFeatureUsage 2 params → 200400403429500
GET
/groups/{group_guid}/historical_usage
Get historical usage for a group
getGroupHistoricalUsage 5 params → 200400403429500
GET
/groups/{group_guid}/links/clicks/over_time
Get Group Link Clicks Over Time
getGroupLinkClicksOverTime 4 params → 200400403500503
GET
/groups/{group_guid}/links/clicks/devices
Get Group Link Clicks by Device
getGroupLinkClicksByDevice 5 params → 200400403500503
GET
/groups/{group_guid}/links/clicks/referrers
Get Group Link Clicks by Referrer
getGroupLinkClicksByReferrer 5 params → 200400403500503
GET
/groups/{group_guid}/links/clicks/countries
Get Group Link Clicks by Country
getGroupLinkClicksByCountry 5 params → 200400403500503
GET
/groups/{group_guid}/links/clicks/cities
Get Group Link Clicks by City
getGroupLinkClicksByCity 5 params → 200400403500503
GET
/groups/{group_guid}/links/clicks/top
Get Group Top Performing Links by Click
getGroupTopLinkClicks 5 params → 200400403500503
GET
/groups/{group_guid}/codes/scans/over_time
Get Scan Metrics for a Group Over Time
getGroupCodeScansOverTime 4 params → 200400403500503
GET
/groups/{group_guid}/codes/scans/countries
Get Scan Metrics for a Group by Country
getGroupCodeScansByCountry 4 params → 200400403500503
GET
/groups/{group_guid}/codes/scans/cities
Get Scan Metrics for a Group by City
getGroupCodeScansByCity 4 params → 200400403500503
GET
/groups/{group_guid}/codes/scans/top
Get Top Performing QR Codes for a Group
getGroupTopCodeScans 5 params → 200400403500503

Schemas 53

The contract defines 53 schemas that model the data the API accepts and returns. The most detailed are BitlinkUpdate (17 properties), QRCodeMinimal (16 properties), GroupExportResponse (11 properties), DeeplinkRule (10 properties). Each schema is shown below with its type and property counts.

BadRequest
BADREQUEST
BaseMetrics
object
4 properties
BitlinkBody
object
BitlinkUpdate
object
17 properties
CityMetric
object
5 properties
CityMetrics
object
ClickLink
object
2 properties
ClickMetric
object
2 properties
ClickMetrics
object
CountItem
object
2 properties
DeeplinkRule
object
10 properties
DeviceMetric
object
2 properties
DeviceMetrics
object
DynamicRoutingDeviceEnum
string
Device type values for use in dynamic routing rules (devicematch / deviceexclude)
DynamicRoutingPlatformEnum
string
Platform (OS) values for use in dynamic routing rules (osmatch / osexclude)
DynamicRoutingRule
object
A dynamic routing rule that redirects traffic to a different destination based on user attributes.
9 properties
EngagementSubtotal
object
Engagement-count subtotal for a single bitlink or decoupled QR code. The id references either a bitlink ( / ) or a QR code guid, and engagements is the combine…
2 properties
Error
object
4 properties
FieldError
object
3 properties
Forbidden
FORBIDDEN
Group
object
8 required
GroupClicks
object
4 properties
GroupConsumableFeatureUsage
object
3 properties
GroupExportFilter
object
Search constraints used to resolve links or QR codes for export. Required for linkslist and qrcodeslist.
7 properties
GroupExportRequestBody
object
6 properties 1 required
GroupExportResponse
object
11 properties
GroupFeatureUsage
object
2 properties 2 required
GroupHistoricalUsage
object
5 properties 5 required
GroupPreferences
object
2 properties
GroupUpdate
object
3 properties
Groups
object
1 property 1 required
HasReferences
object
1 property
HistoricalFeatureUsage
object
2 properties
HistoricalUsage
object
2 properties
InstallPreference
string
InternalError
INTERNALERROR
Metric
object
2 properties
Metrics
object
MobileOS
string
MonthlyLimitExceeded
MONTHLYLIMITEXCEEDED
NotFound
NOTFOUND
OtherMetrics
object
2 properties
QRCodeMinimal
object
16 properties
QRCodeTypeEnum
string
The type of dynamic/static content the QR serves, e.g. Link In Bio page, micro site, bitlink, email, text, Wifi, etc.
SimplifiedError
object
3 properties
SortedLinks
object
2 properties
Tags
object
1 property
TemporarilyUnavailable
TEMPORARILYUNAVAILABLE
TimeUnit
string
the unit of time queried for (minute, hour, day, week, month)
TimeUnitDWM
string
the unit of time queried for (day, week, month)
TopLinksAndQRCodes
object
Response shape for top bitlinks and decoupled QR codes in a group, ranked together by engagement count. links and qrcodes are independent lists (a link and a d…
3 properties
UnprocessableEntity
UNPROCESSABLEENTITY
UpgradeRequired
UPGRADEREQUIRED

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitly-groups-api-openapi.yml Raw ↑

Other APIs Bitly publishes across the network.

Bitly BSDs API
Bitly Bitlinks API
Bitly Campaigns API
Bitly Custom Bitlinks API
Bitly OAuth Apps API
Bitly Organizations API
Bitly QR Codes API
Bitly User API
Bitly Webhooks API
Bitly MCP Server
Where this information came from

This is an independent, third-party profile of Bitly Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.