---
canonical_url: "https://docs.composio.dev/toolkits/bitly"
markdown_url: "https://docs.composio.dev/toolkits/bitly.md"
product: "platform"
version: null
last_updated: null
---

# Bitly

Bitly is a link management platform for shortening, customizing, sharing, and measuring links and QR codes.

- **Category:** url shortener
- **Auth:** API_KEY, OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 10
- **Triggers:** 0
- **Slug:** `BITLY`
- **Version:** 20260826_00

## Tools

### Delete Bitlink

**Slug:** `BITLY_DELETE_BITLINK`

Permanently delete an eligible unedited hash Bitlink.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bitlink` | string | Yes | Bitlink as domain/back-half without a protocol; deletion is permanent and Bitly only permits eligible unedited hash links. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Expand Link

**Slug:** `BITLY_EXPAND_LINK`

Resolve a Bitlink to its current destination and destination history, when available.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bitlink` | string | Yes | Bitlink as domain/back-half without a protocol, for example bit.ly/12a4b6c. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Account Context

**Slug:** `BITLY_GET_ACCOUNT_CONTEXT`

Return the authenticated Bitly user together with accessible groups and organizations needed by other tools.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `organization_guid` | string | No | Optionally restrict groups to one Bitly organization GUID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bitlink

**Slug:** `BITLY_GET_BITLINK`

Retrieve full Bitlink metadata, including destination, title, tags, archive or deletion state, and associated QR code IDs.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `bitlink` | string | Yes | Bitlink as domain/back-half without a protocol, for example bit.ly/12a4b6c. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bitlink Activity

**Slug:** `BITLY_GET_BITLINK_ACTIVITY`

Return paid-plan click or engagement analytics for a Bitlink as a timeline or summary. Requires Bitlink analytics entitlement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `unit` | string ("minute" | "hour" | "day" | "week" | "month") | No | Time bucket and lookback unit. |
| `view` | string ("summary" | "timeline") | No | Return one total or time-bucketed values. |
| `units` | integer | No | Number of units to query; -1 requests all available units. |
| `metric` | string ("clicks" | "engagements") | No | Measure link clicks only or all engagement types, including clicks, scans, and Bitly Link-in-bio button clicks. |
| `bitlink` | string | Yes | Bitlink as domain/back-half without a protocol. |
| `unit_reference` | string | No | Optional ISO-8601 end timestamp; defaults to now. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Bitlink Traffic Sources

**Slug:** `BITLY_GET_BITLINK_TRAFFIC_SOURCES`

Break down paid-plan Bitlink click analytics by country, city, device, referrer, or referring domain. Requires Bitlink analytics entitlement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum ranked values to return; this is not pagination. |
| `unit` | string ("minute" | "hour" | "day" | "week" | "month") | No | Time unit for the lookback window. |
| `units` | integer | No | Number of units to query; -1 requests all available units. |
| `bitlink` | string | Yes | Bitlink as domain/back-half without a protocol. |
| `dimension` | string ("country" | "city" | "device" | "referrer" | "referring_domain") | Yes | Dimension by which to rank click traffic. |
| `unit_reference` | string | No | Optional ISO-8601 end timestamp; defaults to now. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Usage and Limits

**Slug:** `BITLY_GET_USAGE_AND_LIMITS`

Inspect monthly plan quotas, hourly endpoint budgets, and optional group feature usage before performing quota-consuming work.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `group_guid` | string | No | Optional group GUID whose current feature usage to include. |
| `endpoint_path` | string | No | Optional API path filter for hourly platform limits. |
| `feature_names` | array | No | Optional group feature names to include, such as encode or qr_codes; requires group_guid. |
| `organization_guid` | string | Yes | Organization GUID whose monthly plan limits to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Bitlinks

**Slug:** `BITLY_LIST_BITLINKS`

List or search Bitlinks owned by a group, one cursor-controlled page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `size` | integer | No | Maximum number of links to return in this page. |
| `tags` | array | No | Restrict results to links with these tags. |
| `query` | string | No | Search text to match against links. |
| `archived` | string ("on" | "off" | "both") | No | Whether to return archived links: on, off, or both. |
| `group_guid` | string | No | GUID of the Bitly group whose links to list. Required for the first page; omit when continuing with next_cursor. |
| `next_cursor` | string | No | Opaque continuation token returned by the previous call. When provided, omit first-page selectors because it restores the group and filters. |
| `created_after` | integer | No | Only return links created after this Unix timestamp in seconds. |
| `created_before` | integer | No | Only return links created before this Unix timestamp in seconds. |
| `hostname_path_query` | string | No | Case-insensitive hostname or path search; query parameters and fragments are ignored. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Shorten Link

**Slug:** `BITLY_SHORTEN_LINK`

Create an ordinary Bitly short link for a long URL in a specific group.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | No | Short-link domain. Use bit.ly unless the account context shows an owned branded domain. |
| `long_url` | string | Yes | Absolute HTTP or HTTPS URL to shorten. |
| `group_guid` | string | Yes | Bitly group GUID that will own the link; obtain it from Get Account Context. |
| `force_new_link` | boolean | No | Create a new hash even if this group already shortened the URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Bitlink

**Slug:** `BITLY_UPDATE_BITLINK`

Update safe metadata or archive state for a Bitlink; this tool does not redirect destinations or configure advanced routing.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tags` | array | No | Complete replacement tag list; send an empty list to clear tags. |
| `title` | string | No | New human-readable title. |
| `bitlink` | string | Yes | Bitlink as domain/back-half without a protocol. |
| `archived` | boolean | No | Set true to archive or false to restore the link. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |