bitly
Module bitly
API
Definitions
![](https://bcentral-dev-packageicons.azureedge.net/images/ballerinax_bitly_1.5.1.png)
ballerinax/bitly Ballerina library
Overview
This is a generated connector for Bitly API v4.0.0 OpenAPI specification. 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. Bitlinks are shortened links. They could begin with the bit.ly domain or your own custom branded short domain (BSD).
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Bitly Devoloper account
- Obtain tokens by following this guide
Clients![](/images/permalink.svg)
bitly: Client![](/images/permalink.svg)
This is a generated connector for Bitly API v4.0.0 OpenAPI specification. 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.
Constructor![](/images/permalink.svg)
Gets invoked to initialize the connector
.
The connector initialization requires setting the API credentials.
Create a Bitly account and obtain tokens by following this guide.
init (ConnectionConfig config, string serviceUrl)
- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://api-ssl.bitly.com/v4" - URL of the target service
getGroupMetricsByReferringNetworks![](/images/permalink.svg)
function getGroupMetricsByReferringNetworks(string groupGuid) returns ClickMetrics|error
Get Click Metrics for a Group by Referring Networks
Parameters
- groupGuid string - A GUID for a Bitly group
Return Type
- ClickMetrics|error - SUCCESS
getMetricsForBitlinkByCountries![](/images/permalink.svg)
function getMetricsForBitlinkByCountries(string bitlink, TimeUnit unit, int units, int size, string? unitReference) returns ClickMetrics|error
Get Metrics for a Bitlink by Country
Parameters
- bitlink string - A Bitlink made of the domain and hash
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- size int (default 50) - The quantity of items to be be returned
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Return Type
- ClickMetrics|error - SUCCESS
getGroupTags![](/images/permalink.svg)
Retrieve Tags by Group
Parameters
- groupGuid string - A GUID for a Bitly group
getGroupClicks![](/images/permalink.svg)
function getGroupClicks(string groupGuid, TimeUnit unit, int units, string? unitReference) returns GroupClicks|error
Get clicks by group
Parameters
- groupGuid string - A GUID for a Bitly group
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Return Type
- GroupClicks|error - SUCCESS
getWebhook![](/images/permalink.svg)
Retrieve Webhook
Parameters
- webhookGuid string - A GUID for a Bitly webhook
deleteWebhook![](/images/permalink.svg)
Delete Webhook
Parameters
- webhookGuid string - A GUID for a Bitly webhook
updateWebhook![](/images/permalink.svg)
function updateWebhook(string webhookGuid, WebhookUpdate payload) returns Webhook|error
Update Webhook
getOrganizationShortenCounts![](/images/permalink.svg)
function getOrganizationShortenCounts(string organizationGuid, TimeUnit unit, int units, string? unitReference) returns Metrics|error
Get Shorten Counts for an Organization
Parameters
- organizationGuid string - A GUID for a Bitly organization
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
expandBitlink![](/images/permalink.svg)
function expandBitlink(ExpandBitlink payload) returns ExpandedBitlink|error
Expand a Bitlink
Parameters
- payload ExpandBitlink -
Return Type
- ExpandedBitlink|error - SUCCESS
getOrganization![](/images/permalink.svg)
function getOrganization(string organizationGuid) returns Organization|error
Retrieve an Organization
Parameters
- organizationGuid string - A GUID for a Bitly organization
Return Type
- Organization|error - SUCCESS
getGroupMetricsByDevices![](/images/permalink.svg)
function getGroupMetricsByDevices(string groupGuid, TimeUnit unit, int units, int size, string? unitReference) returns DeviceMetrics|error
Get Click Metrics for a Group by Device Type
Parameters
- groupGuid string - A GUID for a Bitly group
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- size int (default 50) - The quantity of items to be be returned
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Return Type
- DeviceMetrics|error - SUCCESS
getGroupMetricsByCountries![](/images/permalink.svg)
function getGroupMetricsByCountries(string groupGuid, TimeUnit unit, int units, int size, string? unitReference) returns ClickMetrics|error
Get Click Metrics for a Group by Country
Parameters
- groupGuid string - A GUID for a Bitly group
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- size int (default 50) - The quantity of items to be be returned
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Return Type
- ClickMetrics|error - SUCCESS
getClicksSummaryForBitlink![](/images/permalink.svg)
function getClicksSummaryForBitlink(string bitlink, TimeUnit unit, int units, string? unitReference) returns ClicksSummary|error
Get a Clicks Summary for a Bitlink
Parameters
- bitlink string - A Bitlink made of the domain and hash
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Return Type
- ClicksSummary|error - SUCCESS
getCustomBitlinkMetricsByDestination![](/images/permalink.svg)
function getCustomBitlinkMetricsByDestination(string customBitlink, TimeUnit unit, int units, string? unitReference) returns ClickMetrics|error
Get Metrics for a Custom Bitlink by Destination
Parameters
- customBitlink string - A Custom Bitlink made of the domain and keyword
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Return Type
- ClickMetrics|error - SUCCESS
getBitlink![](/images/permalink.svg)
function getBitlink(string bitlink) returns BitlinkBody|error
Retrieve a Bitlink
Parameters
- bitlink string - A Bitlink made of the domain and hash
Return Type
- BitlinkBody|error - SUCCESS
updateBitlink![](/images/permalink.svg)
function updateBitlink(string bitlink, BitlinkBody payload) returns BitlinkBody|error
Update a Bitlink
Return Type
- BitlinkBody|error - SUCCESS
getCampaign![](/images/permalink.svg)
Retrieve a Campaign
Parameters
- campaignGuid string - A GUID for a Bitly campaign
updateCampaign![](/images/permalink.svg)
function updateCampaign(string campaignGuid, CampaignModify payload) returns Campaign|error
Update Campaign
getClicksForCustomBitlink![](/images/permalink.svg)
function getClicksForCustomBitlink(string customBitlink, TimeUnit unit, int units, string? unitReference) returns Clicks|error
Get Clicks for a Custom Bitlink's Entire History
Parameters
- customBitlink string - A Custom Bitlink made of the domain and keyword
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
getMetricsForBitlinkByReferringDomains![](/images/permalink.svg)
function getMetricsForBitlinkByReferringDomains(string bitlink, TimeUnit unit, int units, int size, string? unitReference) returns ClickMetrics|error
Get Metrics for a Bitlink by Referring Domains
Parameters
- bitlink string - A Bitlink made of the domain and hash
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- size int (default 50) - The quantity of items to be be returned
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Return Type
- ClickMetrics|error - SUCCESS
getGroup![](/images/permalink.svg)
Retrieve a Group
Parameters
- groupGuid string - A GUID for a Bitly group
updateGroup![](/images/permalink.svg)
function updateGroup(string groupGuid, GroupUpdate payload) returns Group|error
Update a Group
getBitlinkQRCode![](/images/permalink.svg)
function getBitlinkQRCode(string bitlink, string? color, boolean? excludeBitlyLogo, string imageFormat) returns BitlinkQR|error
Get a QR Code
Parameters
- bitlink string - A Bitlink made of the domain and hash
- color string? (default ()) - A color denoted in hexidecimal RGB format
- excludeBitlyLogo boolean? (default ()) - Removes the Bitly logo from the center of the generated QR image
- imageFormat string (default "png") - Determines the image format of the returned QR code
getMetricsForBitlinkByCities![](/images/permalink.svg)
function getMetricsForBitlinkByCities(string bitlink, TimeUnit unit, int units, int size, string? unitReference) returns CityMetrics|error
Get Metrics for a Bitlink by City
Parameters
- bitlink string - A Bitlink made of the domain and hash
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- size int (default 50) - The quantity of items to be be returned
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Return Type
- CityMetrics|error - SUCCESS
getGroupMetricsByCities![](/images/permalink.svg)
function getGroupMetricsByCities(string groupGuid, TimeUnit unit, int units, int size, string? unitReference) returns CityMetrics|error
Get Click Metrics for a Group by City
Parameters
- groupGuid string - A GUID for a Bitly group
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- size int (default 50) - The quantity of items to be be returned
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Return Type
- CityMetrics|error - SUCCESS
getMetricsForBitlinkByDevices![](/images/permalink.svg)
function getMetricsForBitlinkByDevices(string bitlink, TimeUnit unit, int units, int size, string? unitReference) returns DeviceMetrics|error
Get Metrics for a Bitlink by Device Type
Parameters
- bitlink string - A Bitlink made of the domain and hash
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- size int (default 50) - The quantity of items to be be returned
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Return Type
- DeviceMetrics|error - SUCCESS
createWebhook![](/images/permalink.svg)
function createWebhook(WebhookCreate payload) returns Webhook|error
Create Webhook
Parameters
- payload WebhookCreate -
getPlanLimits![](/images/permalink.svg)
function getPlanLimits(string organizationGuid) returns PlanLimits|error
Get Plan Limits
Parameters
- organizationGuid string - A GUID for a Bitly organization
Return Type
- PlanLimits|error - SUCCESS
getOAuthApp![](/images/permalink.svg)
Retrieve OAuth App
Parameters
- clientId string - The client ID of an OAuth app
getChannels![](/images/permalink.svg)
Retrieve Channels
Parameters
- groupGuid string? (default ()) - A GUID for a Bitly group
- campaignGuid string? (default ()) - A GUID for a Bitly campaign
createChannel![](/images/permalink.svg)
function createChannel(ChannelModify payload) returns Channel|error
Create Channel
Parameters
- payload ChannelModify -
getCustomBitlink![](/images/permalink.svg)
function getCustomBitlink(string customBitlink) returns CustomBitlink|error
Retrieve Custom Bitlink
Parameters
- customBitlink string - A Custom Bitlink made of the domain and keyword
Return Type
- CustomBitlink|error - SUCCESS
updateCustomBitlink![](/images/permalink.svg)
function updateCustomBitlink(string customBitlink, UpdateCustomBitlink payload) returns CustomBitlink|error
Update Custom Bitlink
Parameters
- customBitlink string - A Custom Bitlink made of the domain and keyword
- payload UpdateCustomBitlink -
Return Type
- CustomBitlink|error - SUCCESS
getGroupShortenCounts![](/images/permalink.svg)
function getGroupShortenCounts(string groupGuid, TimeUnit unit, int units, string? unitReference) returns Metrics|error
Retrieve Group Shorten Counts
Parameters
- groupGuid string - A GUID for a Bitly group
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
getGroups![](/images/permalink.svg)
Retrieve Groups
Parameters
- organizationGuid string? (default ()) - A GUID for a Bitly organization
getOrganizations![](/images/permalink.svg)
function getOrganizations() returns Organizations|error
Retrieve Organizations
Return Type
- Organizations|error - SUCCESS
getMetricsForBitlinkByReferrersByDomains![](/images/permalink.svg)
function getMetricsForBitlinkByReferrersByDomains(string bitlink, TimeUnit unit, int units, int size, string? unitReference) returns ReferrersByDomains|error
Get Metrics for a Bitlink by Referrers by Domain
Parameters
- bitlink string - A Bitlink made of the domain and hash
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- size int (default 50) - The quantity of items to be be returned
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Return Type
- ReferrersByDomains|error - SUCCESS
getUser![](/images/permalink.svg)
Retrieve a User
updateUser![](/images/permalink.svg)
function updateUser(UserUpdate payload) returns User|error
Update a User
Parameters
- payload UserUpdate -
getBSDs![](/images/permalink.svg)
function getBSDs() returns BSDsResponse|error
Get BSDs
Return Type
- BSDsResponse|error - SUCCESS
getGroupPreferences![](/images/permalink.svg)
function getGroupPreferences(string groupGuid) returns GroupPreferences|error
Retrieve Group Preferences
Parameters
- groupGuid string - A GUID for a Bitly group
Return Type
- GroupPreferences|error - SUCCESS
updateGroupPreferences![](/images/permalink.svg)
function updateGroupPreferences(string groupGuid, GroupPreferences payload) returns GroupPreferences|error
Update Group Preferences
Return Type
- GroupPreferences|error - SUCCESS
getClicksForBitlink![](/images/permalink.svg)
function getClicksForBitlink(string bitlink, TimeUnit unit, int units, string? unitReference) returns Clicks|error
Get Clicks for a Bitlink
Parameters
- bitlink string - A Bitlink made of the domain and hash
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
getSortedBitlinks![](/images/permalink.svg)
function getSortedBitlinks(string groupGuid, string sort, TimeUnit? unit, int units, string? unitReference, int size) returns SortedLinks|error
Retrieve Sorted Bitlinks for Group
Parameters
- groupGuid string - A GUID for a Bitly group
- sort string - The type of sorting that you would like to do
- unit TimeUnit? (default ()) - A unit of time
- units int (default -1) - An integer representing the time units to query data for. pass -1 to return all units of time.
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
- size int (default 50) - The quantity of items to be be returned
Return Type
- SortedLinks|error - SUCCESS
createFullBitlink![](/images/permalink.svg)
function createFullBitlink(FullShorten payload) returns BitlinkBody|error
Create a Bitlink
Parameters
- payload FullShorten -
Return Type
- BitlinkBody|error - SUCCESS
addCustomBitlink![](/images/permalink.svg)
function addCustomBitlink(AddCustomBitlink payload) returns CustomBitlink|error
Add Custom Bitlink
Parameters
- payload AddCustomBitlink -
Return Type
- CustomBitlink|error - SUCCESS
getBitlinksByGroup![](/images/permalink.svg)
function getBitlinksByGroup(string groupGuid, int size, int page, string? keyword, string? query, int? createdBefore, int? createdAfter, int? modifiedAfter, string archived, string deeplinks, string domainDeeplinks, string? campaignGuid, string? channelGuid, string customBitlink, string[]? tags, string[]? launchpadIds, string[]? encodingLogin) returns Bitlinks|error
Retrieve Bitlinks by Group
Parameters
- groupGuid string - A GUID for a Bitly group
- size int (default 50) - The quantity of items to be be returned
- page int (default 1) - Integer specifying the numbered result at which to start
- keyword string? (default ()) - Custom keyword to filter on history entries
- query string? (default ()) - the value that you would like to search
- createdBefore int? (default ()) - Timestamp as an integer unix epoch
- createdAfter int? (default ()) - Timestamp as an integer unix epoch
- modifiedAfter int? (default ()) - Timestamp as an integer unix epoch
- archived string (default "off") - Whether or not to include archived bitlinks
- deeplinks string (default "both") - Filter to only Bitlinks that contain deeplinks
- domainDeeplinks string (default "both") - Filter to only Bitlinks that contain deeplinks configured with a custom domain
- campaignGuid string? (default ()) - Filter to return only links for the given campaign GUID, can be provided
- channelGuid string? (default ()) - Filter to return only links for the given channel GUID, can be provided, overrides all other parameters
- customBitlink string (default "both") -
- tags string[]? (default ()) - filter by given tags
- launchpadIds string[]? (default ()) - filter by launchpad id
- encodingLogin string[]? (default ()) - Filter by the login of the authenticated user that created the Bitlink
updateBitlinksByGroup![](/images/permalink.svg)
function updateBitlinksByGroup(string groupGuid, BulkUpdateRequest payload) returns BulkUpdate|error
Bulk update bitlinks
Return Type
- BulkUpdate|error - SUCCESS
getCampaigns![](/images/permalink.svg)
Retrieve Campaigns
Parameters
- groupGuid string? (default ()) - A GUID for a Bitly group
createCampaign![](/images/permalink.svg)
function createCampaign(CampaignModify payload) returns Campaign|error
Create Campaign
Parameters
- payload CampaignModify -
getMetricsForBitlinkByReferrers![](/images/permalink.svg)
function getMetricsForBitlinkByReferrers(string bitlink, TimeUnit unit, int units, int size, string? unitReference) returns ClickMetrics|error
Get Metrics for a Bitlink by Referrers
Parameters
- bitlink string - A Bitlink made of the domain and hash
- unit TimeUnit - A unit of time
- units int - An integer representing the time units to query data for. pass -1 to return all units of time.
- size int (default 50) - The quantity of items to be be returned
- unitReference string? (default ()) - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time.
Return Type
- ClickMetrics|error - SUCCESS
createBitlink![](/images/permalink.svg)
function createBitlink(Shorten payload) returns ShortenBitlinkBody|error
Shorten a Link
Parameters
- payload Shorten -
Return Type
- ShortenBitlinkBody|error - SUCCESS
verifyWebhook![](/images/permalink.svg)
Verify Webhook
Parameters
- webhookGuid string - A GUID for a Bitly webhook
getWebhooks![](/images/permalink.svg)
Get Webhooks
Parameters
- organizationGuid string - A GUID for a Bitly organization
getChannel![](/images/permalink.svg)
Get a Channel
Parameters
- channelGuid string - A GUID for a Bitly Channel
updateChannel![](/images/permalink.svg)
function updateChannel(string channelGuid, ChannelModify payload) returns Channel|error
Update a Channel
Records![](/images/permalink.svg)
bitly: AccessFeature![](/images/permalink.svg)
Fields
- has_access boolean -
- name string -
- created string - ISO_TIMESTAMP
- modified string - ISO_TIMESTAMP
- is_tier_default boolean -
- id string -
bitly: AccessFeatures![](/images/permalink.svg)
Fields
- access_features AccessFeature[] -
bitly: ActivityLog![](/images/permalink.svg)
Fields
- action_description string? -
- ts string? - ISO timestamp
- user string? -
- action string? -
- org_guid string? -
- ip_address string? -
- id string? -
- metadata record {}? -
bitly: ActivityLogs![](/images/permalink.svg)
Fields
- next_page string? -
- activity ActivityLog[]? -
bitly: AddCustomBitlink![](/images/permalink.svg)
Fields
- bitlink_id string? -
- custom_bitlink string? -
bitly: AppAssociationDetail![](/images/permalink.svg)
Fields
- priority int? -
- fallback boolean? -
- app_guid string? -
- os string? -
bitly: AppAssociations![](/images/permalink.svg)
Fields
- android_install_preference InstallPreference? -
- ios_install_preference InstallPreference? -
- android_apps AppAssociationDetail[]? -
- custom_domain string? -
- ios_apps AppAssociationDetail[]? -
bitly: Authorization![](/images/permalink.svg)
Fields
- app OAuthAppWithOwnerLogin? -
- id string? -
- client_id string? -
- created string? - ISO timestamp
bitly: Authorizations![](/images/permalink.svg)
Fields
- authorizations Authorization[]? -
bitly: BaseChannel![](/images/permalink.svg)
Fields
- group_guid string? -
- guid string? -
- name string? -
- modified string? - ISO_TIMESTAMP
- created string? - ISO TIMESTAMP
bitly: BaseChannelBitlink![](/images/permalink.svg)
Fields
- campaign_guid string? -
- bitlink_id string? -
bitly: BaseMetrics![](/images/permalink.svg)
Fields
- units int? -
- facet string? -
- unit_reference string? -
- unit string? -
bitly: BillingAccount![](/images/permalink.svg)
Fields
- last_four_digits string? -
- subscription_price decimal? -
- billing_info BillingInfo? -
- account_id string? -
- end_date string? - ISO timestamp
- contact_info ContactInfo? -
- account_num string? -
- card_type string? -
- subscription_status string? -
- renewal_date string? - ISO timestamp
bitly: BillingAccountID![](/images/permalink.svg)
Fields
- billing_account_id string? -
bitly: BillingAddress![](/images/permalink.svg)
Fields
- city string? -
- country string? -
- state string? -
- address_1 string? -
- address_2 string? -
- zip_code string? -
bitly: BillingContact![](/images/permalink.svg)
Fields
- first_name string? -
- last_name string? -
- description string? -
- phone string? -
- billing_contact_id string? -
- email string? -
bitly: BillingDowngrade![](/images/permalink.svg)
Fields
- group_guids string[]? -
- tier_name string? -
bitly: BillingInfo![](/images/permalink.svg)
Fields
- billing_address BillingAddress? -
- billing_contact BillingContact? -
bitly: BillingSignature![](/images/permalink.svg)
Fields
- field_account_id string? -
- iframe_id string? -
- tenant_id string? -
- token string? -
- 'key string? -
- signature string? -
bitly: BitlinkBody![](/images/permalink.svg)
Fields
- Fields Included from *HasReferences
- references record { anydata... }
- anydata...
- Fields Included from *BitlinkUpdate
bitly: BitlinkHistory![](/images/permalink.svg)
Fields
- Fields Included from *HasReferences
- references record { anydata... }
- anydata...
- hash string? - The backhalf of the underlying hash link
- group_guid string? -
- created_at string? -
- is_active boolean? -
- long_url string? -
- deactivated_at string? -
- login string? -
- target_bitlink_id string? - The domain and backhalf of the underlying hash link
- id string? - The domain and backhalf of the parent override
bitly: BitlinkOverrideHistory![](/images/permalink.svg)
Fields
- total_count int? -
- bitlinks BitlinkHistory[]? -
bitly: BitlinkOverrides![](/images/permalink.svg)
Fields
- Fields Included from *HasReferences
- references record { anydata... }
- anydata...
- created string? -
- rules string? -
- group_guid string? -
- modified string? -
- 'version int? -
- link string? - The fully qualified URL to the Override which is the Bitly link to use. Ex: https://foo.com/bar
- id string? -
bitly: BitlinkQR![](/images/permalink.svg)
Fields
- qr_code string? - Data URI of QR Code image
- link string? -
- id string? -
bitly: Bitlinks![](/images/permalink.svg)
Fields
- pagination Pagination? -
- links BitlinkBody[]? -
bitly: BitlinkUpdate![](/images/permalink.svg)
Fields
- archived boolean? -
- tags string[]? -
- created_at string? -
- title string? -
- deeplinks DeeplinkRule[]? -
- created_by string? -
- long_url string? -
- client_id string? -
- custom_bitlinks string[]? -
- link string? -
- launchpad_ids string[]? -
- id string? -
bitly: BSDSearchResult![](/images/permalink.svg)
Fields
- 'type string? -
- domain string? -
- subdomain string? -
- link string? -
- zone string? -
bitly: BSDSearchResults![](/images/permalink.svg)
Fields
- results BSDSearchResult[]? -
bitly: BSDsResponse![](/images/permalink.svg)
Fields
- bsds string[]? -
bitly: BulkShortenUpload![](/images/permalink.svg)
Fields
- status string -
- name string -
- created string -
- group_guid string -
- report_url string -
- uploaded_by string -
- org_guid string -
bitly: BulkShortenUploadData![](/images/permalink.svg)
Fields
- headers record {} -
- upload_url string -
- bucket string -
- filename string -
bitly: BulkShortenUploads![](/images/permalink.svg)
Fields
- uploads BulkShortenUpload[] -
bitly: BulkShortenValidate![](/images/permalink.svg)
Fields
- group_guid string? -
- email string? -
- custom_domain string? -
- filename string -
bitly: BulkUpdate![](/images/permalink.svg)
Fields
- links string[]? -
bitly: BulkUpdateRequest![](/images/permalink.svg)
Fields
- action string? -
- remove_tags string[]? -
- archive boolean? -
- links string[]? - this is limited to 100 bitlink ids
- add_tags string[]? -
bitly: Campaign![](/images/permalink.svg)
Fields
- Fields Included from *HasReferences
- references record { anydata... }
- anydata...
- name string? -
- created string? - ISO timestamp
- group_guid string? -
- modified string? - ISO timestamp
- created_by string? -
- guid string? -
- description string? -
bitly: CampaignChannelClicks![](/images/permalink.svg)
Fields
- created_ts int? -
- channel_guid string? -
- total_clicks int? -
- channel_name string? -
- campaign_guid string? -
- channel_bitlinks ChannelBitlinks? -
- clicks CampaignClickData[]? -
bitly: CampaignClickData![](/images/permalink.svg)
Fields
- ts int? -
- clicks int? -
bitly: CampaignClicks![](/images/permalink.svg)
Fields
- unit_reference string? -
- rollup boolean? -
- 'limit int? -
- units int? -
- data CampaignClicksData? -
- unit string? -
bitly: CampaignClicksData![](/images/permalink.svg)
Fields
- created_ts int? -
- description string? -
- brand_guid string? -
- campaign_channels CampaignChannelClicks[]? -
- created_by string? -
- modified_ts int? -
- total_clicks int? -
- guid string? -
- name string? -
bitly: CampaignModify![](/images/permalink.svg)
Fields
- group_guid string? -
- channel_guids string[]? -
- description string? -
- name string? -
bitly: Campaigns![](/images/permalink.svg)
Fields
- campaigns Campaign[]? -
bitly: Channel![](/images/permalink.svg)
Fields
- Fields Included from *BaseChannel
- Fields Included from *HasReferences
- references record { anydata... }
- anydata...
bitly: ChannelBitlink![](/images/permalink.svg)
Fields
- keyword_link string? -
- created_ts int -
- bitlink_id string -
- channel_guid string -
- title string? -
- campaign_ids string[]? -
- total_clicks int? -
- aggregate_link string? -
- campaign_guid string -
- link string? -
- client_id string? -
- long_url string? -
- clicks CampaignClickData[]? -
bitly: ChannelBitlinks![](/images/permalink.svg)
Fields
- total int? -
- bitlinks ChannelBitlink[]? -
bitly: ChannelModify![](/images/permalink.svg)
Fields
- Fields Included from *BaseChannel
- bitlinks BaseChannelBitlink[]? -
bitly: Channels![](/images/permalink.svg)
Fields
- channels Channel[]? -
bitly: Charges![](/images/permalink.svg)
Fields
- charge_amount decimal? -
- processing_type string? -
- tax_amount decimal? -
- charge_name string? -
bitly: CityMetric![](/images/permalink.svg)
Fields
- city string? -
- region string? -
- subregion string? -
- clicks int? -
- country string? -
bitly: CityMetrics![](/images/permalink.svg)
Fields
- Fields Included from *BaseMetrics
- metrics CityMetric[]? -
- other_metrics OtherMetrics? -
bitly: CityViewMetrics![](/images/permalink.svg)
Fields
- Fields Included from *BaseMetrics
- launchpad_views ViewMetric[]? -
- other_metrics OtherViewMetrics? -
bitly: ClickLink![](/images/permalink.svg)
Fields
- clicks int? -
- id string? -
bitly: ClickMetric![](/images/permalink.svg)
Fields
- clicks int? -
- value string? -
bitly: ClickMetrics![](/images/permalink.svg)
Fields
- Fields Included from *BaseMetrics
- metrics ClickMetric[]? -
bitly: Clicks![](/images/permalink.svg)
Fields
- units int? -
- unit_reference string? -
- unit string? -
- link_clicks LinkClicks[]? -
bitly: ClicksCount![](/images/permalink.svg)
Fields
- 'error string? -
- clicks int? -
- bitlink_id string? -
bitly: ClicksForBitlinks![](/images/permalink.svg)
Fields
- clicks ClicksCount[]? -
bitly: ClicksSummary![](/images/permalink.svg)
Fields
- units int? -
- unit string? -
- total_clicks int? -
- unit_reference string? -
bitly: Clickstream![](/images/permalink.svg)
Fields
- name string? - Descriptive name for the clickstream
- created string? - Clickstream creation time
- deactivated string? - Time of deactivation, if any
- modified string? - Last modified time
- query string? - Clickstream query
- id string? - Unique short id
bitly: ClickstreamBody![](/images/permalink.svg)
Fields
- brand_guid string? - Clickstream brand identifier
bitly: ClickstreamSink![](/images/permalink.svg)
Fields
- name string? - Descriptive name for the sink
- schedule string? - Delivery schedule
- deactivated string? - Time of deactivation, if any
- destination string? - Location of the sink
- modified string? - Last modified time
- created string? - Sink creation time
- sink_origin_id int? - Sink origin ID classification
- client_id string? - Unique short id of client
- provider string? - Provider of sink
- last_sync string? - Last synced time
- id string? - Unique short id
- clickstream_id string? - Unique short id of clickstream
bitly: ClickstreamSinkFile![](/images/permalink.svg)
Fields
- date_from string? - start of period
- date_to string? - end of period
- file_id string? - Unique id of the file
- download_url string? - use this url with follow redirects to download the file
- created string? - time of creation
bitly: ClickstreamSinkFiles![](/images/permalink.svg)
Fields
- date_from string? - start of period
- objects ClickstreamSinkFile[]? -
- id string? - Unique short id of sink file
- clickstream_id string? - Unique short id of clickstream
- date_to string? - end of period
bitly: ClickstreamSinkNew![](/images/permalink.svg)
Fields
- destination string? - Location of the sink
- name string? - Descriptive name for the sink
- auth_key string? - Auth key for syncing to destination
- provider string? - Provider of sink
bitly: ClickstreamSinkUpdate![](/images/permalink.svg)
Fields
- Fields Included from *ClickstreamSinkNew
- deactivated boolean? - False if sink should be activated
- schedule string? - Delivery schedule
bitly: ClientHttp1Settings![](/images/permalink.svg)
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy ProxyConfig? - Proxy server related options
bitly: ConnectionConfig![](/images/permalink.svg)
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings ClientHttp1Settings? - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings? - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded
/x-forwarded
header
- poolConfig PoolConfiguration? - Configurations associated with request pooling
- cache CacheConfig? - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding
) header
- circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig RetryConfig? - Configurations associated with retrying
- responseLimits ResponseLimitConfigs? - Configurations associated with inbound response size limits
- secureSocket ClientSecureSocket? - SSL/TLS-related options
- proxy ProxyConfig? - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
bitly: ConsumableFeature![](/images/permalink.svg)
Fields
- name string? -
- created string? - ISO_TIMESTAMP
- modified string? - ISO_TIMESTAMP
- 'limit int? -
- is_tier_default boolean? -
- id string? -
bitly: ConsumableFeatureFull![](/images/permalink.svg)
Fields
- count int? -
- name string? -
- created string? - ISO_TIMESTAMP
- is_limited boolean? -
- modified string? - ISO_TIMESTAMP
- 'limit int? -
- is_tier_default boolean? -
- id string? -
- is_enforced boolean? -
bitly: ConsumableFeatures![](/images/permalink.svg)
Fields
- consumable_features ConsumableFeature[]? -
bitly: ContactInfo![](/images/permalink.svg)
Fields
- first_name string -
- last_name string -
- address BillingAddress -
bitly: CountItem![](/images/permalink.svg)
Fields
- count int? -
- ts string? -
bitly: CountryCode![](/images/permalink.svg)
Fields
- CountryName string? -
- ISO3 string? -
- ISO2 string? -
- CallingCode int? -
bitly: CreateLaunchpad![](/images/permalink.svg)
Fields
- group_guid string -
- domain string -
- keyword string -
bitly: CreateOauthAppReq![](/images/permalink.svg)
Fields
- redirect_uris string[]? -
- name string? -
- organization_guid string? -
- link string? -
- ip_allowlist string[]? -
- description string? -
bitly: CreateOverrideRules![](/images/permalink.svg)
Fields
- rules string -
- group_guid string? -
bitly: CreatePaymentMethod![](/images/permalink.svg)
Fields
- stripe_token string? -
bitly: CreateShare![](/images/permalink.svg)
Fields
- text string? -
- bitlink string? -
- account_type SocialAccounts? -
- account_id string? -
- group_guid string? -
bitly: CustomBitlink![](/images/permalink.svg)
Fields
- bitlink BitlinkBody? -
- bitlink_history CustomBitlinkHistory[]? -
- custom_bitlink string? -
bitly: CustomBitlinkHistory![](/images/permalink.svg)
Fields
- hash string? -
- uuid string? -
- keyword string? -
- created string? -
- group_guid string? -
- first_created string? -
- is_active boolean? -
- long_url string? -
- deactivated string? -
- bsd string? -
- login string? -
bitly: CustomDomain![](/images/permalink.svg)
Fields
- custom_domain string? -
- organization_guid string? -
bitly: CustomDomainBody![](/images/permalink.svg)
information about given custom domain
Fields
- deeplink_apps MinimalDeeplinkApp[]? -
- hsts_enabled boolean? -
- upgrade_insecure_requests boolean? -
- custom_domain string? -
- validation_error string? -
- created int? -
- is_active boolean? -
- root_redirect string? -
- ssl_configuration_error string? -
- ssl_autoconfigure_error boolean? -
- group_guids string[]? -
- ssl_cert CustomdomainbodySslCert? -
- wildcard_redirect string? -
- configuration_last_check_ts string? -
- https_enabled boolean? -
- validation_status string? -
- https_bitlinks boolean? -
bitly: CustomdomainbodySslCert![](/images/permalink.svg)
Fields
- custom_cert boolean? -
- valid_end int? -
- issuer string? -
bitly: CustomDomains![](/images/permalink.svg)
Fields
- upgrade_required boolean? -
- custom_domains CustomDomainBody[]? -
bitly: DataExportQuery![](/images/permalink.svg)
Fields
- archived string? -
- unit_reference int? -
- link_deeplinks string? -
- tags string[]? -
- campaign_ids string[]? -
- modified_after int? -
- keyword string? -
- created_after int? -
- custom_bitlink string? -
- units int? -
- query string? -
- report_type string? -
- created_before int? -
- emails string[]? -
- unit string? -
bitly: DeactivateUser![](/images/permalink.svg)
Fields
- feedback Feedback? -
- confirm_text string? -
bitly: Deeplink![](/images/permalink.svg)
Fields
- app_uri_path string? -
- install_type string? -
- install_url string? -
- app_id string? -
bitly: DeeplinkApp![](/images/permalink.svg)
Fields
- third_party_app_id string -
- created_ts int? -
- scheme string? -
- install_url string -
- name string -
- legacy_app_id string? -
- icon_url string? -
- organization_guid string? -
- modified_ts int? -
- guid string? -
- apple_app_entitlement_id string? -
- android_sha256 string[]? -
- os string -
bitly: DeeplinkApps![](/images/permalink.svg)
Fields
- apps DeeplinkApp[]? -
bitly: DeeplinkMetric![](/images/permalink.svg)
Fields
- app_installs int? -
- store_visits int? -
- interstital_views int? -
- app_opens int? -
- web_opens int? -
bitly: DeeplinkMetricsRollup![](/images/permalink.svg)
Fields
- unit_reference UnitReferenceTimeStamp? - data returned up to this reference timestamp
- ios DeeplinkMetric? -
- other DeeplinkMetric? -
- units UnitAmount? - the number of units queried for
- android DeeplinkMetric? -
- unit TimeUnit? - the unit of time queried for (minute, hour, day, week, month)
bitly: DeeplinkRule![](/images/permalink.svg)
Fields
- bitlink string? -
- install_url string? -
- created string? - ISO timestamp
- app_uri_path string? -
- modified string? - ISO timestamp
- install_type string? -
- app_guid string? -
- guid string? -
- os string? -
- brand_guid string? -
bitly: DeeplinkRules![](/images/permalink.svg)
Fields
- rules DeeplinkRule[]? -
bitly: DefaultAccessFeature![](/images/permalink.svg)
the tier default values for a single access feature
Fields
- has_access boolean? -
- name string? -
bitly: DefaultConsumableFeature![](/images/permalink.svg)
the tier default values for a single consumable feature
Fields
- 'limit int? -
- name string? -
bitly: DeleteShare![](/images/permalink.svg)
Fields
- account_login string? -
- account_type SocialAccounts? -
bitly: DeviceMetric![](/images/permalink.svg)
Fields
- clicks int? -
- device_type string? -
bitly: DeviceMetrics![](/images/permalink.svg)
Fields
- Fields Included from *BaseMetrics
- metrics DeviceMetric[]? -
bitly: DomainAgreement![](/images/permalink.svg)
Fields
- content string? -
- url string? -
- agreement_key string? -
- title string? -
bitly: DomainAgreements![](/images/permalink.svg)
Fields
- domain_agreements DomainAgreement[]? -
bitly: DomainRegister![](/images/permalink.svg)
Fields
- redirect_url string? -
bitly: DomainStatus![](/images/permalink.svg)
Fields
- status string? -
- domain string? -
- price string? -
- zone string? -
bitly: DomainUpdate![](/images/permalink.svg)
update custom domain fields
Fields
- https_enabled boolean? -
- hsts_enabled boolean? -
- upgrade_insecure_requests boolean? -
- wildcard_redirect string? -
- root_redirect string? -
bitly: DomainValidate![](/images/permalink.svg)
custom domain in validation queue
Fields
- custom_domain string? -
- organization_guid string? -
bitly: Email![](/images/permalink.svg)
Fields
- is_primary boolean? -
- is_verified boolean? -
- email string? -
bitly: EmailBody![](/images/permalink.svg)
Fields
- status string? -
- is_primary boolean? -
- email string? -
bitly: EncodingLogin![](/images/permalink.svg)
Fields
- encoding_login string[]? -
bitly: Error![](/images/permalink.svg)
Fields
- message string? -
- errors FieldError[]? -
- 'resource string? -
- description string? -
bitly: Event![](/images/permalink.svg)
Fields
- ui_action string -
- referrer string? -
- action string -
- initiated_by string -
- group_guid string? -
- ui_action_date string -
- login string -
- org_guid string -
bitly: ExpandBitlink![](/images/permalink.svg)
Fields
- bitlink_id string? -
bitly: ExpandedBitlink![](/images/permalink.svg)
Fields
- long_url string? -
- created_at string? -
- link string? -
- id string? -
bitly: FacetCountData![](/images/permalink.svg)
Fields
- total_count int? -
- ts int? -
- items FacetCountItem[]? -
bitly: FacetCountItem![](/images/permalink.svg)
Fields
- count int? -
- value string? -
bitly: FeatureUsage![](/images/permalink.svg)
Fields
- consumable_features ConsumableFeatureFull[] - an array of all of the organizations consumable features
- access_features AccessFeature[] - an array of all of the organizations access features
bitly: Feedback![](/images/permalink.svg)
Fields
- selection string? -
- optional_text string? -
bitly: FieldError![](/images/permalink.svg)
Fields
- 'field string? -
- message string? -
- error_code string? -
bitly: FormCapturePayload![](/images/permalink.svg)
Fields
- submit_text string? -
- name string? -
- response_status string? -
- pages FormPage[]? -
- 'version string? -
- group_guid string? -
- login string? -
- skip_text string? -
- org_guid string? -
bitly: FormConfig![](/images/permalink.svg)
Fields
- options FormSelectOptions[]? -
bitly: FormField![](/images/permalink.svg)
Fields
- field_type string? -
- name string? -
- required boolean? -
- label string? -
- config FormConfig? -
- response string? -
bitly: FormPage![](/images/permalink.svg)
Fields
- fields FormField[]? -
bitly: FormSelectOptions![](/images/permalink.svg)
Fields
- display string? -
- 'key string? -
bitly: FullShorten![](/images/permalink.svg)
Fields
- domain string(default "bit.ly") -
- title string? -
- group_guid string? - Always include a specific group and custom domain in your shorten calls.
- tags string[]? -
- deeplinks Deeplink[]? -
- long_url string -
bitly: Group![](/images/permalink.svg)
Fields
- Fields Included from *HasReferences
- references record { anydata... }
- anydata...
- name string? -
- bsds string[]? -
- created string? -
- is_active boolean? -
- modified string? -
- organization_guid string? -
- role string? -
- guid string? -
bitly: GroupBitlinksCount![](/images/permalink.svg)
Fields
- units int? -
- data CountItem[]? -
- unit_reference string? -
- unit string? -
bitly: GroupBitlinksCountRollup![](/images/permalink.svg)
Fields
- units int? -
- total_clicks int? -
- unit_reference string? -
- unit string? -
bitly: GroupClicks![](/images/permalink.svg)
Fields
- units int? -
- data CountItem[]? -
- unit_reference string? -
- unit string? -
bitly: GroupClicksByFacet![](/images/permalink.svg)
Fields
- units int? -
- data FacetCountData[]? -
- unit_reference string? -
- unit string? -
bitly: GroupClicksByFacetRollup![](/images/permalink.svg)
Fields
- units int? -
- data FacetCountItem[]? -
- unit_reference string? -
- unit string? -
bitly: GroupPreferences![](/images/permalink.svg)
Fields
- group_guid string? -
- domain_preference string? -
bitly: Groups![](/images/permalink.svg)
Fields
- groups Group[] -
bitly: GroupUpdate![](/images/permalink.svg)
Fields
- bsds string[]? -
- name string? -
- organization_guid string? -
bitly: HasReferences![](/images/permalink.svg)
Fields
- references record {}? -
bitly: Invitation![](/images/permalink.svg)
Fields
- role_name string -
- email string -
- groups InvitationGroup[]? -
- created string? -
bitly: InvitationForLogin![](/images/permalink.svg)
Fields
- invited_org_name string -
- invited_org_guid string -
- token string -
- invited_by_email string -
- invited_by string -
bitly: InvitationGroup![](/images/permalink.svg)
Fields
- group_guid string? -
- role_name string? -
- created string? -
bitly: Invitations![](/images/permalink.svg)
Fields
- invitations Invitation[]? -
bitly: InvitationsAccept![](/images/permalink.svg)
Fields
- tokens string[]? -
bitly: InvitationsCreate![](/images/permalink.svg)
Fields
- role_name string -
- emails string[] -
- groups InvitationGroup[]? -
- created string? -
bitly: InvitationsError![](/images/permalink.svg)
Fields
- message string? -
- emails string[]? -
bitly: InvitationsForLogin![](/images/permalink.svg)
Fields
- invitations InvitationForLogin[]? -
bitly: Launchpad![](/images/permalink.svg)
Fields
- launchpad_id string? -
- domain string? -
- keyword string? -
- is_active boolean -
- buttons LaunchpadButtons[]? -
- launchpad_appearance LaunchpadAppearance? -
- scheme string? -
bitly: LaunchpadAppearance![](/images/permalink.svg)
Fields
- launchpad_id string? -
- avatar_preference string? -
- hide_bitly_logo boolean -
- display_name string? -
- avatar_background_color string? -
- launchpad_text_color string? -
- description string? -
- button_appearance LaunchpadButtonAppearance? -
- avatar_image_url string? -
- style_preference string? -
- background string? -
- theme_id int? -
- avatar_text_color string? -
- layout string? -
bitly: LaunchpadButton![](/images/permalink.svg)
Fields
- launchpad_id string? -
- bitlink string? -
- button_id string? -
- keyword string? -
- title string? -
- is_pinned boolean? -
- is_active boolean -
- domain string? -
- schedule_end string? -
- sort_order int? -
- long_url string? -
- scheme string? -
- schedule_start string? -
bitly: LaunchpadButtonAppearance![](/images/permalink.svg)
Fields
- launchpad_id string? -
- button_background string? -
- text_color string? -
bitly: LaunchpadButtonRequest![](/images/permalink.svg)
Fields
- bitlink string? -
- title string? -
- is_active boolean? -
- is_pinned boolean? -
- schedule_end string? -
- long_url string? -
- domain string? -
- schedule_start string? -
bitly: LaunchpadButtonSortOrder![](/images/permalink.svg)
Fields
- sort_order int -
- button_id string -
bitly: LaunchpadClicks![](/images/permalink.svg)
Fields
- domain string? -
- bitlink_id string? -
- keyword string? -
- title string? -
- is_active boolean? -
- long_url string? -
- date string? -
- clicks int? -
bitly: LaunchpadLinkPerformance![](/images/permalink.svg)
Fields
- unit_reference string? -
- link_clicks LaunchpadClicks[]? -
- performance_start string? -
- performance_end string? -
- units int? -
- unit string? -
bitly: LaunchpadPresetTheme![](/images/permalink.svg)
Fields
- button_text_color string? -
- display_name string? -
- avatar_text_color string? -
- launchpad_text_color string? -
- is_active boolean? -
- background string? -
- avatar_background string? -
- theme_id int? -
- button_background string? -
bitly: LaunchpadQRCode![](/images/permalink.svg)
Fields
- launchpad_id string? -
- qr_code string? -
- link string? -
bitly: Launchpads![](/images/permalink.svg)
Fields
- launchpads Launchpad[]? -
bitly: LinkClicks![](/images/permalink.svg)
Fields
- date string? -
- clicks int? -
bitly: MethodLimit![](/images/permalink.svg)
Fields
- count int? -
- 'limit int? -
- name string? -
bitly: Metric![](/images/permalink.svg)
Fields
- value int? -
- 'key string? -
bitly: Metrics![](/images/permalink.svg)
Fields
- Fields Included from *BaseMetrics
- metrics Metric[]? -
bitly: MinimalDeeplinkApp![](/images/permalink.svg)
Deep Linking object
Fields
- guid string? -
- os string? -
bitly: NSQLookup![](/images/permalink.svg)
Fields
- producers NSQProducer[]? -
bitly: NSQProducer![](/images/permalink.svg)
Fields
- http_port int? -
- broadcast_address string? -
- tcp_port int? -
- hostname string? -
- remote_address string? -
- 'version string? -
bitly: OAuthApp![](/images/permalink.svg)
Fields
- link string? -
- name string? -
- client_id string? -
- description string? -
bitly: OAuthApps![](/images/permalink.svg)
Fields
- applications OAuthApp[]? -
bitly: OAuthAppWithOwnerLogin![](/images/permalink.svg)
Fields
- owner_login string? -
- link string? -
- name string? -
- client_id string? -
- description string? -
bitly: Organization![](/images/permalink.svg)
Fields
- Fields Included from *HasReferences
- references record { anydata... }
- anydata...
- name string? -
- bsds string[]? -
- created string? -
- is_active boolean? -
- modified string? -
- tier_display_name string? -
- tier_family string? -
- tier string? -
- role string? -
- guid string? -
bitly: OrganizationGUID![](/images/permalink.svg)
Fields
- organization_guid string? -
bitly: Organizations![](/images/permalink.svg)
Fields
- organizations Organization[] -
bitly: OrganizationUpdate![](/images/permalink.svg)
Fields
- name string -
bitly: OrgEmail![](/images/permalink.svg)
Fields
- org_guid string? -
- created_ts int? -
- login string? -
- email string? -
bitly: OrgEmailBody![](/images/permalink.svg)
Fields
- login string? -
- org_guid string? -
- email string? -
bitly: OrgEmails![](/images/permalink.svg)
an array of org emails
Fields
- emails OrgEmail[]? -
bitly: OrgTierHistory![](/images/permalink.svg)
Fields
- status string? -
- created string? - ISO timestamp
- deactivated string? - ISO timestamp
- tier_change_date string? - ISO timestamp
- activated string? - ISO timestamp
- modified string? - ISO timestamp
- tier_name string? -
- org_guid string? -
bitly: OtherMetrics![](/images/permalink.svg)
Fields
- other_city_clicks int? -
- no_city_clicks int? -
bitly: OtherViewMetrics![](/images/permalink.svg)
Fields
- other_city_views int? -
- no_city_views int? -
bitly: Pagination![](/images/permalink.svg)
Fields
- total int? -
- size int? -
- prev string? -
- page int? -
- next string? -
bitly: PaymentInvoice![](/images/permalink.svg)
Fields
- total_tax decimal? -
- description string? -
- charges Charges? -
- invoice_id string? -
- invoice_date string? -
- payments Payments[]? -
- invoice_number string? -
- total decimal? -
- subtotal decimal? -
- invoice_due_date string? -
bitly: PaymentInvoiceDetail![](/images/permalink.svg)
Fields
- invoice_summary PaymentInvoice? -
- billing_account BillingAccount? -
bitly: PaymentInvoices![](/images/permalink.svg)
Fields
- payment_invoices PaymentInvoice[]? -
bitly: Payments![](/images/permalink.svg)
Fields
- payment_number string? -
- payment_date string? -
- payment_amount decimal? -
bitly: PlanLimit![](/images/permalink.svg)
Fields
- count int? -
- 'limit int? -
- name string? -
- description string? -
bitly: PlanLimits![](/images/permalink.svg)
Fields
- Fields Included from *HasReferences
- references record { anydata... }
- anydata...
- organization_guid string? -
- plan_limits PlanLimit[]? -
bitly: PlatformLimit![](/images/permalink.svg)
Fields
- endpoint string? -
- methods MethodLimit[]? -
bitly: PlatformLimits![](/images/permalink.svg)
Fields
- platform_limits PlatformLimit[]? -
bitly: ProxyConfig![](/images/permalink.svg)
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
bitly: PublicSSLCert![](/images/permalink.svg)
SSL Certification
Fields
- custom_cert boolean? -
- valid_end int? -
- issuer string? -
bitly: PublicValidate![](/images/permalink.svg)
Info needed for domain validation
Fields
- custom_domain string? -
- organization_guid string? -
bitly: PurchaseBSD![](/images/permalink.svg)
Fields
- domain string? -
- agreed_at string? - ISO_TIMESTAMP
- organization_guid string? -
- agreement_keys string[]? -
bitly: PurchaseBSDResponse![](/images/permalink.svg)
Fields
- order_id int? -
- domain string? -
- total string? -
- organization_guid string? -
bitly: ReferrersByDomain![](/images/permalink.svg)
Fields
- referrers Metric[]? -
- network string? -
bitly: ReferrersByDomains![](/images/permalink.svg)
Fields
- units int? -
- facet string? -
- referrers_by_domain ReferrersByDomain[]? -
- unit_reference string? -
- unit string? -
bitly: Share![](/images/permalink.svg)
Fields
- numeric_id int? -
- account_type SocialAccounts? -
- account_id string? -
- text string? -
- link string? -
- account_name string? -
bitly: ShareableReport![](/images/permalink.svg)
Fields
- bitlink_id string? -
- shareable_report string? -
bitly: ShareAccount![](/images/permalink.svg)
Fields
- numeric_id int? -
- account_login string? -
- account_type SocialAccounts? -
- account_id string? -
- oauth_error string? -
- primary boolean? -
- visible boolean? -
- connected string? - ISO timestamp
- account_name string? -
bitly: ShareAccounts![](/images/permalink.svg)
Fields
- share_accounts ShareAccount[]? -
bitly: Shorten![](/images/permalink.svg)
Fields
- group_guid string? -
- domain string(default "bit.ly") -
- long_url string -
bitly: ShortenBitlinkBody![](/images/permalink.svg)
Fields
- Fields Included from *HasReferences
- references record { anydata... }
- anydata...
- archived boolean? -
- tags string[]? -
- created_at string? -
- deeplinks DeeplinkRule[]? -
- long_url string? -
- custom_bitlinks string[]? -
- link string? -
- id string? -
bitly: SortedLinks![](/images/permalink.svg)
Fields
- sorted_links ClickLink[]? -
- links BitlinkBody[]? -
bitly: SSOSettings![](/images/permalink.svg)
Fields
- slo_endpoint string? -
- default_group_guid string? -
- idp_url string? -
- certificate string? -
- organization_guid string? -
- saml_endpoint string? -
- identity_provider string? -
- domains string[]? -
- issuer_url string? -
- url_slug string? -
bitly: SSOSlug![](/images/permalink.svg)
Fields
- url_slug string? -
bitly: SSOVerifySlug![](/images/permalink.svg)
Fields
- available boolean? -
- url_slug string? -
bitly: SubscriptionCancelledDate![](/images/permalink.svg)
Fields
- subscription_cancelled_date string? - ISO timestamp
bitly: Tags![](/images/permalink.svg)
Fields
- tags string[]? -
bitly: ThirdPartyAppData![](/images/permalink.svg)
Fields
- third_party_app_id string? -
- install_url string? -
- os string? -
- name string? -
- icon_url string? -
bitly: Tier![](/images/permalink.svg)
a single tier
Fields
- display_name string? -
- name string? -
- family string? -
- price int? -
- billing_period_type string? -
- consumable_features DefaultConsumableFeature[]? -
- sort_order int? -
- is_self_service boolean? -
- access_features DefaultAccessFeature[]? -
- display_icon string? -
- is_paid boolean? -
- description string? -
bitly: TwoFactor![](/images/permalink.svg)
Fields
- phone_number string -
- status string? -
- country_code string -
bitly: TwoFactorCode![](/images/permalink.svg)
Fields
- code string -
bitly: TwoFactorVerify![](/images/permalink.svg)
Fields
- is_valid boolean -
- is_expired boolean -
bitly: UMGroupPreference![](/images/permalink.svg)
Fields
- created string? -
- group_guid string? -
- modified string? -
- value string? -
- preference string? -
- expired boolean? -
- last_seen string? -
bitly: UMGroupPreferences![](/images/permalink.svg)
Fields
- preferences UMGroupPreference[]? -
bitly: UpdateApp![](/images/permalink.svg)
Fields
- ip_allowlist string[]? -
- redirect_uris string[]? -
- link string? -
- name string? -
- description string? -
bitly: UpdateButtonSortOrder![](/images/permalink.svg)
Fields
- buttons LaunchpadButtonSortOrder[]? -
bitly: UpdateCustomBitlink![](/images/permalink.svg)
Fields
- bitlink_id string? -
bitly: UpdateLaunchpad![](/images/permalink.svg)
Fields
- launchpad_id string? -
- domain string? -
- is_active boolean -
- launchpad_appearance LaunchpadAppearance? -
- keyword string? -
bitly: UpdateOverrideRules![](/images/permalink.svg)
Fields
- rules string? -
bitly: UpgradeOrgBody![](/images/permalink.svg)
Fields
- billing_info BillingInfo? -
- payment_provider string? -
- stripe_token string? -
- rate_plan_name string? -
- org_guid string? -
- payment_method_id string? -
bitly: User![](/images/permalink.svg)
Fields
- default_group_guid string? -
- name string -
- created string -
- is_active boolean -
- modified string -
- is_sso_user boolean -
- is_2fa_enabled boolean -
- login string -
- emails Email[] -
bitly: UserInternal![](/images/permalink.svg)
Fields
- Fields Included from *User
- role_name string? -
bitly: UserOnboardingSurvey![](/images/permalink.svg)
Fields
- first_name string? -
- last_name string? -
- created string? -
- modified string? -
- company_size string? -
- organization_name string? -
- use_cases string[]? -
- 'version decimal? -
- use_cases_other string[]? -
- department string? -
- login string? -
- job_title string? -
- department_other string? -
- team_type string? -
bitly: UserPasswordChange![](/images/permalink.svg)
Fields
- original_password string -
- new_password string -
bitly: UserPreference![](/images/permalink.svg)
Fields
- created string? -
- is_active boolean? -
- modified string? -
- value string? -
- preference string? -
- login string? -
- expired boolean? -
- last_seen string? -
bitly: UserPreferenceBody![](/images/permalink.svg)
Fields
- is_active boolean? -
- preference string? -
- value string? -
bitly: UserPreferences![](/images/permalink.svg)
Fields
- preferences UserPreference[]? -
bitly: UserRole![](/images/permalink.svg)
Fields
- group_guid string? -
- login string -
- role_name string? -
- organization_guid string? -
bitly: Users![](/images/permalink.svg)
Fields
- pagination Pagination? -
- users UserInternal[]? -
bitly: UserUpdate![](/images/permalink.svg)
Fields
- default_group_guid string? -
- name string? -
bitly: ViewMetric![](/images/permalink.svg)
Fields
- value string? -
- views int? -
bitly: Views![](/images/permalink.svg)
Fields
- launchpad_views ViewMetric[]? -
- units int? -
- facet string? -
- unit string? -
- unit_reference string? -
bitly: ViewsSummary![](/images/permalink.svg)
Fields
- units int? -
- total_views int? -
- unit_reference string? -
- unit string? -
bitly: Webhook![](/images/permalink.svg)
Fields
- Fields Included from *HasReferences
- references record { anydata... }
- anydata...
- status string? -
- modified_by string? -
- name string? -
- created string? -
- url string? -
- deactivated string? -
- fetch_tags boolean? -
- is_active boolean? -
- modified string? -
- organization_guid string? -
- client_id string? -
- group_guid string? -
- client_secret string? -
- oauth_url string? -
- guid string? -
- event string? -
bitly: WebhookCreate![](/images/permalink.svg)
Fields
- name string -
- url string -
- group_guid string? -
- fetch_tags boolean? -
- is_active boolean? -
- organization_guid string -
- client_id string? -
- client_secret string? -
- oauth_url string? -
- event string -
bitly: Webhooks![](/images/permalink.svg)
Fields
- webhooks Webhook[]? -
bitly: WebhookUpdate![](/images/permalink.svg)
Fields
- name string? -
- url string? -
- group_guid string? -
- fetch_tags boolean? -
- is_active boolean? -
- organization_guid string? -
- client_id string? -
- client_secret string? -
- oauth_url string? -
- guid string -
- event string? -
String types![](/images/permalink.svg)
bitly: BillingPaymentMethodID![](/images/permalink.svg)
BillingPaymentMethodID
bitly: InstallPreference![](/images/permalink.svg)
InstallPreference
bitly: SocialAccounts![](/images/permalink.svg)
SocialAccounts
bitly: TimeUnit![](/images/permalink.svg)
TimeUnit
the unit of time queried for (minute, hour, day, week, month)
bitly: UnitReferenceTimeStamp![](/images/permalink.svg)
UnitReferenceTimeStamp
data returned up to this reference timestamp
Integer types![](/images/permalink.svg)
bitly: UnitAmount![](/images/permalink.svg)
UnitAmount
the number of units queried for
Import
import ballerinax/bitly;
Metadata
Released date: about 1 year ago
Version: 1.5.1
License: Apache-2.0
Compatibility
Platform: any
Ballerina version: 2201.4.1
GraalVM compatible: Yes
Pull count
Total: 3
Current verison: 0
Weekly downloads
Keywords
Devtools
Cost/Freemium
Contributors
Dependencies