BitlyIP (Independent Publisher)

Reference

Bitly is the most widely trusted link management platform in the world. By using the Bitly API, you will exercise the full power of your links through automated link customization, mobile deep linking, and click analytics.

This connector is available in the following products and regions:

Service	Class	Regions
Logic Apps	Standard	All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD)
Power Automate	Premium	All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)
Power Apps	Premium	All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD)

Contact
Name	Troy Taylor
URL	https://www.hitachisolutions.com
Email	ttaylor@hitachisolutions.com

Connector Metadata
Publisher	Troy Taylor
Website	https://bitly.com/
Privacy policy	https://bitly.com/pages/privacy
Categories	Social Media;Website

Creating a connection

The connector supports the following authentication types:


Default	Parameters for creating connection.	All regions	Not shareable

Default

Applicable: All regions

Parameters for creating connection.

This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.

Name	Type	Description	Required
API Key	securestring	The API Key for this api	True

Throttling Limits

Name	Calls	Renewal Period
API calls per connection	100	60 seconds

Actions

Add custom Bitlink	Add a keyword (or custom back-half) to a Bitlink with a Custom Domain. This endpoint can also be used for initial redirects to a link.
Bulk add Bitlinks to channels	Bulk add Bitlinks to multiple campaign channels
Create Bitlink	Converts a long URL to a Bitlink.
Create campaign	Creates a new campaign.
Create channel	Creates a new channel.
Create full Bitlink	Converts a long URL to a Bitlink and sets additional parameters.
Create webhook	Creates a webhook.
Delete webhook	Deletes a webhook.
Expand Bitlink	Returns the short link and long URL for the specified link.
Get Bitlink	Returns information for the specified link.
Get Bitlink QR code	Generates a QR code for a Bitlink.
Get Bitlinks by group	Returns a paginated collection of Bitlinks for a group.
Get BSDs	Fetch all Branded Short Domains.
Get campaign	Returns details for a campaign.
Get campaigns	Returns the campaigns for the current authenticated user.
Get channel	Returns a channel's details.
Get channels	Returns the channels available to a user.
Get clicks for Bitlink	Returns the click counts for the specified link in an array based on a date.
Get clicks for custom Bitlink	Returns the click counts for the specified link. This returns an array with clicks based on a date.
Get clicks summary for Bitlink	Returns the click counts for the specified link rolled up into a single field.
Get custom Bitlink	Returns the details and history of the specified link.
Get custom Bitlink metrics by destination	Returns click metrics for the specified link by its historical destinations.
Get custom Bitlinks for BSDs	Gets custom Bitlinks for an organization filtered by BSD(s).
Get group	Returns details for a group.
Get group clicks	Get number of clicks on Bitlinks in a group.
Get group metrics by cities	Returns the geographic origins of click traffic by city for the specified group.
Get group metrics by countries	Returns the geographic origins of click traffic by country for the specified group.
Get group metrics by devices	Returns the device types generating click traffic to the specified group's links.
Get group metrics by referring networks	Returns metrics by referring networks for the specified group's links.
Get group preferences	Returns preferences for the specified group.
Get group shorten counts	Returns all the shorten counts for a group.
Get group tags	Returns the tags currently used in the specified group. Maximum 1000.
Get groups	Returns a list of groups in the organization.
Get metrics for Bitlink by cities	Returns the city origins of click traffic for the specified link.
Get metrics for Bitlink by countries	Returns the country origins of click traffic for the specified link.
Get metrics for Bitlink by devices	Returns the device types generating click traffic to the specified link.
Get metrics for Bitlink by referrers	Returns referrer click counts for the specified link.
Get metrics for Bitlink by referrers by domains	Returns click metrics grouped by referrers for the specified link.
Get metrics for Bitlink by referring domains	Returns the referring domain click counts for the specified link.
Get OAuth App	Retrieve the details for the provided OAuth App client ID.
Get organization	Retrieve details for the specified organization.
Get organization shorten counts	Returns the shorten counts for a specific organization over a specified time period.
Get organizations	Retrieve a list of organizations.
Get plan limits	Returns all plan limits and counts available for an organization.
Get platform limits	Fetch all platform limits and counts available for an organization
Get sorted Bitlinks	Returns a list of Bitlinks sorted by group.
Get user	Returns information for the current authenticated user.
Get webhook	Returns a webhook.
Get webhooks	Fetch all webhooks available for an Organization
Update Bitlink	Updates fields in the specified link.
Update Bitlinks by group	Bulk update can add or remove tags or archive up to 100 links at a time; The response includes a a list of Bitlink ids that were updated.
Update campaign	Updates a campaign's details.
Update channel	Updates an existing channel.
Update custom Bitlink	Move a keyword (or custom back-half) to a different Bitlink.
Update group	Updates the details of a group.
Update group preferences	Updates preferences for a group.
Update user	Update fields in the user
Update webhook	Update a webhook
Verify webhook	Sends ping event to test webhook configuration.

