| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api-ssl.bitly.com/ | link | — | — | — |
Actions (77)
Groups · 18
- Get Click Metrics for a GroupGET /v4/groups/{group_guid}/clicks
Returns number of clicks for a group's links.
documented - Get Click Metrics for a Group by CityGET /v4/groups/{group_guid}/cities
Returns geographic origins by city for a group's links.
documented - Get Click Metrics for a Group by CountryGET /v4/groups/{group_guid}/countries
Returns geographic origins by country for a group's links.
documented - Get Click Metrics for a Group by DeviceGET /v4/groups/{group_guid}/devices
Returns device types for a group's links.
documented - Get Click Metrics for a Group by ReferrerGET /v4/groups/{group_guid}/referrers
Returns metrics by referrer for a group's links.
documented - Get Click Metrics for a Group by Referring NetworksGET /v4/groups/{group_guid}/referring_networks
Returns metrics by referring networks for a group's links.
documented - Get Group Metrics Over TimeGET /v4/groups/{group_guid}/engagements/over_time
Retrieves engagement metrics over time for a group.
documented - Get Group Top Performing Links by EngagementGET /v4/groups/{group_guid}/engagements/top
Gets top engaging links in a group.
documented - Get QR Code Scan Metrics by City (Group)GET /v4/groups/{group_guid}/codes/scans/cities
QR code scans for a group by city.
documented - Get QR Code Scan Metrics by Country (Group)GET /v4/groups/{group_guid}/codes/scans/countries
QR code scans for a group by country.
documented - Retrieve GroupGET /v4/groups/{group_guid}
Returns details for a group.
documented - Retrieve Group PreferencesGET /v4/groups/{group_guid}/preferences
Returns preferences for the specified group.
documented - Retrieve Group Shorten CountsGET /v4/groups/{group_guid}/shorten_counts
Returns all shorten counts for a group.
documented - Retrieve GroupsGET /v4/groups
Returns groups in the organization.
documented - Retrieve QR Codes by GroupGET /v4/groups/{group_guid}/qr-codes
Retrieves QR codes for a specific group.
documented - Retrieve Tags by GroupGET /v4/groups/{group_guid}/tags
Returns the tags currently used in the specified group.
documented - Update GroupPATCH /v4/groups/{group_guid}
Updates details of a group.
documented - Update Group PreferencesPATCH /v4/groups/{group_guid}/preferences
Updates preferences for a group.
documented
Bitlinks · 15
- Create BitlinkPOST /v4/bitlinks
Creates a new Bitlink with optional metadata such as title, tags, and deep links.
documented - Delete BitlinkDELETE /v4/bitlinks/{bitlink}
Deletes an unedited Bitlink identified by its Bitlink (domain+hash).
documented - Expand BitlinkPOST /v4/expand
Returns the short link and the long URL for the specified Bitlink.
documented - Get Clicks Summary for BitlinkGET /v4/bitlinks/{bitlink}/clicks/summary
Returns the total click counts for the Bitlink in a summarized form.
documented - Get Clicks by CityGET /v4/bitlinks/{bitlink}/cities
Returns city origins of click traffic for the Bitlink.
documented - Get Clicks by CountryGET /v4/bitlinks/{bitlink}/countries
Returns country origins of click traffic for the Bitlink.
documented - Get Clicks by DeviceGET /v4/bitlinks/{bitlink}/devices
Returns device types generating click traffic for the Bitlink.
documented - Get Clicks by Referrer NameGET /v4/bitlinks/{bitlink}/referrer_name
Returns referrer click counts for the Bitlink by referrer name.
documented - Get Clicks by ReferrersGET /v4/bitlinks/{bitlink}/referrers
Returns referrer click counts for the Bitlink.
documented - Get Clicks by Referrers by DomainGET /v4/bitlinks/{bitlink}/referrers_by_domains
Returns click metrics grouped by referring domains for the Bitlink.
documented - Get Clicks by Referring DomainsGET /v4/bitlinks/{bitlink}/referring_domains
Returns referring domain click counts for the Bitlink.
documented - Get Clicks for BitlinkGET /v4/bitlinks/{bitlink}/clicks
Returns the click counts for the Bitlink over time.
documented - Retrieve BitlinkGET /v4/bitlinks/{bitlink}
Returns information for the specified Bitlink.
documented - Shorten a LinkPOST /v4/shorten
Converts a long URL into a Bitlink (shortened URL).
documented - Update BitlinkPATCH /v4/bitlinks/{bitlink}
Updates fields on the specified Bitlink (e.g., title, tags, deeplinks). To change the destination URL, use the long_url parameter.
documented
QR Codes · 12
- Create QR CodePOST /v4/qr-codes
Creates a QR Code (new endpoint version supports GS1 barcodes and non-linked QR codes).
documented - Delete QR CodeDELETE /v4/qr-codes/{qrcode_id}
Deletes a QR Code.
documented - Get QR Code ImageGET /v4/qr-codes/{qrcode_id}/image
Returns the QR Code image in various formats.
documented - Get QR Code ScansGET /v4/qr-codes/{qrcode_id}/scans
Returns scan counts for a QR Code over time.
documented - Get QR Code Scans SummaryGET /v4/qr-codes/{qrcode_id}/scans/summary
Returns a summarized view of scans for a QR Code.
documented - Get QR Code Scans by BrowserGET /v4/qr-codes/{qrcode_id}/scans/browsers
Returns browser distribution for a QR Code scans.
documented - Get QR Code Scans by CityGET /v4/qr-codes/{qrcode_id}/scans/cities
Returns scan counts by city for a QR Code.
documented - Get QR Code Scans by CountryGET /v4/qr-codes/{qrcode_id}/scans/countries
Returns scan counts by country for a QR Code.
documented - Get QR Code Scans by Device OSGET /v4/qr-codes/{qrcode_id}/scans/device_os
Returns device OS distribution for a QR Code scans.
documented - Retrieve QR CodeGET /v4/qr-codes/{qrcode_id}
Retrieves a specific QR Code.
documented - Retrieve QR Codes by GroupGET /v4/groups/{group_guid}/qr-codes
Fetches QR Codes for a specific group.
documented - Update QR CodePATCH /v4/qr-codes/{qrcode_id}
Updates a QR Code.
documented
Custom Bitlinks · 9
- Add Custom BitlinkPOST /v4/custom_bitlinks
Adds a keyword (custom back-half) to a Bitlink under a matching custom domain.
documented - Edit Tags on Group BitlinksPATCH /v4/groups/{group_guid}/bitlinks
Updates tags for Bitlinks within a specific group.
documented - Get Clicks by Destination (Custom Bitlink)GET /v4/custom_bitlinks/{custom_bitlink}/clicks_by_destination
Returns click metrics by destination for a custom Bitlink.
documented - Get Clicks for Custom BitlinkGET /v4/custom_bitlinks/{custom_bitlink}/clicks
Returns click counts for a custom Bitlink over time.
documented - Get Clicks for Custom Bitlink (paged)GET /v4/custom_bitlinks/{custom_bitlink}/clicks?unit=...
Same endpoint with time granularity (unit) and limits.
documented - Move Custom BitlinkPOST /v4/custom_bitlinks/{custom_bitlink}
Moves a custom bitlink (keyword) to a different Bitlink (domains must match).
documented - Retrieve Bitlinks by GroupGET /v4/groups/{group_guid}/bitlinks
Returns a paginated collection of Bitlinks for a group (includes custom Bitlinks).
documented - Retrieve Custom BitlinkGET /v4/custom_bitlinks/{custom_bitlink}
Returns the details and history for the specified custom Bitlink.
documented - Retrieve Sorted Bitlinks for GroupGET /v4/groups/{group_guid}/bitlinks/{sort}
Gets Bitlinks in a group sorted by a specified criterion (e.g., byClicks).
documented
Campaigns · 7
- Create CampaignPOST /v4/campaigns
Creates a new campaign.
documented - Create ChannelPOST /v4/channels
Creates a new channel.
documented - Retrieve CampaignGET /v4/campaigns/{campaign_guid}
Returns details for a campaign.
documented - Retrieve CampaignsGET /v4/campaigns
Returns campaigns for the current authenticated user.
documented - Retrieve ChannelsGET /v4/channels
Returns channels available to the user (optionally filtered by group/campaign).
documented - Retrieve Channels (Filtered)GET /v4/channels?group_guid={group_guid}&campaign_guid={campaign_guid}
Returns channels filtered by group and/or campaign.
documented - Update CampaignPATCH /v4/campaigns/{campaign_guid}
Updates a campaign's details.
documented
Organizations · 6
- Get Plan LimitsGET /v4/organizations/{organization_guid}/plan_limits
Returns plan limits for an organization.
documented - Get Shorten Counts by Group (Organization)GET /v4/organizations/{organization_guid}/shorten_counts_by_group
Returns organization counts by group for the current month.
documented - Get Shorten Counts for OrganizationGET /v4/organizations/{organization_guid}/shorten_counts
Returns shorten counts for an organization.
documented - Retrieve OrganizationGET /v4/organizations/{organization_guid}
Retrieves details for a specific organization.
documented - Retrieve OrganizationsGET /v4/organizations
Retrieves a list of organizations.
documented - Retrieve WebhooksGET /v4/organizations/{organization_guid}/webhooks
Fetches webhooks for an organization.
documented
Webhooks · 6
- Create WebhookPOST /v4/webhooks
Creates a new webhook.
documented - Delete WebhookDELETE /v4/webhooks/{webhook_guid}
Deletes a webhook.
documented - Get WebhooksGET /v4/organizations/{organization_guid}/webhooks
Fetches all webhooks for an organization.
documented - Retrieve WebhookGET /v4/webhooks/{webhook_guid}
Returns a webhook by its GUID.
documented - Update WebhookPATCH /v4/webhooks/{webhook_guid}
Updates a webhook's configuration.
documented - Verify WebhookPOST /v4/webhooks/{webhook_guid}/verify
Sends a test ping to verify webhook configuration.
documented
User · 3
- Get Platform LimitsGET /v4/user/platform_limits
Fetches platform limit usage for the current user.
documented - Retrieve a UserGET /v4/user
Returns information for the current authenticated user.
documented - Update UserPATCH /v4/user
Updates fields for the current user (e.g., name, default_group_guid).
documented