> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Bitly

> How to set up the Bitly connector, plus the actions that are available.

![Bitly](https://stackone-logos.com/api/bitly/filled/svg)

v1.1.0[See changelog](https://docs.stackone.com/connectors/bitly/changelog.md)

[85 actions](#actions) · 2 auth methods

Marketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Access Token · Connector Profile](https://docs.stackone.com/connectors/bitly/guides/connector-profile/access-token.md)
>
> Authenticate with a Bitly Generic Access Token. Best suited for single-account integrations and quick setup.

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/bitly/guides/connector-profile/oauth-2-0.md)
>
> Connect Bitly accounts securely using OAuth 2.0 authorization for multi-user access.

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Access Token · Link Account](https://docs.stackone.com/connectors/bitly/guides/link-account/access-token.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/bitly/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

Access Token

OAuth 2.0

No auth methods found

85 actions

ActionDescription

Get Current User`bitly_get_current_user`

Retrieve information about the currently authenticated Bitly user

Update Current User`bitly_update_current_user`

Update properties of the currently authenticated Bitly user

Shorten A Link`bitly_shorten_link`

Convert a long URL into a Bitlink short link

Create A Bitlink`bitly_create_bitlink`

Create a Bitlink with full options including title, tags, deeplinks and expiration

Get A Bitlink`bitly_get_bitlink`

Retrieve a single Bitlink by its identifier

Update A Bitlink`bitly_update_bitlink`

Update properties of an existing Bitlink

Delete A Bitlink`bitly_delete_bitlink`

Delete an unedited Bitlink

Expand A Bitlink`bitly_expand_bitlink`

Resolve a Bitlink to its long URL

Get Clicks For A Bitlink`bitly_get_bitlink_clicks`

Retrieve click metrics for a Bitlink over time

Get Clicks Summary For A Bitlink`bitly_get_bitlink_clicks_summary`

Retrieve a summarized click count for a Bitlink

Get Engagement Counts For A Bitlink`bitly_get_bitlink_engagements`

Retrieve engagement counts (button clicks, clicks, scans) over time

Get Engagement Summary For A Bitlink`bitly_get_bitlink_engagements_summary`

Retrieve a summarized engagement count for a Bitlink

Get Bitlink Metrics By Country`bitly_get_bitlink_countries`

Retrieve click metrics grouped by country for a Bitlink

Get Bitlink Metrics By City`bitly_get_bitlink_cities`

Retrieve click metrics grouped by city for a Bitlink

Get Bitlink Metrics By Device`bitly_get_bitlink_devices`

Retrieve click metrics grouped by device type for a Bitlink

Get Bitlink Metrics By Referrers`bitly_get_bitlink_referrers`

Retrieve click metrics grouped by referrer for a Bitlink

Get Bitlink Metrics By Referrer Name`bitly_get_bitlink_referrer_name`

Retrieve click metrics grouped by referrer name for a Bitlink

Get Bitlink Metrics By Referring Domains`bitly_get_bitlink_referring_domains`

Retrieve click metrics grouped by referring domain for a Bitlink

Get Bitlink Metrics By Referrers By Domain`bitly_get_bitlink_referrers_by_domains`

Retrieve click metrics grouped by referrers within each domain

Bulk Update Bitlinks`bitly_bulk_update_group_bitlinks`

Bulk update up to 100 Bitlinks in a group (archive or edit tags)

List Sorted Bitlinks For Group`bitly_list_group_bitlinks_sorted`

Retrieve Bitlinks for a group sorted by click count

Add A Custom Bitlink`bitly_create_custom_bitlink`

Create a custom Bitlink keyword that points to an existing Bitlink

Get A Custom Bitlink`bitly_get_custom_bitlink`

Retrieve information about a custom Bitlink

Update A Custom Bitlink`bitly_update_custom_bitlink`

Update a custom Bitlink to point to a different Bitlink

Get Clicks For A Custom Bitlink`bitly_get_custom_bitlink_clicks`

Retrieve clicks for a custom Bitlink across its lifetime

Get Custom Bitlink Metrics By Destination`bitly_get_custom_bitlink_clicks_by_destination`

Retrieve click metrics for a custom Bitlink broken down by historical destinations

List Groups`bitly_list_groups`

Retrieve all groups available to the authenticated user

Get A Group`bitly_get_group`

Retrieve details for a specific group by GUID

Update A Group`bitly_update_group`

Update properties of a group

Get Group Tags`bitly_get_group_tags`

Retrieve all tags defined for a group

Get Group Preferences`bitly_get_group_preferences`

Retrieve preferences for a group

Update Group Preferences`bitly_update_group_preferences`

Update preferences for a group

List Bitlinks By Group`bitly_list_group_bitlinks`

Retrieve Bitlinks owned by a group with filtering and pagination

Get Group Shorten Counts`bitly_get_group_shorten_counts`

Retrieve the number of Bitlinks shortened by a group over time

Get Group Metrics By Country`bitly_get_group_countries`

Retrieve click metrics for a group grouped by country

Get Group Metrics By City`bitly_get_group_cities`

Retrieve click metrics for a group grouped by city

Get Group Metrics By Device`bitly_get_group_devices`

Retrieve click metrics for a group grouped by device type

Get Group Metrics By Referring Networks`bitly_get_group_referring_networks`

Retrieve click metrics for a group grouped by referring network

Get Group Metrics By Referrer`bitly_get_group_referrers`

Retrieve click metrics for a group grouped by referrer

Get Clicks By Group`bitly_get_group_clicks`

Retrieve the total number of clicks across Bitlinks in a group over time

Get Group Top Performing Links By Engagement`bitly_get_group_engagements_top`

Retrieve top performing Bitlinks in a group ranked by engagement

Get Group Engagement Metrics Over Time`bitly_get_group_engagements_over_time`

Retrieve engagement metrics for a group as a time series

Get Group Feature Usage`bitly_get_group_feature_usage`

Retrieve current limit usage for a group

Get Group Historical Usage`bitly_get_group_historical_usage`

Retrieve historical limit usage for a group

Get Group Link Clicks Over Time`bitly_get_group_links_clicks_over_time`

Retrieve link clicks over time for all Bitlinks in a group

Get Group Link Clicks By Device`bitly_get_group_links_clicks_devices`

Retrieve link clicks by device type for all Bitlinks in a group

Get Group Link Clicks By Referrer`bitly_get_group_links_clicks_referrers`

Retrieve link clicks by referrer for all Bitlinks in a group

Get Group Link Clicks By Country`bitly_get_group_links_clicks_countries`

Retrieve link clicks by country for all Bitlinks in a group

Get Group Link Clicks By City`bitly_get_group_links_clicks_cities`

Retrieve link clicks by city for all Bitlinks in a group

Get Group Top Performing Links By Click`bitly_get_group_links_clicks_top`

Retrieve top performing Bitlinks in a group ranked by click count

Get Group QR Scan Metrics Over Time`bitly_get_group_scans_over_time`

Retrieve QR code scan metrics for a group over time

Get Group QR Scan Metrics By Country`bitly_get_group_scans_countries`

Retrieve QR code scan metrics for a group by country

Get Group QR Scan Metrics By City`bitly_get_group_scans_cities`

Retrieve QR code scan metrics for a group by city

Get Group Top Performing QR Codes`bitly_get_group_scans_top`

Retrieve top performing QR codes in a group by scan count

List Organizations`bitly_list_organizations`

Retrieve all organizations the authenticated user belongs to

Get An Organization`bitly_get_organization`

Retrieve a single organization by GUID

Get Organization Shorten Counts`bitly_get_organization_shorten_counts`

Retrieve shorten counts for an organization

Get Organization Shorten Counts By Group`bitly_get_organization_shorten_counts_by_group`

Retrieve shorten counts for an organization broken down by group

Get Organization Plan Limits`bitly_get_organization_plan_limits`

Retrieve plan limits and usage for an organization

List Campaigns`bitly_list_campaigns`

Retrieve all campaigns for the authenticated user

Create A Campaign`bitly_create_campaign`

Create a new campaign within a group

Get A Campaign`bitly_get_campaign`

Retrieve a campaign by GUID

Update A Campaign`bitly_update_campaign`

Update properties of a campaign

List Channels`bitly_list_channels`

Retrieve channels available to the authenticated user

Create A Channel`bitly_create_channel`

Create a new channel within a group

Get A Channel`bitly_get_channel`

Retrieve a channel by GUID

Update A Channel`bitly_update_channel`

Update properties of a channel

Create A QR Code`bitly_create_qr_code`

Create a saved QR code resource

Generate A Static QR Code Image`bitly_create_static_qr_code`

Generate a static QR code image without creating a saved resource

Get A QR Code`bitly_get_qr_code`

Retrieve a saved QR code by ID

Get A QR Code Image`bitly_get_qr_code_image`

Retrieve the rendered image for a saved QR code

Update A QR Code`bitly_update_qr_code`

Update properties of a saved QR code

Delete A QR Code`bitly_delete_qr_code`

Delete a QR code and its associated link

List QR Codes By Group`bitly_list_group_qr_codes`

Retrieve QR codes for a group in reverse chronological order

Get Scans For A QR Code`bitly_get_qr_code_scans`

Retrieve scan counts for a QR code over time

Get Scans Summary For A QR Code`bitly_get_qr_code_scans_summary`

Retrieve total scan count for a QR code rolled up into a single value

Get QR Code Scans By Country`bitly_get_qr_code_scans_countries`

Retrieve country origins of scan traffic for a QR code

Get QR Code Scans By City`bitly_get_qr_code_scans_cities`

Retrieve city origins of scan traffic for a QR code

List Branded Short Domains`bitly_list_bsds`

Retrieve all branded short domains available to the authenticated user

List Webhooks`bitly_list_webhooks`

Retrieve all webhooks defined for an organization

Create A Webhook`bitly_create_webhook`

Create a webhook for an organization

Get A Webhook`bitly_get_webhook`

Retrieve a webhook by GUID

Update A Webhook`bitly_update_webhook`

Update properties of a webhook

Delete A Webhook`bitly_delete_webhook`

Delete a webhook

Verify A Webhook`bitly_verify_webhook`

Send a ping event to verify a webhook is configured correctly


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.