Add custom Bitlink

Operation ID:: AddCustomBitlink

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

Parameters

Name	Key	Required	Type	Description
bitlink_id	bitlink_id		string
custom_bitlink	custom_bitlink		string

Returns

CustomBitlink: CustomBitlink

Bulk add Bitlinks to channels

Operation ID:: BulkAdd

Bulk add Bitlinks to multiple campaign channels

Parameters

Name	Key	Required	Type	Description
Campaign GUID	campaign_guid	True	string	A GUID for a Bitly campaign
Content-Type	Content-Type		string	The type of content.
File	file		file	The file.

Returns

BulkAddResponse: BulkAddResponse

Create Bitlink

Operation ID:: CreateBitlink

Converts a long URL to a Bitlink.

Parameters

Name	Key	Required	Type
group_guid	group_guid		string
domain	domain		string
long_url	long_url	True	string

Returns

ShortenBitlinkBody: ShortenBitlinkBody

Create campaign

Operation ID:: CreateCampaign

Creates a new campaign.

Parameters

Name	Key	Type
group_guid	group_guid	string
channel_guids	channel_guids	array of string
description	description	string
name	name	string

Returns

Campaign: Campaign

Create channel

Operation ID:: CreateChannel

Creates a new channel.

Parameters

Name	Key	Type	Description
group_guid	group_guid	string
guid	guid	string
name	name	string
modified	modified	string	ISO_TIMESTAMP
created	created	string	ISO TIMESTAMP
campaign_guid	campaign_guid	string
bitlink_id	bitlink_id	string

Returns

Channel: Channel

Create full Bitlink

Operation ID:: CreateFullBitlink

Converts a long URL to a Bitlink and sets additional parameters.

Parameters

Name	Key	Required	Type	Description
domain	domain		string
title	title		string
group_guid	group_guid		string	Always include a specific group and custom domain in your shorten calls.
tags	tags		array of string
app_uri_path	app_uri_path		string
install_type	install_type		string
install_url	install_url		string
app_id	app_id		string
long_url	long_url	True	string

Returns

BitlinkBody: BitlinkBody

Create webhook

Operation ID:: CreateWebhook

Creates a webhook.

Parameters

Name	Key	Required	Type
name	name	True	string
url	url	True	string
group_guid	group_guid		string
fetch_tags	fetch_tags		boolean
is_active	is_active		boolean
organization_guid	organization_guid	True	string
client_id	client_id		string
client_secret	client_secret		string
oauth_url	oauth_url		string
event	event	True	string

Returns

Webhook: Webhook

Delete webhook

Operation ID:: DeleteWebhook

Deletes a webhook.

Parameters

Name	Key	Required	Type	Description
Webhook GUID	webhook_guid	True	string	A GUID for a Bitly webhook

Expand Bitlink

Operation ID:: ExpandBitlink

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

Parameters

Name	Key	Required	Type	Description
bitlink_id	bitlink_id		string

Returns

ExpandedBitlink: ExpandedBitlink

Get Bitlink

