Bitly

Add a keyword (or "custom back-half") to a Bitlink with a Custom Domain (domains must match). This endpoint can also be used for initial redirects to a link.

Converts a long url to a Bitlink. You may see errors returned from this endpoint - "BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED" occurs if you have shortened more links than your account is configured for for the month, and "DNS_CONFIGURATION_ERROR" occurs if you are attempting to shorten links against a custom domain which doesn't have DNS properly configured.

Creates a new campaign.

Creates a new channel.

Converts a long url to a Bitlink and sets additional parameters. You may see errors returned from this endpoint - "BRANDED_LINK_MONTHLY_LIMIT_EXCEEDED" occurs if you have shortened more links than your account is configured for for the month, and "DNS_CONFIGURATION_ERROR" occurs if you are attempting to shorten links against a custom domain which doesn't have DNS properly configured.

Create a new QR Code and return its metadata

Generate a static QR code image without creating or saving a QR code resource. SVG and PNG output are supported via the Accept header Contact your Account Manager to discuss enabling this feature for your account. The `render_customizations` field supports basic appearance options. Customizations that require the rasterize API are not supported: `gradient`, `background_gradient`, `frame`, `text`, and `logo`. The Accept header controls the response format: - `application/json` (default): Returns a JSON object with the image as a base64-encoded byte string. - `image/svg+xml`: Returns the raw SVG image. - `image/png`: Returns the raw PNG image.

Creates a webhook.

Delete an unedited hash Bitlink.

Delete a QR Code that has not been redirected and is not for a custom link. Also deletes the associated link (if applicable).

Deletes a webhook.

Returns the short link and long URL for the specified link.

Returns information for the specified link.

Returns a paginated collection of Bitlinks for a group. The list of custom bitlinks has newest entries first.

Fetch all Branded Short Domains

Returns details for a campaign.

Returns the campaigns for the current authenticated user.

Returns a channel's details.

Returns the channels available to a user.

Returns the click counts for the specified link in an array based on a date.

Returns the click counts for the specified link. This returns an array with clicks based on a date.

Returns the click counts for the specified link rolled up into a single field.

Returns the details and history of the specified link.

Returns click metrics for the specified link by its historical destinations.

Returns an array of engagement counts for the specified link. The array is comprised of button click, click and scan counts for each time window, where the window is based on the provided unit.

Returns the engagement counts for the specified link rolled up into a single field.

Returns details for a group.

get number of clicks on bitlinks in a group

Get QR code scan metrics for a group broken down by city.

Get QR code scan metrics for a group broken down by country.

Get QR code scan metrics over time for a group.

Get a group's current feature limit usage, optionally provide limit name(s) for usage on specific limit(s)

Get a group's historical usage for specific limit(s) and date range. Refer to GET /v4/groups/{group_guid}/feature_usage endpoint response for available limit names.

Get link clicks by city for all links in a group.

Get link clicks by country for all links in a group.

Get link clicks by device for all links in a group.

Get link clicks by referrer for all links in a group.

Get link clicks over time for all links in a group.

Returns the geographic origins of click traffic by city for the specified group.

Returns the geographic origins of click traffic by country for the specified group.

Returns the device types generating click traffic to the specified group's links.

Returns metrics by referrer for the specified group's links.

Returns metrics by referring networks for the specified group's links.

Get group engagement metrics over time for all links in a group.

Returns preferences for the specified group.

Returns all the shorten counts for a group.

Returns the tags currently used in the specified group. Maximum 1000.

Get top performing QR codes by scan count for all codes in a group.

Get top performing links by click for all links in a group.

Get top performing links by engagement for all links in a group.

Returns a list of groups in the organization.

Returns the city origins of click traffic for the specified link.

Returns the country origins of click traffic for the specified link.

Returns the device types generating click traffic to the specified link.

Returns referrer click counts for the specified link.

Returns referrer click counts for the specified link.

Returns click metrics grouped by referrers for the specified link.

Returns the referring domain click counts for the specified link.

Retrieve the details for the provided OAuth App client ID

Retrive details for the specified organization.

Returns the shorten counts for a specific organization over a specified time period.

Returns the shorten counts for a specific organization by group for the current month.

Retrieve a list of organizations for the authenticated user. By default, only organizations permitted by the token's allowed_orgs are returned. Use include_all=true to return all organizations regardless of token restrictions. Each organization is annotated with its authentication requirements (require_sso, require_2fa) when configured.

Returns all plan limits and counts available for an organization.

Fetch all platform limits and counts available for an organization

Gets the QR code with a matching id.

Get the image of a given QR Code. The Accept header controls how this is returned (options are "application/json", "image/svg+xml", and "image/png"). If the Accept header is "application/json" the format query parameter will determine the image format inside of the json (which will be base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag). To Return the QR Code image itself, set the Accept header to "image/svg+xml" or "image/png", or remove the Accept header and set the format query parameter to “svg” or “png” (if no format is specified the default will be “svg”).

Returns an array of scan counts for the specified QR code. The array is comprised of scan counts for each time window, where the window is based on the provided unit.

Returns the browsers generating scan traffic to the specified QR Code.

Returns the city origins of scan traffic for the specified QR Code.

Returns the country origins of scan traffic for the specified QR Code.

Returns the device os generating scan traffic for the specified QR Code.

Returns the scan counts for a QR Code rolled up into a single field for a specified time window, where the window is based on the provided unit.

Returns a list of Bitlinks sorted by group. The list of custom bitlinks has newest entries first.

Returns the bitlinks and decoupled QR codes in a group with the most engagements over the requested time window, ranked together in descending order by engagement count. Bitlinks and decoupled QR codes are returned in separate lists; `sorted_links` preserves the unified descending-by-count ordering across both, with each entry's id referencing either a bitlink or a QR code guid.

Returns information for the current authenticated user.

Returns a webhook.

Fetch all webhooks available for an Organization

Retrieves a list of QR codes matching the filter settings. Values are in reverse chronological order. The pagination occurs by calling the next link in the pagination response object.

Build a CSV export synchronously and return it inline as a base64 data URI plus metadata. The export_type field selects the CSV shape: link_engagements_batch (engagement metrics for explicit bitlinks or a filter), links_list (link metadata roster), or qr_codes_list (QR code metadata roster). Row caps apply per request: 200 rows when metrics are included (link_engagements_batch, or include_metrics on a list export); 1000 rows for metadata-only list exports. When the match set exceeds the cap, truncated is true and only the first cap rows are returned; row_count reports how many data rows are in the CSV.

Updates fields in the specified link. To redirect the link (i.e. to update the Long URL), use the long_url parameter. This will always charge an encode limit.

Bulk update can add or remove tags or archive up to 100 links at a time; The response includes a list of bitlink ids that were updated.

Updates a campaign's details.

Updates an existing channel.

Move a keyword (or custom back-half) to a different Bitlink (domains must match).

Updates the details of a group.

Updates preferences for a group.

Updates the QR code with a matching id and returns it.

Update fields in the user

Update a webhook

Sends ping event to test webhook configuration.