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

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

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

This API exposes 21 operations across 18 paths, and defines 61 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.

21 operations 18 paths 61 schemas 1 DELETE15 GET2 PATCH3 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 Bitlinks API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

Paths & Operations 21

Across 18 paths, the API surfaces 21 operations — 1 DELETE, 15 GET, 2 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Bitlinks 21

Bitlinks are shortened links. They could begin with the bit.ly domain or your own custom branded short domain (BSD). Related Operations: - [POST /bitlinks](createFullBitlink) - Cr…

POST
/shorten
Shorten a Link
createBitlink body → 200201400403417422429500
POST
/bitlinks
Create a Bitlink
createFullBitlink body → 200201400402403404417422
DELETE
/bitlinks/{bitlink}
Delete a Bitlink
deleteBitlink 1 param → 200400403404429500503
PATCH
/bitlinks/{bitlink}
Update a Bitlink
updateBitlink 1 param body → 200400402403404409410422
GET
/bitlinks/{bitlink}
Retrieve a Bitlink
getBitlink 1 param → 200403404410429500503
POST
/expand
Expand a Bitlink
expandBitlink body → 200400404410422500503
GET
/bitlinks/{bitlink}/clicks
Get Clicks for a Bitlink
getClicksForBitlink 4 params → 200403404429500503
GET
/bitlinks/{bitlink}/clicks/summary
Get a Clicks Summary for a Bitlink
getClicksSummaryForBitlink 4 params → 200403404429500503
GET
/bitlinks/{bitlink}/engagements
Get Engagement Counts for a Bitlink
getEngagements 4 params → 200400403404410500503
GET
/bitlinks/{bitlink}/engagements/summary
Get an Engagement Count Summary for a Bitlink
getEngagementsSummary 4 params → 200400403404410500503
GET
/bitlinks/{bitlink}/countries
Get Metrics for a Bitlink by Country
getMetricsForBitlinkByCountries 5 params → 200400403404410429500503
GET
/bitlinks/{bitlink}/cities
Get Metrics for a Bitlink by City
getMetricsForBitlinkByCities 5 params → 200400402403404410429500
GET
/bitlinks/{bitlink}/devices
Get Metrics for a Bitlink by Device Type
getMetricsForBitlinkByDevices 5 params → 200400402403404410429500
GET
/bitlinks/{bitlink}/referrers
Get Metrics for a Bitlink by Referrers
getMetricsForBitlinkByReferrers 5 params → 200400403404410429500503
GET
/bitlinks/{bitlink}/referrer_name
Get Metrics for a Bitlink by Referrer Name
getMetricsForBitlinkByReferrerName 5 params → 200400403404410500503
GET
/bitlinks/{bitlink}/referring_domains
Get Metrics for a Bitlink by Referring Domains
getMetricsForBitlinkByReferringDomains 5 params → 200400403404410429500503
GET
/bitlinks/{bitlink}/referrers_by_domains
Get Metrics for a Bitlink by Referrers by Domain
getMetricsForBitlinkByReferrersByDomains 5 params → 200400403404410429500503
GET
/groups/{group_guid}/bitlinks
Retrieve Bitlinks by Group
getBitlinksByGroup 20 params → 200403404500503
PATCH
/groups/{group_guid}/bitlinks
Bulk update bitlinks
updateBitlinksByGroup 1 param body → 200400403404422500503
GET
/groups/{group_guid}/engagements/sorted/top
Retrieve Top Links and Decoupled QR Codes by Engagements
getTopLinksAndQRCodesByEngagements 5 params → 200403404429500503
GET
/groups/{group_guid}/bitlinks/{sort}
Retrieve Sorted Bitlinks for Group
getSortedBitlinks 6 params → 200403404429500503

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are BitlinkUpdate (17 properties), QRCodeMinimal (16 properties), FullShorten (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
BitlinkUpdateBody
object
7 properties
Bitlinks
object
2 properties
BitlinksPagination
object
3 properties
BulkUpdate
object
1 property
BulkUpdateRequest
object
5 properties 1 required
CityMetric
object
5 properties
CityMetrics
object
ClickLink
object
2 properties
ClickMetric
object
2 properties
ClickMetrics
object
Clicks
object
4 properties
ClicksSummary
object
4 properties
Conflict
CONFLICT
Deeplink
object
4 properties
DeeplinkRule
object
10 properties
DeletedLink
object
1 property
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
Engagement
object
3 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
Engagements
object
3 properties
Error
object
4 properties
ExpandBitlink
object
1 property
ExpandedBitlink
object
5 properties
ExpectationFailed
EXPECTATIONFAILED
FieldError
object
3 properties
Forbidden
FORBIDDEN
FullShorten
object
Either longurl (for new bitlinks) or bitlinkid (for adding keywords to existing bitlinks) must be provided, but not both.
11 properties
Gone
GONE
HasReferences
object
1 property
InstallPreference
string
InternalError
INTERNALERROR
LinkClicks
object
2 properties
LinkDeletionResponse
object
1 property
Metric
object
2 properties
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.
ReferrersByDomain
object
2 properties
ReferrersByDomains
object
5 properties
Shorten
object
4 properties 1 required
ShortenBitlinkBody
object
SimplifiedError
object
3 properties
SortedLinks
object
2 properties
TemporarilyUnavailable
TEMPORARILYUNAVAILABLE
TimeUnit
string
the unit of time queried for (minute, hour, 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
TotalEngagements
object
4 properties
TotalEngagementsSummary
object
5 properties
UnprocessableEntity
UNPROCESSABLEENTITY
UpgradeRequired
UPGRADEREQUIRED

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bitly-bitlinks-api-openapi.yml Raw ↑

Other APIs Bitly publishes across the network.

Bitly BSDs API
Bitly Campaigns API
Bitly Custom Bitlinks API
Bitly Groups 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 Bitlinks 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.