Operation ID:: GetBitlink

Returns information for the specified link.

Parameters

Name	Key	Required	Type	Description
Bitlink	bitlink	True	string	A Bitlink made of the domain and hash

Returns

BitlinkBody: BitlinkBody

Get Bitlink QR code

Operation ID:: GetBitlinkQRCode

Generates a QR code for a Bitlink.

Parameters

Name	Key	Required	Type	Description
Bitlink	bitlink	True	string	A Bitlink made of the domain and hash
Color	color		string	A color denoted in hexidecimal RGB format
Exclude Bitly Logo	exclude_bitly_logo		boolean	Removes the Bitly logo from the center of the generated QR image
Image Format	image_format		string	Determines the image format of the returned QR code

Returns

BitlinkQR: BitlinkQR

Get Bitlinks by group

Operation ID:: GetBitlinksByGroup

Returns a paginated collection of Bitlinks for a group.

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group
Size	size		integer	The quantity of items to be be returned
Page	page		integer	Integer specifying the numbered result at which to start
Keyword	keyword		string	Custom keyword to filter on history entries
Query	query		string	The value that you would like to search
Created Before	created_before		integer	Timestamp as an integer unix epoch
Created After	created_after		integer	Timestamp as an integer unix epoch
Modified After	modified_after		integer	Timestamp as an integer unix epoch
Archived	archived		string	Whether or not to include archived bitlinks
Deeplinks	deeplinks		string	Filter to only Bitlinks that contain deeplinks
Domain Deeplinks	domain_deeplinks		string	Filter to only Bitlinks that contain deeplinks configured with a custom domain
Campaign GUID	campaign_guid		string	Filter to return only links for the given campaign GUID, can be provided
Channel GUILD	channel_guid		string	Filter to return only links for the given channel GUID, can be provided, overrides all other parameters
Custom Bitlink	custom_bitlink		string	A Custom Bitlink made of the domain and keyword
Tags	tags		array	filter by given tags
Launchpad IDs	launchpad_ids		array	filter by launchpad id
Encoding Login	encoding_login		array	Filter by the login of the authenticated user that created the Bitlink

Returns

Bitlinks: Bitlinks

Get BSDs

Operation ID:: GetBSDs

Fetch all Branded Short Domains.

Returns

BSDsResponse: BSDsResponse

Get campaign

Operation ID:: GetCampaign

Returns details for a campaign.

Parameters

Name	Key	Required	Type	Description
Campaign GUID	campaign_guid	True	string	A GUID for a Bitly campaign

Returns

Campaign: Campaign

Get campaigns

Operation ID:: GetCampaigns

Returns the campaigns for the current authenticated user.

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid		string	A GUID for a Bitly group

Returns

Campaigns: Campaigns

Get channel

Operation ID:: GetChannel

Returns a channel's details.

Parameters

Name	Key	Required	Type	Description
Channel GUID	channel_guid	True	string	A GUID for a Bitly Channel

Returns

Channel: Channel

Get channels

Operation ID:: GetChannels

Returns the channels available to a user.

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid		string	A GUID for a Bitly group
Campaign GUID	campaign_guid		string	A GUID for a Bitly campaign

Returns

Channels: Channels

Get clicks for Bitlink

Operation ID:: GetClicksForBitlink

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

Parameters

Name	Key	Required	Type	Description
Bitlink	bitlink	True	string	A Bitlink made of the domain and hash
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

Clicks: Clicks

Get clicks for custom Bitlink

Operation ID:: GetClicksForCustomBitlink

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

Parameters

Name	Key	Required	Type	Description
Custom Bitlink	custom_bitlink	True	string	A Custom Bitlink made of the domain and keyword
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

Clicks: Clicks

Get clicks summary for Bitlink

Operation ID:: GetClicksSummaryForBitlink

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

Parameters

Name	Key	Required	Type	Description
Bitlink	bitlink	True	string	A Bitlink made of the domain and hash
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

ClicksSummary: ClicksSummary

Get custom Bitlink

Operation ID:: GetCustomBitlink

Returns the details and history of the specified link.

Parameters

Name	Key	Required	Type	Description
Custom Bitlink	custom_bitlink	True	string	A Custom Bitlink made of the domain and keyword

Returns

CustomBitlink: CustomBitlink

Get custom Bitlink metrics by destination

Operation ID:: GetCustomBitlinkMetricsByDestination

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

Parameters

Name	Key	Required	Type	Description
Custom Bitlink	custom_bitlink	True	string	A Custom Bitlink made of the domain and keyword
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

ClickMetrics: ClickMetrics

Get custom Bitlinks for BSDs

Operation ID:: GetCustomBitlinksForBSDs

Gets custom Bitlinks for an organization filtered by BSD(s).

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group
Created After	created_after		integer	Timestamp as an integer unix epoch
Limit	limit		integer	limit the amount of results returned
Offset	offset		integer	set the starting index of the result set
BSD	bsd		array	a branded short domains to filter results

Returns

BitlinkOverridesData: BitlinkOverridesData

Get group

Operation ID:: GetGroup

Returns details for a group.

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group

Returns

Group: Group

Get group clicks

Operation ID:: GetGroupClicks

Get number of clicks on Bitlinks in a group.

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

GroupClicks: GroupClicks

Get group metrics by cities

Operation ID:: GetGroupMetricsByCities

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

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Size	size		integer	The quantity of items to be be returned
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

CityMetrics: CityMetrics

Get group metrics by countries

Operation ID:: GetGroupMetricsByCountries

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

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Size	size		integer	The quantity of items to be be returned
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

ClickMetrics: ClickMetrics

Get group metrics by devices

Operation ID:: GetGroupMetricsByDevices

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

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Size	size		integer	The quantity of items to be be returned
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

DeviceMetrics: DeviceMetrics

Get group metrics by referring networks

Operation ID:: GetGroupMetricsByReferringNetworks

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

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group

Returns

ClickMetrics: ClickMetrics

Get group preferences

Operation ID:: GetGroupPreferences

Returns preferences for the specified group.

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group

Returns

GroupPreferences: GroupPreferences

Get group shorten counts

Operation ID:: GetGroupShortenCounts

Returns all the shorten counts for a group.

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

Metrics: Metrics

Get group tags

Operation ID:: GetGroupTags

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

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group

Returns

Tags: Tags

Get groups

Operation ID:: GetGroups

Returns a list of groups in the organization.

Parameters

Name	Key	Required	Type	Description
Organization GUID	organization_guid		string	A GUID for a Bitly organization

Returns

Groups: Groups

Get metrics for Bitlink by cities

Operation ID:: GetMetricsForBitlinkByCities

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

Parameters

Name	Key	Required	Type	Description
Bitlink	bitlink	True	string	A Bitlink made of the domain and hash
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Size	size		integer	The quantity of items to be be returned
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

CityMetrics: CityMetrics

Get metrics for Bitlink by countries

Operation ID:: GetMetricsForBitlinkByCountries

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

Parameters

Name	Key	Required	Type	Description
Bitlink	bitlink	True	string	A Bitlink made of the domain and hash
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Size	size		integer	The quantity of items to be be returned
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

ClickMetrics: ClickMetrics

Get metrics for Bitlink by devices

Operation ID:: GetMetricsForBitlinkByDevices

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

Parameters

Name	Key	Required	Type	Description
Bitlink	bitlink	True	string	A Bitlink made of the domain and hash
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Size	size		integer	The quantity of items to be be returned
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

DeviceMetrics: DeviceMetrics

Get metrics for Bitlink by referrers

Operation ID:: GetMetricsForBitlinkByReferrers

Returns referrer click counts for the specified link.

Parameters

Name	Key	Required	Type	Description
Bitlink	bitlink	True	string	A Bitlink made of the domain and hash
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Size	size		integer	The quantity of items to be be returned
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

ClickMetrics: ClickMetrics

Get metrics for Bitlink by referrers by domains

Operation ID:: GetMetricsForBitlinkByReferrersByDomains

Returns click metrics grouped by referrers for the specified link.

Parameters

Name	Key	Required	Type	Description
Bitlink	bitlink	True	string	A Bitlink made of the domain and hash
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Size	size		integer	The quantity of items to be be returned
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

ReferrersByDomains: ReferrersByDomains

Get metrics for Bitlink by referring domains

Operation ID:: GetMetricsForBitlinkByReferringDomains

Returns the referring domain click counts for the specified link.

Parameters

Name	Key	Required	Type	Description
Bitlink	bitlink	True	string	A Bitlink made of the domain and hash
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Size	size		integer	The quantity of items to be be returned
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

ClickMetrics: ClickMetrics

Get OAuth App

Operation ID:: GetOAuthApp

Retrieve the details for the provided OAuth App client ID.

Parameters

Name	Key	Required	Type	Description
Click ID	client_id	True	string	The client ID of an OAuth app

Returns

OAuthApp: OAuthApp

Get organization

Operation ID:: GetOrganization

Retrieve details for the specified organization.

Parameters

Name	Key	Required	Type	Description
Organization GUID	organization_guid	True	string	A GUID for a Bitly organization

Returns

Organization: Organization

Get organization shorten counts

Operation ID:: GetOrganizationShortenCounts

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

Parameters

Name	Key	Required	Type	Description
Organization GUID	organization_guid	True	string	A GUID for a Bitly organization
Unit	unit	True	string	A unit of time
Units	units	True	integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.

Returns

Metrics: Metrics

Get organizations

Operation ID:: GetOrganizations

Retrieve a list of organizations.

Returns

Organizations: Organizations

Get plan limits

Operation ID:: GetPlanLimits

Returns all plan limits and counts available for an organization.

Parameters

Name	Key	Required	Type	Description
Organization GUID	organization_guid	True	string	A GUID for a Bitly organization

Returns

PlanLimits: PlanLimits

Get platform limits

Operation ID:: GetPlatformLimits

Fetch all platform limits and counts available for an organization

Parameters

Name	Key	Required	Type	Description
Path	path		string	The specific path for which information is requested

Returns

PlatformLimits: PlatformLimits

Get sorted Bitlinks

Operation ID:: GetSortedBitlinks

Returns a list of Bitlinks sorted by group.

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group
Sort	sort	True	string	The type of sorting that you would like to do
Unit	unit		string	A unit of time
Units	units		integer	An integer representing the time units to query data for. pass -1 to return all units of time.
Unit Reference	unit_reference		string	An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Size	size		integer	The quantity of items to be be returned

Returns

SortedLinks: SortedLinks

Get user

Operation ID:: GetUser

Returns information for the current authenticated user.

Returns

User: User

Get webhook

Operation ID:: GetWebhook

Returns a webhook.

Parameters

Name	Key	Required	Type	Description
Webhook GUID	webhook_guid	True	string	A GUID for a Bitly webhook

Returns

Webhook: Webhook

Get webhooks

Operation ID:: GetWebhooks

Fetch all webhooks available for an Organization

Parameters

Name	Key	Required	Type	Description
Organization GUID	organization_guid	True	string	A GUID for a Bitly organization

Returns

Webhooks: Webhooks

Update Bitlink

Operation ID:: UpdateBitlink

Updates fields in the specified link.

Parameters

Name	Key	Required	Type	Description
Bitlink	bitlink	True	string	A Bitlink made of the domain and hash
references	references		object
archived	archived		boolean
tags	tags		array of string
created_at	created_at		string
title	title		string
bitlink	bitlink		string
install_url	install_url		string
created	created		string	ISO timestamp
app_uri_path	app_uri_path		string
modified	modified		string	ISO timestamp
install_type	install_type		string
app_guid	app_guid		string
guid	guid		string
os	os		string
brand_guid	brand_guid		string
created_by	created_by		string
long_url	long_url		string
client_id	client_id		string
custom_bitlinks	custom_bitlinks		array of string
link	link		string
launchpad_ids	launchpad_ids		array of string
id	id		string

Returns

BitlinkBody: BitlinkBody

Update Bitlinks by group

Operation ID:: UpdateBitlinksByGroup

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

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group
Action	action		string
remove_tags	remove_tags		array of string
archive	archive		boolean
links	links		array of string	This is limited to 100 Bitlink ids
add_tags	add_tags		array of string

Returns

BulkUpdate: BulkUpdate

Update campaign

Operation ID:: UpdateCampaign

Updates a campaign's details.

Parameters

Name	Key	Required	Type	Description
Campaign GUID	campaign_guid	True	string	A GUID for a Bitly campaign
group_guid	group_guid		string
channel_guids	channel_guids		array of string
description	description		string
name	name		string

Returns

Campaign: Campaign

Update channel

Operation ID:: UpdateChannel

Updates an existing channel.

Parameters

Name	Key	Required	Type	Description
Channel GUID	channel_guid	True	string	A GUID for a Bitly Channel
group_guid	group_guid		string
guid	guid		string
name	name		string
modified	modified		string	ISO_TIMESTAMP
created	created		string	ISO TIMESTAMP
campaign_guid	campaign_guid		string
bitlink_id	bitlink_id		string

Returns

Channel: Channel

Update custom Bitlink

Operation ID:: UpdateCustomBitlink

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

Parameters

Name	Key	Required	Type	Description
Custom Bitlink	custom_bitlink	True	string	A Custom Bitlink made of the domain and keyword
bitlink_id	bitlink_id		string

Returns

CustomBitlink: CustomBitlink

Update group

Operation ID:: UpdateGroup

Updates the details of a group.

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group
bsds	bsds		array of string
name	name		string
organization_guid	organization_guid		string

Returns

Group: Group

Update group preferences

Operation ID:: UpdateGroupPreferences

Updates preferences for a group.

Parameters

Name	Key	Required	Type	Description
Group GUID	group_guid	True	string	A GUID for a Bitly group
group_guid	group_guid		string
domain_preference	domain_preference		string

Returns

GroupPreferences: GroupPreferences

Update user

Operation ID:: UpdateUser

Update fields in the user

Parameters

Name	Key	Required	Type	Description
default_group_guid	default_group_guid		string
name	name		string

Returns

User: User

Update webhook

Operation ID:: UpdateWebhook

Update a webhook

Parameters

Name	Key	Required	Type	Description
Webhook GUID	webhook_guid	True	string	A GUID for a Bitly webhook
name	name		string
url	url		string
group_guid	group_guid		string
fetch_tags	fetch_tags		boolean
is_active	is_active		boolean
organization_guid	organization_guid		string
client_id	client_id		string
client_secret	client_secret		string
oauth_url	oauth_url		string
guid	guid	True	string
event	event		string

Returns

Webhook: Webhook

Verify webhook

Operation ID:: VerifyWebhook

Sends ping event to test webhook configuration.

Parameters

Name	Key	Required	Type	Description
Webhook GUID	webhook_guid	True	string	A GUID for a Bitly webhook

Returns

Webhook: Webhook

Definitions

Organization

Name	Path	Type
references	references	object
name	name	string
bsds	bsds	array of string
created	created	string
is_active	is_active	boolean
modified	modified	string
tier_display_name	tier_display_name	string
tier_family	tier_family	string
tier	tier	string
role	role	string
guid	guid	string

Clicks

Name	Path	Type
units	units	integer
unit_reference	unit_reference	string
Unit	unit	Unit
link_clicks	link_clicks	array of LinkClicks

CustomBitlinkHistory

Name	Path	Type
hash	hash	string
uuid	uuid	string
keyword	keyword	string
created	created	string
group_guid	group_guid	string
first_created	first_created	string
is_active	is_active	boolean
long_url	long_url	string
deactivated	deactivated	string
bsd	bsd	string
login	login	string

OtherMetrics

Name	Path	Type	Description
other_city_clicks	other_city_clicks	integer
no_city_clicks	no_city_clicks	integer

Webhooks

Name	Path	Type	Description
webhooks	webhooks	array of Webhook

Organizations

Name	Path	Type	Description
organizations	organizations	array of Organization

LinkClicks

Name	Path	Type	Description
date	date	string
clicks	clicks	integer

PlanLimit

Name	Path	Type
count	count	integer
limit	limit	integer
name	name	string
description	description	string

DeeplinkRule

Name	Path	Type	Description
bitlink	bitlink	string
install_url	install_url	string
created	created	string	ISO timestamp
app_uri_path	app_uri_path	string
modified	modified	string	ISO timestamp
install_type	install_type	string
app_guid	app_guid	string
guid	guid	string
os	os	string
brand_guid	brand_guid	string

Campaign

Name	Path	Type	Description
references	references	object
name	name	string
created	created	string	ISO timestamp
group_guid	group_guid	string
modified	modified	string	ISO timestamp
created_by	created_by	string
guid	guid	string
description	description	string

OAuthApp

Name	Path	Type
link	link	string
name	name	string
client_id	client_id	string
description	description	string

Channels

Name	Path	Type	Description
channels	channels	array of Channel

PlatformLimits

Name	Path	Type	Description
platform_limits	platform_limits	array of PlatformLimit

Pagination

Name	Path	Type
total	total	integer
size	size	integer
prev	prev	string
page	page	integer
next	next	string

BSDsResponse

Name	Path	Type	Description
bsds	bsds	array of string

GroupPreferences

Name	Path	Type	Description
group_guid	group_guid	string
domain_preference	domain_preference	string

ClicksSummary

Name	Path	Type
units	units	integer
Unit	unit	Unit
total_clicks	total_clicks	integer
unit_reference	unit_reference	string

Email

Name	Path	Type
is_primary	is_primary	boolean
is_verified	is_verified	boolean
email	email	string

Campaigns

Name	Path	Type	Description
campaigns	campaigns	array of Campaign

ExpandedBitlink

Name	Path	Type
long_url	long_url	string
created_at	created_at	string
link	link	string
id	id	string

CustomBitlink

Name	Path	Type
BitlinkBody	bitlink	BitlinkBody
bitlink_history	bitlink_history	array of CustomBitlinkHistory
custom_bitlink	custom_bitlink	string

SortedLinks

Name	Path	Type	Description
sorted_links	sorted_links	array of ClickLink
links	links	array of BitlinkBody

ClickLink

Name	Path	Type	Description
clicks	clicks	integer
id	id	string

PlatformLimit

Name	Path	Type	Description
endpoint	endpoint	string
methods	methods	array of MethodLimit

Metric

Name	Path	Type	Description
value	value	integer
key	key	string

BitlinkOverridesData

Name	Path	Type	Description
total_count	total_count	integer
overrides	overrides	array of BitlinkOverrides

ReferrersByDomains

Name	Path	Type
units	units	integer
Facet2	facet	Facet2
referrers_by_domain	referrers_by_domain	array of ReferrersByDomain
unit_reference	unit_reference	string
unit	unit	string

CityMetric

Name	Path	Type
city	city	string
region	region	string
subregion	subregion	string
clicks	clicks	integer
country	country	string

Group

Name	Path	Type
references	references	object
name	name	string
bsds	bsds	array of string
created	created	string
is_active	is_active	boolean
modified	modified	string
organization_guid	organization_guid	string
role	role	string
guid	guid	string

ShortenBitlinkBody

Name	Path	Type
references	references	object
archived	archived	boolean
tags	tags	array of string
created_at	created_at	string
deeplinks	deeplinks	array of DeeplinkRule
long_url	long_url	string
custom_bitlinks	custom_bitlinks	array of string
link	link	string
id	id	string

Bitlinks

Name	Path	Type	Description
Pagination	pagination	Pagination
links	links	array of BitlinkBody

Webhook

Name	Path	Type
references	references	object
status	status	string
modified_by	modified_by	string
name	name	string
created	created	string
url	url	string
deactivated	deactivated	string
fetch_tags	fetch_tags	boolean
is_active	is_active	boolean
modified	modified	string
organization_guid	organization_guid	string
client_id	client_id	string
group_guid	group_guid	string
client_secret	client_secret	string
oauth_url	oauth_url	string
guid	guid	string
event	event	string

GroupClicks

Name	Path	Type
units	units	integer
data	data	array of CountItem
unit_reference	unit_reference	string
unit	unit	string

Groups

Name	Path	Type	Description
groups	groups	array of Group

User

Name	Path	Type
default_group_guid	default_group_guid	string
name	name	string
created	created	string
is_active	is_active	boolean
modified	modified	string
is_sso_user	is_sso_user	boolean
is_2fa_enabled	is_2fa_enabled	boolean
login	login	string
emails	emails	array of Email

BulkAddResponse

Name	Path	Type	Description
message	message	string
Data1	data	Data1

BitlinkQR

Name	Path	Type	Description
qr_code	qr_code	string	Data URI of QR Code image
link	link	string
id	id	string

CityMetrics

Name	Path	Type
units	units	integer
Facet1	facet	Facet1
unit_reference	unit_reference	string
unit	unit	string
metrics	metrics	array of CityMetric
OtherMetrics	other_metrics	OtherMetrics

BulkUpdate

Name	Path	Type	Description
links	links	array of string

MethodLimit

Name	Path	Type
count	count	integer
limit	limit	integer
name	name	string

DeviceMetrics

Name	Path	Type
units	units	integer
Facet1	facet	Facet1
unit_reference	unit_reference	string
unit	unit	string
metrics	metrics	array of DeviceMetric

BitlinkBody

Name	Path	Type
references	references	object
archived	archived	boolean
tags	tags	array of string
created_at	created_at	string
title	title	string
deeplinks	deeplinks	array of DeeplinkRule
created_by	created_by	string
long_url	long_url	string
client_id	client_id	string
custom_bitlinks	custom_bitlinks	array of string
link	link	string
launchpad_ids	launchpad_ids	array of string
id	id	string

ClickMetrics

Name	Path	Type
units	units	integer
Facet1	facet	Facet1
unit_reference	unit_reference	string
unit	unit	string
metrics	metrics	array of ClickMetric

Channel

Name	Path	Type	Description
group_guid	group_guid	string
guid	guid	string
name	name	string
modified	modified	string	ISO_TIMESTAMP
created	created	string	ISO TIMESTAMP
references	references	object

DeviceMetric

Name	Path	Type	Description
clicks	clicks	integer
device_type	device_type	string

Metrics

Name	Path	Type
units	units	integer
Facet1	facet	Facet1
unit_reference	unit_reference	string
unit	unit	string
metrics	metrics	array of Metric

ClickMetric

Name	Path	Type	Description
clicks	clicks	integer
value	value	string

CountItem

Name	Path	Type	Description
count	count	integer
ts	ts	string

ReferrersByDomain

Name	Path	Type	Description
referrers	referrers	array of Metric
network	network	string

PlanLimits

Name	Path	Type
references	references	object
organization_guid	organization_guid	string
plan_limits	plan_limits	array of PlanLimit

BitlinkOverrides

Name	Path	Type	Description
references	references	object
created	created	string
rules	rules	string
group_guid	group_guid	string
modified	modified	string
version	version	integer
link	link	string	The fully qualified URL to the Override which is the Bitly link to use. Ex: https://foo.com/bar
id	id	string

Data1

Name	Path	Type
link_save_failures	link_save_failures	integer
keyword_failures	keyword_failures	integer
results	results	array of string
successes	successes	integer
channel_bitlink_failures	channel_bitlink_failures	integer
csv_format_failures	csv_format_failures	integer

Facet1

Facet1: string

Facet2

Facet2: string

Unit

Unit: string