bitly
Module bitly
API
Definitions
ballerinax/bitly Ballerina library
Overview
Bitly is a link management platform that shortens URLs, manages branded links and QR codes, and reports on how people engage with them.
The Bitly connector gives Ballerina programs typed access to version 4 of the Bitly API, so you can create and manage Bitlinks, custom Bitlinks, groups, campaigns, channels, webhooks, QR codes and Bitly Pages, and read click, scan and engagement analytics.
Key features
- Shorten and manage Bitlinks, including custom back-halves and link updates
- Read click and engagement metrics by country, city, device and referrer
- Organise links with groups, campaigns, channels and tags
- Create and manage QR codes and Bitly Pages
- Register webhooks to receive link events
Setup guide
To use the connector you need a Bitly account and an access token.
-
Sign up or log in at bitly.com.
-
Open your account settings and go to the API page under the developer settings.
-
Enter your password and generate a generic access token, then copy it.
-
Note the GUID of the group you want to work with. You can read it from the
getGroupsoperation or from the group page in your account.
Note: Keep the access token out of client-side code and version control.
Quickstart
To use the bitly connector in your Ballerina application, update the .bal file as follows:
Step 1: Import the module
import ballerinax/bitly;
Step 2: Instantiate a new connector
Create a Config.toml file with your access token:
accessToken = "<access token>"
Then create the client in your .bal file:
configurable string accessToken = ?; bitly:Client bitlyClient = check new ({auth: {token: accessToken}});
Step 3: Invoke the connector operation
public function main() returns error? { bitly:Groups _ = check bitlyClient->getGroups(); }
Step 4: Run the Ballerina application
bal run
Examples
The Bitly connector provides practical examples illustrating usage in various scenarios. Explore these examples, covering the following use cases:
- short_link_lifecycle - Create a Bitlink, tag it and read its click summary.
- group_link_analytics - List the Bitlinks of a group and report the top countries for each.
Clients
bitly: Client
Constructor
Gets invoked to initialize the connector.
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
createBitlink
function createBitlink(Shorten payload, map<string|string[]> headers) returns ShortenBitlinkBody|errorShorten a Link
Parameters
- payload Shorten - Long URL to shorten, with the optional domain and group to create the Bitlink in
Return Type
- ShortenBitlinkBody|error - SUCCESS
createFullBitlink
function createFullBitlink(FullShorten payload, map<string|string[]> headers) returns BitlinkBody|errorCreate a Bitlink
Parameters
- payload FullShorten - Details of the Bitlink to create, such as the long URL, domain, title, tags and deep links
Return Type
- BitlinkBody|error - SUCCESS
getBitlink
Retrieve a Bitlink
Parameters
- bitlink string - A Bitlink made of the domain and hash
Return Type
- BitlinkBody|error - SUCCESS
deleteBitlink
function deleteBitlink(string bitlink, map<string|string[]> headers) returns LinkDeletionResponse|errorDelete a Bitlink
Parameters
- bitlink string - A Bitlink made of the domain and hash
Return Type
- LinkDeletionResponse|error - SUCCESS
updateBitlink
function updateBitlink(string bitlink, BitlinkUpdateBody payload, map<string|string[]> headers) returns BitlinkBody|errorUpdate a Bitlink
Parameters
- bitlink string - A Bitlink made of the domain and hash
- payload BitlinkUpdateBody - Bitlink fields to change, such as the title, tags, archived state, deep links and expiration
Return Type
- BitlinkBody|error - SUCCESS
expandBitlink
function expandBitlink(ExpandBitlink payload, map<string|string[]> headers) returns ExpandedBitlink|errorExpand a Bitlink
Parameters
- payload ExpandBitlink - Bitlink to expand back to its long URL
Return Type
- ExpandedBitlink|error - SUCCESS
getClicksForBitlink
function getClicksForBitlink(string bitlink, map<string|string[]> headers, *GetClicksForBitlinkQueries queries) returns Clicks|errorGet Clicks for a Bitlink
Parameters
- bitlink string - A Bitlink made of the domain and hash
- queries *GetClicksForBitlinkQueries - Queries to be sent with the request
getClicksSummaryForBitlink
function getClicksSummaryForBitlink(string bitlink, map<string|string[]> headers, *GetClicksSummaryForBitlinkQueries queries) returns ClicksSummary|errorGet a Clicks Summary for a Bitlink
Parameters
- bitlink string - A Bitlink made of the domain and hash
- queries *GetClicksSummaryForBitlinkQueries - Queries to be sent with the request
Return Type
- ClicksSummary|error - SUCCESS
getEngagements
function getEngagements(string bitlink, map<string|string[]> headers, *GetEngagementsQueries queries) returns TotalEngagements|errorGet Engagement Counts for a Bitlink
Parameters
- bitlink string - A Bitlink made of the domain and hash
- queries *GetEngagementsQueries - Queries to be sent with the request
Return Type
- TotalEngagements|error - SUCCESS
getEngagementsSummary
function getEngagementsSummary(string bitlink, map<string|string[]> headers, *GetEngagementsSummaryQueries queries) returns TotalEngagementsSummary|errorGet an Engagement Count Summary for a Bitlink
Parameters
- bitlink string - A Bitlink made of the domain and hash
- queries *GetEngagementsSummaryQueries - Queries to be sent with the request
Return Type
- TotalEngagementsSummary|error - SUCCESS
getAgenticTrafficForBitlink
function getAgenticTrafficForBitlink(string bitlink, map<string|string[]> headers, *GetAgenticTrafficForBitlinkQueries queries) returns ClickMetrics|errorGet Agentic Traffic for a Bitlink
Parameters
- bitlink string - A Bitlink made of the domain and hash
- queries *GetAgenticTrafficForBitlinkQueries - Queries to be sent with the request
Return Type
- ClickMetrics|error - SUCCESS
getMetricsForBitlinkByCountries
function getMetricsForBitlinkByCountries(string bitlink, map<string|string[]> headers, *GetMetricsForBitlinkByCountriesQueries queries) returns ClickMetrics|errorGet Metrics for a Bitlink by Country
Parameters
- bitlink string - A Bitlink made of the domain and hash
- queries *GetMetricsForBitlinkByCountriesQueries - Queries to be sent with the request
Return Type
- ClickMetrics|error - SUCCESS
getMetricsForBitlinkByCities
function getMetricsForBitlinkByCities(string bitlink, map<string|string[]> headers, *GetMetricsForBitlinkByCitiesQueries queries) returns CityMetrics|errorGet Metrics for a Bitlink by City
Parameters
- bitlink string - A Bitlink made of the domain and hash
- queries *GetMetricsForBitlinkByCitiesQueries - Queries to be sent with the request
Return Type
- CityMetrics|error - SUCCESS
getMetricsForBitlinkByDevices
function getMetricsForBitlinkByDevices(string bitlink, map<string|string[]> headers, *GetMetricsForBitlinkByDevicesQueries queries) returns DeviceMetrics|errorGet Metrics for a Bitlink by Device Type
Parameters
- bitlink string - A Bitlink made of the domain and hash
- queries *GetMetricsForBitlinkByDevicesQueries - Queries to be sent with the request
Return Type
- DeviceMetrics|error - SUCCESS
getMetricsForBitlinkByReferrers
function getMetricsForBitlinkByReferrers(string bitlink, map<string|string[]> headers, *GetMetricsForBitlinkByReferrersQueries queries) returns ClickMetrics|errorGet Metrics for a Bitlink by Referrers
Parameters
- bitlink string - A Bitlink made of the domain and hash
- queries *GetMetricsForBitlinkByReferrersQueries - Queries to be sent with the request
Return Type
- ClickMetrics|error - SUCCESS
getMetricsForBitlinkByReferrerName
function getMetricsForBitlinkByReferrerName(string bitlink, map<string|string[]> headers, *GetMetricsForBitlinkByReferrerNameQueries queries) returns ClickMetrics|errorGet Metrics for a Bitlink by Referrer Name
Parameters
- bitlink string - A Bitlink made of the domain and hash
- queries *GetMetricsForBitlinkByReferrerNameQueries - Queries to be sent with the request
Return Type
- ClickMetrics|error - SUCCESS
getBitlinkReferringDomains
function getBitlinkReferringDomains(string bitlink, map<string|string[]> headers, *GetBitlinkReferringDomainsQueries queries) returns ClickMetrics|errorGet Metrics for a Bitlink by Referring Domains
Parameters
- bitlink string - A Bitlink made of the domain and hash
- queries *GetBitlinkReferringDomainsQueries - Queries to be sent with the request
Return Type
- ClickMetrics|error - SUCCESS
getBitlinkReferrersByDomains
function getBitlinkReferrersByDomains(string bitlink, map<string|string[]> headers, *GetBitlinkReferrersByDomainsQueries queries) returns ReferrersByDomains|errorGet Metrics for a Bitlink by Referrers by Domain
Parameters
- bitlink string - A Bitlink made of the domain and hash
- queries *GetBitlinkReferrersByDomainsQueries - Queries to be sent with the request
Return Type
- ReferrersByDomains|error - SUCCESS
addCustomBitlink
function addCustomBitlink(AddCustomBitlink payload, map<string|string[]> headers) returns CustomBitlink|errorAdd Custom Bitlink
Parameters
- payload AddCustomBitlink - Bitlink and the custom Bitlink back-half to attach to it
Return Type
- CustomBitlink|error - SUCCESS
getCustomBitlink
function getCustomBitlink(string customBitlink, map<string|string[]> headers) returns CustomBitlink|errorRetrieve Custom Bitlink
Parameters
- customBitlink string - A Custom Bitlink made of the domain and keyword
Return Type
- CustomBitlink|error - SUCCESS
updateCustomBitlink
function updateCustomBitlink(string customBitlink, UpdateCustomBitlink payload, map<string|string[]> headers) returns CustomBitlink|errorUpdate Custom Bitlink
Parameters
- customBitlink string - A Custom Bitlink made of the domain and keyword
- payload UpdateCustomBitlink - Bitlink that the custom Bitlink should point to
Return Type
- CustomBitlink|error - SUCCESS
getCustomBitlinkMetricsByDestination
function getCustomBitlinkMetricsByDestination(string customBitlink, map<string|string[]> headers, *GetCustomBitlinkMetricsByDestinationQueries queries) returns ClickMetrics|errorGet Metrics for a Custom Bitlink by Destination
Parameters
- customBitlink string - A Custom Bitlink made of the domain and keyword
- queries *GetCustomBitlinkMetricsByDestinationQueries - Queries to be sent with the request
Return Type
- ClickMetrics|error - SUCCESS
getClicksForCustomBitlink
function getClicksForCustomBitlink(string customBitlink, map<string|string[]> headers, *GetClicksForCustomBitlinkQueries queries) returns Clicks|errorGet Clicks for a Custom Bitlink's Entire History
Parameters
- customBitlink string - A Custom Bitlink made of the domain and keyword
- queries *GetClicksForCustomBitlinkQueries - Queries to be sent with the request
getGroups
Retrieve Groups
Parameters
- queries *GetGroupsQueries - Queries to be sent with the request
getGroup
Retrieve a Group
Parameters
- groupGuid string - A GUID for a Bitly group
updateGroup
function updateGroup(string groupGuid, GroupUpdate payload, map<string|string[]> headers) returns Group|errorUpdate a Group
Parameters
- groupGuid string - A GUID for a Bitly group
- payload GroupUpdate - Group settings to change, such as its name, organization and branded short domains
getGroupTags
function getGroupTags(string groupGuid, map<string|string[]> headers, *GetGroupTagsQueries queries) returns Tags|errorRetrieve Tags by Group
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupTagsQueries - Queries to be sent with the request
getBitlinksByGroup
function getBitlinksByGroup(string groupGuid, map<string|string[]> headers, *GetBitlinksByGroupQueries queries) returns Bitlinks|errorRetrieve Bitlinks by Group
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetBitlinksByGroupQueries - Queries to be sent with the request
updateBitlinksByGroup
function updateBitlinksByGroup(string groupGuid, BulkUpdateRequest payload, map<string|string[]> headers) returns BulkUpdate|errorBulk update bitlinks
Parameters
- groupGuid string - A GUID for a Bitly group
- payload BulkUpdateRequest - Bulk action to apply to a set of Bitlinks in the group, such as archiving or editing tags
Return Type
- BulkUpdate|error - SUCCESS
getTopLinksAndQRCodesByEngagements
function getTopLinksAndQRCodesByEngagements(string groupGuid, map<string|string[]> headers, *GetTopLinksAndQRCodesByEngagementsQueries queries) returns TopLinksAndQRCodes|errorRetrieve Top Links and Decoupled QR Codes by Engagements
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetTopLinksAndQRCodesByEngagementsQueries - Queries to be sent with the request
Return Type
- TopLinksAndQRCodes|error - SUCCESS
getSortedBitlinks
function getSortedBitlinks(string groupGuid, "clicks" sort, map<string|string[]> headers, *GetSortedBitlinksQueries queries) returns SortedLinks|errorRetrieve Sorted Bitlinks for Group
Parameters
- groupGuid string - A GUID for a Bitly group
- sort "clicks" - The type of sorting that you would like to do
- queries *GetSortedBitlinksQueries - Queries to be sent with the request
Return Type
- SortedLinks|error - SUCCESS
getGroupPreferences
function getGroupPreferences(string groupGuid, map<string|string[]> headers) returns GroupPreferences|errorRetrieve Group Preferences
Parameters
- groupGuid string - A GUID for a Bitly group
Return Type
- GroupPreferences|error - SUCCESS
updateGroupPreferences
function updateGroupPreferences(string groupGuid, GroupPreferences payload, map<string|string[]> headers) returns GroupPreferences|errorUpdate Group Preferences
Parameters
- groupGuid string - A GUID for a Bitly group
- payload GroupPreferences - Group preferences to change, such as the default domain for new Bitlinks
Return Type
- GroupPreferences|error - SUCCESS
getGroupShortenCounts
function getGroupShortenCounts(string groupGuid, map<string|string[]> headers, *GetGroupShortenCountsQueries queries) returns Metrics|errorRetrieve Group Shorten Counts
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupShortenCountsQueries - Queries to be sent with the request
getGroupMetricsByCountries
function getGroupMetricsByCountries(string groupGuid, map<string|string[]> headers, *GetGroupMetricsByCountriesQueries queries) returns ClickMetrics|errorGet Click Metrics for a Group by Country
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupMetricsByCountriesQueries - Queries to be sent with the request
Return Type
- ClickMetrics|error - SUCCESS
getGroupMetricsByCities
function getGroupMetricsByCities(string groupGuid, map<string|string[]> headers, *GetGroupMetricsByCitiesQueries queries) returns CityMetrics|errorGet Click Metrics for a Group by City
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupMetricsByCitiesQueries - Queries to be sent with the request
Return Type
- CityMetrics|error - SUCCESS
getGroupMetricsByDevices
function getGroupMetricsByDevices(string groupGuid, map<string|string[]> headers, *GetGroupMetricsByDevicesQueries queries) returns DeviceMetrics|errorGet Click Metrics for a Group by Device Type
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupMetricsByDevicesQueries - Queries to be sent with the request
Return Type
- DeviceMetrics|error - SUCCESS
getGroupMetricsByReferringNetworks
function getGroupMetricsByReferringNetworks(string groupGuid, map<string|string[]> headers, *GetGroupMetricsByReferringNetworksQueries queries) returns ClickMetrics|errorGet Click Metrics for a Group by Referring Networks
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupMetricsByReferringNetworksQueries - Queries to be sent with the request
Return Type
- ClickMetrics|error - SUCCESS
getGroupMetricsByReferrer
function getGroupMetricsByReferrer(string groupGuid, map<string|string[]> headers, *GetGroupMetricsByReferrerQueries queries) returns ClickMetrics|errorGet Click Metrics for a Group by Referrer
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupMetricsByReferrerQueries - Queries to be sent with the request
Return Type
- ClickMetrics|error - SUCCESS
getGroupTopMetrics
function getGroupTopMetrics(string groupGuid, map<string|string[]> headers, *GetGroupTopMetricsQueries queries) returns SortedLinks|errorGet Group Top Performing Links by Engagement
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupTopMetricsQueries - Queries to be sent with the request
Return Type
- SortedLinks|error - SUCCESS
getGroupMetricsOverTime
function getGroupMetricsOverTime(string groupGuid, map<string|string[]> headers, *GetGroupMetricsOverTimeQueries queries) returns GroupClicks|errorGet Group Metrics Over Time
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupMetricsOverTimeQueries - Queries to be sent with the request
Return Type
- GroupClicks|error - SUCCESS
getGroupClicks
function getGroupClicks(string groupGuid, map<string|string[]> headers, *GetGroupClicksQueries queries) returns GroupClicks|errorGet clicks by group
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupClicksQueries - Queries to be sent with the request
Return Type
- GroupClicks|error - SUCCESS
createGroupExport
function createGroupExport(string groupGuid, GroupExportRequestBody payload, map<string|string[]> headers) returns GroupExportResponse|errorCreate an inline CSV export for a group
Parameters
- groupGuid string - A GUID for a Bitly group
- payload GroupExportRequestBody - Export request describing what to export, the time range, filters and whether to include metrics
Return Type
- GroupExportResponse|error - OK
getOrganizations
function getOrganizations(map<string|string[]> headers, *GetOrganizationsQueries queries) returns Organizations|errorRetrieve Organizations
Parameters
- queries *GetOrganizationsQueries - Queries to be sent with the request
Return Type
- Organizations|error - SUCCESS
getOrganization
function getOrganization(string organizationGuid, map<string|string[]> headers) returns Organization|errorRetrieve an Organization
Parameters
- organizationGuid string - A GUID for a Bitly organization
Return Type
- Organization|error - SUCCESS
getOrganizationShortenCounts
function getOrganizationShortenCounts(string organizationGuid, map<string|string[]> headers, *GetOrganizationShortenCountsQueries queries) returns Metrics|errorGet Shorten Counts for an Organization
Parameters
- organizationGuid string - A GUID for a Bitly organization
- queries *GetOrganizationShortenCountsQueries - Queries to be sent with the request
getOrganizationShortenCountsByGroup
function getOrganizationShortenCountsByGroup(string organizationGuid, map<string|string[]> headers) returns Metrics|errorGet Shorten Counts for an Organization by Group
Parameters
- organizationGuid string - A GUID for a Bitly organization
getCustomDomain
function getCustomDomain(string customDomain, map<string|string[]> headers) returns CustomDomainBody|errorGet a custom domain
Parameters
- customDomain string - a custom domain on your account
Return Type
- CustomDomainBody|error - SUCCESS
editCustomDomain
function editCustomDomain(string customDomain, DomainUpdate payload, map<string|string[]> headers) returns CustomDomainBody|errorEdit a custom domain
Parameters
- customDomain string - a custom domain on your account
- payload DomainUpdate - Custom domain settings to change, such as redirects and HTTPS options
Return Type
- CustomDomainBody|error - SUCCESS. The domain with the new settings applied
getCustomDomains
function getCustomDomains(map<string|string[]> headers, *GetCustomDomainsQueries queries) returns CustomDomains|errorGet custom domains for an organization
Parameters
- queries *GetCustomDomainsQueries - Queries to be sent with the request
Return Type
- CustomDomains|error - SUCCESS
validateCustomDomain
function validateCustomDomain(DomainValidateBody payload, map<string|string[]> headers) returns DomainValidate|errorAdd a custom domain you own
Parameters
- payload DomainValidateBody - Custom domain to validate, with the organization and groups it belongs to
Return Type
- DomainValidate|error - SUCCESS. The domain is already on the organization, so it was queued for another DNS check and nothing was created
getCustomDomainDNS
function getCustomDomainDNS(string customDomain, map<string|string[]> headers, *GetCustomDomainDNSQueries queries) returns DomainDNS|errorGet the DNS records for a custom domain
Parameters
- customDomain string - a custom domain on your account
- queries *GetCustomDomainDNSQueries - Queries to be sent with the request
getUser
Retrieve a User
updateUser
Update a User
Parameters
- payload UserUpdate - User profile fields to change, such as the name and default group
getCampaigns
function getCampaigns(map<string|string[]> headers, *GetCampaignsQueries queries) returns Campaigns|errorRetrieve Campaigns
Parameters
- queries *GetCampaignsQueries - Queries to be sent with the request
createCampaign
function createCampaign(CampaignModify payload, map<string|string[]> headers) returns Campaign|errorCreate Campaign
Parameters
- payload CampaignModify - Details of the campaign to create, such as its name, description, group and channels
getCampaign
Retrieve a Campaign
Parameters
- campaignGuid string - A GUID for a Bitly campaign
updateCampaign
function updateCampaign(string campaignGuid, CampaignModify payload, map<string|string[]> headers) returns Campaign|errorUpdate Campaign
Parameters
- campaignGuid string - A GUID for a Bitly campaign
- payload CampaignModify - Campaign fields to change, such as its name, description and channels
getChannels
function getChannels(map<string|string[]> headers, *GetChannelsQueries queries) returns Channels|errorRetrieve Channels
Parameters
- queries *GetChannelsQueries - Queries to be sent with the request
createChannel
Create Channel
Parameters
- payload ChannelModify - Details of the channel to create, with the Bitlinks to add to it
getChannel
Get a Channel
Parameters
- channelGuid string - A GUID for a Bitly Channel
updateChannel
function updateChannel(string channelGuid, ChannelModify payload, map<string|string[]> headers) returns Channel|errorUpdate a Channel
Parameters
- channelGuid string - A GUID for a Bitly Channel
- payload ChannelModify - Channel fields to change, with the Bitlinks to add to it
addChannelBitlinks
function addChannelBitlinks(string channelGuid, AddChannelBitlinksRequest payload, map<string|string[]> headers) returns AddChannelBitlinksResponse|errorAdd Bitlinks to a Channel
Parameters
- channelGuid string - A GUID for a Bitly Channel
- payload AddChannelBitlinksRequest - Bitlinks to add to the channel, and the campaign they belong to
Return Type
- AddChannelBitlinksResponse|error - SUCCESS
getOAuthApp
Retrieve OAuth App
Parameters
- clientId string - The client ID of an OAuth app
getBSDs
function getBSDs(map<string|string[]> headers) returns BSDsResponse|errorGet the custom domains you can shorten with
Return Type
- BSDsResponse|error - SUCCESS
searchAvailableDomains
function searchAvailableDomains(map<string|string[]> headers, *SearchAvailableDomainsQueries queries) returns BSDSearchResults|errorSearch for a domain to register
Parameters
- queries *SearchAvailableDomainsQueries - Queries to be sent with the request
Return Type
- BSDSearchResults|error - SUCCESS
purchaseBsd
function purchaseBsd(PurchaseBSD payload, map<string|string[]> headers) returns PurchaseBSDResponse|errorRegister a domain for an organization
Parameters
- payload PurchaseBSD - Branded short domain to purchase, with the accepted agreement keys and the organization that buys it
Return Type
- PurchaseBSDResponse|error - CREATED
fetchDomainAgreements
function fetchDomainAgreements(string domain, map<string|string[]> headers, *FetchDomainAgreementsQueries queries) returns DomainAgreements|errorGet Purchase Agreements
Parameters
- domain string - a web domain
- queries *FetchDomainAgreementsQueries - Queries to be sent with the request
Return Type
- DomainAgreements|error - SUCCESS
getWebhooks
Get Webhooks
Parameters
- organizationGuid string - A GUID for a Bitly organization
createWebhook
Create Webhook
Parameters
- payload WebhookCreate - Details of the webhook to create, such as its name, event, callback URL, organization and group
getWebhook
Retrieve Webhook
Parameters
- webhookGuid string - A GUID for a Bitly webhook
deleteWebhook
Delete Webhook
Parameters
- webhookGuid string - A GUID for a Bitly webhook
Return Type
- error? - SUCCESS
updateWebhook
function updateWebhook(string webhookGuid, WebhookUpdate payload, map<string|string[]> headers) returns Webhook|errorUpdate Webhook
Parameters
- webhookGuid string - A GUID for a Bitly webhook
- payload WebhookUpdate - Webhook fields to change, such as its name, event, callback URL and active state
verifyWebhook
Verify Webhook
Parameters
- webhookGuid string - A GUID for a Bitly webhook
getPlanLimits
function getPlanLimits(string organizationGuid, map<string|string[]> headers) returns PlanLimits|errorGet Plan Limits
Parameters
- organizationGuid string - A GUID for a Bitly organization
Return Type
- PlanLimits|error - SUCCESS
getPlatformLimits
function getPlatformLimits(map<string|string[]> headers, *GetPlatformLimitsQueries queries) returns PlatformLimits|errorGet Platform Limits
Parameters
- queries *GetPlatformLimitsQueries - Queries to be sent with the request
Return Type
- PlatformLimits|error - SUCCESS
createSite
Creates a New Bitly Site for a Group
Parameters
- payload CreateLaunchpad - Details of the Bitly Page to create, such as the group, domain and keyword
getTemplates
function getTemplates(map<string|string[]> headers, *GetTemplatesQueries queries) returns Template[]|errorRetrieve's Bitly templates
Parameters
- queries *GetTemplatesQueries - Queries to be sent with the request
applyTemplate
function applyTemplate(string siteId, ApplyTemplateRequest payload, map<string|string[]> headers) returns BitlySite|errorApply a template to a site
Parameters
- siteId string - A GUID for a Bitly Site
- payload ApplyTemplateRequest - Template to apply to the Bitly Page
getSite
function getSite(string siteId, map<string|string[]> headers, *GetSiteQueries queries) returns BitlySiteWithBlocks|errorRetrieve All Data Necessary To Render a Bitly Site
Parameters
- siteId string - A GUID for a Bitly Site
- queries *GetSiteQueries - Queries to be sent with the request
Return Type
- BitlySiteWithBlocks|error - SUCCESS
deleteSite
Deletes an existing Site
Parameters
- siteId string - A GUID for a Bitly Site
Return Type
- error? - NO_CONTENT
updateSite
function updateSite(string siteId, UpdateSite payload, map<string|string[]> headers) returns BitlySite|errorUpdates an existing Bitly Site
Parameters
- siteId string - A GUID for a Bitly Site
- payload UpdateSite - Bitly Page fields to change, such as the URI, display name and description
updateSiteAppearance
function updateSiteAppearance(string siteId, BitlySiteAppearance payload, map<string|string[]> headers) returns error?Update the appearance of a Bitly Site
Parameters
- siteId string - A GUID for a Bitly Site
- payload BitlySiteAppearance - Appearance settings for the Bitly Page, such as the theme, layout, font and header
Return Type
- error? - SUCCESS
publishSite
Publishes a Draft Site to become Production Site
Parameters
- siteId string - A GUID for a Bitly Site
cloneSite
function cloneSite(string siteId, SiteCloneRequest payload, map<string|string[]> headers) returns BitlySite|errorClone a Bitly Site from an existing one
Parameters
- siteId string - A GUID for a Bitly Site
- payload SiteCloneRequest - URI for the cloned Bitly Page
discardSiteDraft
Discard a Site Draft
Parameters
- siteId string - A GUID for a Bitly Site
Return Type
- error? - SUCCESS
getSitesForGroup
function getSitesForGroup(string groupGuid, map<string|string[]> headers, *GetSitesForGroupQueries queries) returns BitlySites|errorGet Bitly Sites for Group
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetSitesForGroupQueries - Queries to be sent with the request
Return Type
- BitlySites|error - SUCCESS
deleteSiteRedirect
function deleteSiteRedirect(string siteId, string domain, string keyword, map<string|string[]> headers) returns error?Delete a redirect for a site
Parameters
- siteId string - A GUID for a Bitly Site
- domain string - The custom domain the redirect is configured on
- keyword string - The keyword (back-half) of the redirect to delete
Return Type
- error? - SUCCESS
createContainer
function createContainer(string siteId, SiteBlockContainerRequest payload, map<string|string[]> headers) returns SiteBlock|errorCreates a container
Parameters
- siteId string - A GUID for a Bitly Site
- payload SiteBlockContainerRequest - Type of container block to add to the Bitly Page
createSiteBlock
function createSiteBlock(string siteId, SiteBlockCreateRequest payload, map<string|string[]> headers) returns SiteBlock|errorCreate a block on the provided Site ID
Parameters
- siteId string - A GUID for a Bitly Site
- payload SiteBlockCreateRequest - Content block to add to the Bitly Page, with its type and content
deleteSiteBlock
function deleteSiteBlock(string siteId, string blockId, map<string|string[]> headers) returns error?Delete Site Block
Parameters
- siteId string - A GUID for a Bitly Site
- blockId string - A GUID for a Bitly Site content block
Return Type
- error? - NO_CONTENT
updateSiteBlock
function updateSiteBlock(string siteId, string blockId, SiteBlockRequest payload, map<string|string[]> headers) returns SiteBlock|errorUpdate a block on the provided Site ID
Parameters
- siteId string - A GUID for a Bitly Site
- blockId string - A GUID for a Bitly Site content block
- payload SiteBlockRequest - Block fields to change, such as its content, appearance, schedule and pinned state
prevalidateYouTubeVideoButton
function prevalidateYouTubeVideoButton(string launchpadId, PrevalidateYouTubeVideoRequest payload, map<string|string[]> headers) returns YoutubeVideoRequest|errorPrevalidate a youtube video button
Parameters
- launchpadId string - A GUID for a Bitly Link Launchpad
- payload PrevalidateYouTubeVideoRequest - YouTube video to validate before it is used as a button
Return Type
- YoutubeVideoRequest|error - SUCCESS
createSiteImage
function createSiteImage(string siteId, SiteImageUpload payload, map<string|string[]> headers) returns ImageUploadResponse|errorCreate a microsite image for a site
Parameters
- siteId string - A GUID for a Bitly Site
- payload SiteImageUpload - Image to add to the Bitly Page, given by upload GUID or URL, with its intended use and crop
Return Type
- ImageUploadResponse|error - CREATED
getAggregateSitesOverview
function getAggregateSitesOverview(map<string|string[]> headers, *GetAggregateSitesOverviewQueries queries) returns SitesOverview|errorGet Overview Metrics for Sites
Parameters
- queries *GetAggregateSitesOverviewQueries - Queries to be sent with the request
Return Type
- SitesOverview|error - SUCCESS
getAggregateSiteViewsOverTime
function getAggregateSiteViewsOverTime(map<string|string[]> headers, *GetAggregateSiteViewsOverTimeQueries queries) returns AggregateClicksForBitlinks|errorGet Site Views Over Time
Parameters
- queries *GetAggregateSiteViewsOverTimeQueries - Queries to be sent with the request
Return Type
- AggregateClicksForBitlinks|error - SUCCESS
getAggregateSiteViewsByCity
function getAggregateSiteViewsByCity(map<string|string[]> headers, *GetAggregateSiteViewsByCityQueries queries) returns AggregateClicksForBitlinksByCitiesFacet|errorGet Site Views by City
Parameters
- queries *GetAggregateSiteViewsByCityQueries - Queries to be sent with the request
Return Type
- AggregateClicksForBitlinksByCitiesFacet|error - SUCCESS
getAggregateSiteViewsByCountry
function getAggregateSiteViewsByCountry(map<string|string[]> headers, *GetAggregateSiteViewsByCountryQueries queries) returns AggregateClicksForBitlinksByFacet|errorGet Site Views by Country
Parameters
- queries *GetAggregateSiteViewsByCountryQueries - Queries to be sent with the request
Return Type
- AggregateClicksForBitlinksByFacet|error - SUCCESS
getAggregateSiteViewsByDevice
function getAggregateSiteViewsByDevice(map<string|string[]> headers, *GetAggregateSiteViewsByDeviceQueries queries) returns AggregateClicksForBitlinksByFacet|errorGet Site Views by Device
Parameters
- queries *GetAggregateSiteViewsByDeviceQueries - Queries to be sent with the request
Return Type
- AggregateClicksForBitlinksByFacet|error - SUCCESS
getAggregateSiteViewsByReferrer
function getAggregateSiteViewsByReferrer(map<string|string[]> headers, *GetAggregateSiteViewsByReferrerQueries queries) returns AggregateClicksForBitlinksByFacet|errorGet Site Views by Referrer
Parameters
- queries *GetAggregateSiteViewsByReferrerQueries - Queries to be sent with the request
Return Type
- AggregateClicksForBitlinksByFacet|error - SUCCESS
getSiteClicksOverTime
function getSiteClicksOverTime(map<string|string[]> headers, *GetSiteClicksOverTimeQueries queries) returns AggregateClicksForBitlinks|errorGet Site Button Clicks Over Time
Parameters
- queries *GetSiteClicksOverTimeQueries - Queries to be sent with the request
Return Type
- AggregateClicksForBitlinks|error - SUCCESS
getSiteClicksByCities
function getSiteClicksByCities(map<string|string[]> headers, *GetSiteClicksByCitiesQueries queries) returns AggregateClicksForBitlinksByCitiesFacet|errorGet Site Button Clicks by City
Parameters
- queries *GetSiteClicksByCitiesQueries - Queries to be sent with the request
Return Type
- AggregateClicksForBitlinksByCitiesFacet|error - SUCCESS
getSiteClicksByCountries
function getSiteClicksByCountries(map<string|string[]> headers, *GetSiteClicksByCountriesQueries queries) returns AggregateClicksForBitlinksByFacet|errorGet Site Button Clicks by Country
Parameters
- queries *GetSiteClicksByCountriesQueries - Queries to be sent with the request
Return Type
- AggregateClicksForBitlinksByFacet|error - SUCCESS
getSiteClicksByDevices
function getSiteClicksByDevices(map<string|string[]> headers, *GetSiteClicksByDevicesQueries queries) returns AggregateClicksForBitlinksByFacet|errorGet Site Button Clicks by Device
Parameters
- queries *GetSiteClicksByDevicesQueries - Queries to be sent with the request
Return Type
- AggregateClicksForBitlinksByFacet|error - SUCCESS
getSiteFilteredTopPageButtons
function getSiteFilteredTopPageButtons(map<string|string[]> headers, *GetSiteFilteredTopPageButtonsQueries queries) returns SortedButtons|errorGet Top Performing Site Buttons by Clicks
Parameters
- queries *GetSiteFilteredTopPageButtonsQueries - Queries to be sent with the request
Return Type
- SortedButtons|error - SUCCESS
getMetricsForSitesByCountries
function getMetricsForSitesByCountries(string siteId, map<string|string[]> headers, *GetMetricsForSitesByCountriesQueries queries) returns SiteViewMetrics|errorGet Metrics for a Site by Country
Parameters
- siteId string - A GUID for a Bitly Site
- queries *GetMetricsForSitesByCountriesQueries - Queries to be sent with the request
Return Type
- SiteViewMetrics|error - SUCCESS
getMetricsForSiteByCities
function getMetricsForSiteByCities(string siteId, map<string|string[]> headers, *GetMetricsForSiteByCitiesQueries queries) returns SiteCityViewMetrics|errorGet Metrics for a Site by City
Parameters
- siteId string - A GUID for a Bitly Site
- queries *GetMetricsForSiteByCitiesQueries - Queries to be sent with the request
Return Type
- SiteCityViewMetrics|error - SUCCESS
getMetricsForSiteByDevices
function getMetricsForSiteByDevices(string siteId, map<string|string[]> headers, *GetMetricsForSiteByDevicesQueries queries) returns SiteViewMetrics|errorGet Metrics for a Site by Device Type
Parameters
- siteId string - A GUID for a Bitly Site
- queries *GetMetricsForSiteByDevicesQueries - Queries to be sent with the request
Return Type
- SiteViewMetrics|error - SUCCESS
getMetricsForSiteByReferrers
function getMetricsForSiteByReferrers(string siteId, map<string|string[]> headers, *GetMetricsForSiteByReferrersQueries queries) returns SiteViewMetrics|errorGet Metrics for a Site by Referrers
Parameters
- siteId string - A GUID for a Bitly Site
- queries *GetMetricsForSiteByReferrersQueries - Queries to be sent with the request
Return Type
- SiteViewMetrics|error - SUCCESS
getDigitalCardDownloadsOverTime
function getDigitalCardDownloadsOverTime(map<string|string[]> headers, *GetDigitalCardDownloadsOverTimeQueries queries) returns AggregateClicksForBitlinks|errorGet Site Digital Business Card Downloads Over Time
Parameters
- queries *GetDigitalCardDownloadsOverTimeQueries - Queries to be sent with the request
Return Type
- AggregateClicksForBitlinks|error - SUCCESS
getLinkPerformanceForSite
function getLinkPerformanceForSite(string siteId, map<string|string[]> headers, *GetLinkPerformanceForSiteQueries queries) returns SiteLinkPerformance|errorGet Link Performance counts for a Site
Parameters
- siteId string - A GUID for a Bitly Site
- queries *GetLinkPerformanceForSiteQueries - Queries to be sent with the request
Return Type
- SiteLinkPerformance|error - SUCCESS
getViewsForSite
function getViewsForSite(string siteId, map<string|string[]> headers, *GetViewsForSiteQueries queries) returns SiteViewMetrics|errorGet Views for a Site
Parameters
- siteId string - A GUID for a Bitly Site
- queries *GetViewsForSiteQueries - Queries to be sent with the request
Return Type
- SiteViewMetrics|error - SUCCESS
getViewsSummaryForSite
function getViewsSummaryForSite(string siteId, map<string|string[]> headers, *GetViewsSummaryForSiteQueries queries) returns SiteViewsSummary|errorGet a Views Summary for a Site
Parameters
- siteId string - A GUID for a Bitly Site
- queries *GetViewsSummaryForSiteQueries - Queries to be sent with the request
Return Type
- SiteViewsSummary|error - SUCCESS
createQRCodePublic
function createQRCodePublic(PublicCreateQRCodeRequest payload, map<string|string[]> headers) returns QRCodeMinimal|errorCreate a QR Code
Parameters
- payload PublicCreateQRCodeRequest - Details of the QR code to create, such as its destination, title, group and appearance
Return Type
- QRCodeMinimal|error - CREATED
createStaticQRCodePublic
function createStaticQRCodePublic(PublicCreateStaticQRCodeRequest payload, CreateStaticQRCodePublicHeaders headers, *CreateStaticQRCodePublicQueries queries) returns PublicStaticQRCodeResponse|errorGenerate a static QR Code image
Parameters
- payload PublicCreateStaticQRCodeRequest - Content to encode in the static QR code image, with the optional appearance settings
- headers CreateStaticQRCodePublicHeaders (default {}) - Headers to be sent with the request
- queries *CreateStaticQRCodePublicQueries - Queries to be sent with the request
Return Type
- PublicStaticQRCodeResponse|error - SUCCESS
getQRCodeImagePublic
function getQRCodeImagePublic(string qrcodeId, GetQRCodeImagePublicHeaders headers, *GetQRCodeImagePublicQueries queries) returns PublicQRCodeImageResponse|errorRetrieve a QR Code image
Parameters
- qrcodeId string - The QR Code ID
- headers GetQRCodeImagePublicHeaders (default {}) - Headers to be sent with the request
- queries *GetQRCodeImagePublicQueries - Queries to be sent with the request
Return Type
- PublicQRCodeImageResponse|error - SUCCESS
getQRCodeByIdPublic
function getQRCodeByIdPublic(string qrcodeId, map<string|string[]> headers) returns QRCodeDetails|errorRetrieve a QR Code
Parameters
- qrcodeId string - The QR Code ID
Return Type
- QRCodeDetails|error - SUCCESS
deleteQRCode
function deleteQRCode(string qrcodeId, map<string|string[]> headers) returns PublicDeleteQRCodeResponse|errorDelete a QR Code
Parameters
- qrcodeId string - The QR Code ID
Return Type
- PublicDeleteQRCodeResponse|error - SUCCESS
updateQRCodePublic
function updateQRCodePublic(string qrcodeId, PublicUpdateQRCodeRequest payload, map<string|string[]> headers) returns QRCodeMinimal|errorUpdate a QR Code
Parameters
- qrcodeId string - The QR code ID
- payload PublicUpdateQRCodeRequest - QR code fields to change, such as the title, appearance, archived state, expiration and tags
Return Type
- QRCodeMinimal|error - SUCCESS
listQRMinimal
function listQRMinimal(string groupGuid, map<string|string[]> headers, *ListQRMinimalQueries queries) returns QRCodesMinimal|errorRetrieve QR Codes by Group
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *ListQRMinimalQueries - Queries to be sent with the request
Return Type
- QRCodesMinimal|error - SUCCESS
updateQRCodesByGroup
function updateQRCodesByGroup(string groupGuid, QRCBulkUpdateRequest payload, map<string|string[]> headers) returns QRCBulkUpdate|errorBulk update QR codes
Parameters
- groupGuid string - A GUID for a Bitly group
- payload QRCBulkUpdateRequest - Bulk action to apply to a set of QR codes in the group, such as archiving or editing tags
Return Type
- QRCBulkUpdate|error - SUCCESS
getScanMetricsForQRCode
function getScanMetricsForQRCode(string qrcodeId, map<string|string[]> headers, *GetScanMetricsForQRCodeQueries queries) returns BitlinkScans|errorGet Scans for a QR Code
Parameters
- qrcodeId string - The QR Code ID
- queries *GetScanMetricsForQRCodeQueries - Queries to be sent with the request
Return Type
- BitlinkScans|error - SUCCESS
getScanMetricsSummaryForQRCode
function getScanMetricsSummaryForQRCode(string qrcodeId, map<string|string[]> headers, *GetScanMetricsSummaryForQRCodeQueries queries) returns BitlinkScansSummary|errorGet Scans Summary for a QR Code
Parameters
- qrcodeId string - The QR Code ID
- queries *GetScanMetricsSummaryForQRCodeQueries - Queries to be sent with the request
Return Type
- BitlinkScansSummary|error - SUCCESS
getScanMetricsForQRCodeByCountries
function getScanMetricsForQRCodeByCountries(string qrcodeId, map<string|string[]> headers, *GetScanMetricsForQRCodeByCountriesQueries queries) returns ScanMetrics|errorGet Scans for a QR Code by Country
Parameters
- qrcodeId string - The QR Code ID
- queries *GetScanMetricsForQRCodeByCountriesQueries - Queries to be sent with the request
Return Type
- ScanMetrics|error - SUCCESS
getScanMetricsForQRCodeByCities
function getScanMetricsForQRCodeByCities(string qrcodeId, map<string|string[]> headers, *GetScanMetricsForQRCodeByCitiesQueries queries) returns CityScanMetrics|errorGet Metrics for a QR Code by City
Parameters
- qrcodeId string - The QR Code ID
- queries *GetScanMetricsForQRCodeByCitiesQueries - Queries to be sent with the request
Return Type
- CityScanMetrics|error - SUCCESS
getScanMetricsForQRCodeByDevicesOS
function getScanMetricsForQRCodeByDevicesOS(string qrcodeId, map<string|string[]> headers, *GetScanMetricsForQRCodeByDevicesOSQueries queries) returns ScanMetrics|errorGet Scans for a QR Code by Device OS
Parameters
- qrcodeId string - The QR Code ID
- queries *GetScanMetricsForQRCodeByDevicesOSQueries - Queries to be sent with the request
Return Type
- ScanMetrics|error - SUCCESS
getScanMetricsForQRCodeByBrowser
function getScanMetricsForQRCodeByBrowser(string qrcodeId, map<string|string[]> headers, *GetScanMetricsForQRCodeByBrowserQueries queries) returns ScanMetrics|errorGet Scans for a QR Code by Browser
Parameters
- qrcodeId string - The QR Code ID
- queries *GetScanMetricsForQRCodeByBrowserQueries - Queries to be sent with the request
Return Type
- ScanMetrics|error - SUCCESS
upgradeQRCodeToBitlink
function upgradeQRCodeToBitlink(string qrcodeId, map<string|string[]> headers) returns BitlinkBody|errorUpgrade a QR Code to a bitlink
Parameters
- qrcodeId string - The ID of the stand alone QR code to upgrade
Return Type
- BitlinkBody|error - SUCCESS
redirectQRCodeDestination
function redirectQRCodeDestination(string qrcodeId, RedirectQRCodeRequest payload, map<string|string[]> headers) returns QRCodeMinimal|errorRedirect a QR Code
Parameters
- qrcodeId string - The ID of the stand alone QR code whose destination changes
- payload RedirectQRCodeRequest - New destination URL for the QR code
Return Type
- QRCodeMinimal|error - SUCCESS
getGroupFeatureUsage
function getGroupFeatureUsage(string groupGuid, map<string|string[]> headers, *GetGroupFeatureUsageQueries queries) returns GroupFeatureUsage|errorGet limit usage for a group
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupFeatureUsageQueries - Queries to be sent with the request
Return Type
- GroupFeatureUsage|error - SUCCESS
getGroupHistoricalUsage
function getGroupHistoricalUsage(string groupGuid, map<string|string[]> headers, *GetGroupHistoricalUsageQueries queries) returns GroupHistoricalUsage|errorGet historical usage for a group
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupHistoricalUsageQueries - Queries to be sent with the request
Return Type
- GroupHistoricalUsage|error - SUCCESS
getGroupAgenticTrafficRollup
function getGroupAgenticTrafficRollup(string groupGuid, map<string|string[]> headers) returns GroupBitlinksCountRollup|errorGet Group Agentic Traffic Rollup
Parameters
- groupGuid string - A GUID for a Bitly group
Return Type
- GroupBitlinksCountRollup|error - SUCCESS
getGroupLinkClicksOverTime
function getGroupLinkClicksOverTime(string groupGuid, map<string|string[]> headers, *GetGroupLinkClicksOverTimeQueries queries) returns GroupClicks|errorGet Group Link Clicks Over Time
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupLinkClicksOverTimeQueries - Queries to be sent with the request
Return Type
- GroupClicks|error - SUCCESS
getGroupLinkClicksByDevice
function getGroupLinkClicksByDevice(string groupGuid, map<string|string[]> headers, *GetGroupLinkClicksByDeviceQueries queries) returns GroupDeviceClicks|errorGet Group Link Clicks by Device
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupLinkClicksByDeviceQueries - Queries to be sent with the request
Return Type
- GroupDeviceClicks|error - SUCCESS
getGroupLinkClicksByReferrer
function getGroupLinkClicksByReferrer(string groupGuid, map<string|string[]> headers, *GetGroupLinkClicksByReferrerQueries queries) returns ClickMetrics|errorGet Group Link Clicks by Referrer
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupLinkClicksByReferrerQueries - Queries to be sent with the request
Return Type
- ClickMetrics|error - SUCCESS
getGroupLinkClicksByCountry
function getGroupLinkClicksByCountry(string groupGuid, map<string|string[]> headers, *GetGroupLinkClicksByCountryQueries queries) returns ClickMetrics|errorGet Group Link Clicks by Country
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupLinkClicksByCountryQueries - Queries to be sent with the request
Return Type
- ClickMetrics|error - SUCCESS
getGroupLinkClicksByCity
function getGroupLinkClicksByCity(string groupGuid, map<string|string[]> headers, *GetGroupLinkClicksByCityQueries queries) returns CityMetrics|errorGet Group Link Clicks by City
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupLinkClicksByCityQueries - Queries to be sent with the request
Return Type
- CityMetrics|error - SUCCESS
getGroupTopLinkClicks
function getGroupTopLinkClicks(string groupGuid, map<string|string[]> headers, *GetGroupTopLinkClicksQueries queries) returns SortedLinks|errorGet Group Top Performing Links by Click
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupTopLinkClicksQueries - Queries to be sent with the request
Return Type
- SortedLinks|error - SUCCESS
getGroupCodeScansOverTime
function getGroupCodeScansOverTime(string groupGuid, map<string|string[]> headers, *GetGroupCodeScansOverTimeQueries queries) returns GroupClicks|errorGet Scan Metrics for a Group Over Time
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupCodeScansOverTimeQueries - Queries to be sent with the request
Return Type
- GroupClicks|error - SUCCESS
getGroupCodeScansByCountry
function getGroupCodeScansByCountry(string groupGuid, map<string|string[]> headers, *GetGroupCodeScansByCountryQueries queries) returns ClickMetrics|errorGet Scan Metrics for a Group by Country
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupCodeScansByCountryQueries - Queries to be sent with the request
Return Type
- ClickMetrics|error - SUCCESS
getGroupCodeScansByCity
function getGroupCodeScansByCity(string groupGuid, map<string|string[]> headers, *GetGroupCodeScansByCityQueries queries) returns CityMetrics|errorGet Scan Metrics for a Group by City
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupCodeScansByCityQueries - Queries to be sent with the request
Return Type
- CityMetrics|error - SUCCESS
getGroupTopCodeScans
function getGroupTopCodeScans(string groupGuid, map<string|string[]> headers, *GetGroupTopCodeScansQueries queries) returns GroupTopCodeScans|errorGet Top Performing QR Codes for a Group
Parameters
- groupGuid string - A GUID for a Bitly group
- queries *GetGroupTopCodeScansQueries - Queries to be sent with the request
Return Type
- GroupTopCodeScans|error - SUCCESS
Records
bitly: AddChannelBitlinksRequest
Fields
- campaignGuid string - The campaign to associate the given bitlinks with on this channel. All bitlinks in the request are associated with this single campaign_guid
- bitlinks string[] - Bitlink IDs to add to the channel, up to 100 per request. Bitlinks already associated with the channel are left untouched
bitly: AddChannelBitlinksResponse
Fields
- campaignGuid? string - The GUID of the campaign the bitlinks are associated with on this channel
- channelGuid? string - The GUID of the channel the bitlinks were added to
- bitlinks? string[] - Bitlink IDs now associated with the channel
bitly: AddCustomBitlink
Fields
- bitlinkId? string -
- customBitlink? string -
bitly: AggregateClicksForBitlinks
Fields
- unit? string -
- unitReference? string -
- clicks? ClicksForAggregate[] -
- units? decimal -
- info? string -
bitly: AggregateClicksForBitlinksByCitiesFacet
Fields
- unit? string -
- unitReference? string -
- totalsForTimePeriod? ClicksByCitiesFacet[] -
- units? decimal -
- facet? string -
- info? string -
bitly: AggregateClicksForBitlinksByFacet
Fields
- unit? string -
- unitReference? string -
- totalsForTimePeriod? ClicksByFacet[] -
- units? decimal -
- facet? string -
- info? string -
bitly: ApplyTemplateRequest
Fields
- templateGuid? string -
bitly: BaseChannel
Fields
- groupGuid? string -
- created? string - ISO TIMESTAMP
- name? string -
- guid? string -
- modified? string - ISO_TIMESTAMP
bitly: BaseChannelBitlink
Fields
- campaignGuid? string -
- bitlinkId? string -
bitly: BaseMetrics
Fields
- unit? string -
- unitReference? string -
- units? int -
- facet? "countries"|"cities"|"devices"|"referrers"|"referrers_by_domain"|"referring_domains"|"referring_networks"|"shorten_counts"|"destinations"|"agents" -
bitly: BaseScanMetrics
Fields
- unit? string -
- unitReference? string -
- units? int -
- facet? "countries"|"cities"|"device_os"|"browsers"|"destinations" -
bitly: BitlinkBody
Fields
- Fields Included from *HasReferences
- references record { string... }
- anydata...
- Fields Included from *BitlinkUpdate
- deeplinks DeeplinkRule[]
- dynamicRouting DynamicRoutingRule[]
- customBitlinks string[]
- campaignIds string[]
- link string
- createdAt string
- longUrl string
- title string
- createdBy string
- clientId string
- tags string[]
- launchpadIds string[]
- archived boolean
- qrCodeIds string[]
- isDeleted boolean
- id string
- expirationAt string
- anydata...
bitly: BitlinkContent
Fields
- bitlinkId? string - The bitlink ID (domain/hash) of the short link displayed on this block
- imageUrl? string - Public URL of the thumbnail image shown on this bitlink block
- imageGuid? string - GUID of the uploaded thumbnail image for this bitlink block
- description? string - Optional subtitle shown on the bitlink block, up to 255 characters
- linkTitle? string - Display title of the bitlink block, up to 255 characters
- crop? string - JSON-encoded crop rectangle for the thumbnail image, with Min and Max coordinates in the range 0-1
- isPinned? boolean - Whether this bitlink block is pinned to the top of the site
bitly: Bitlinks
Fields
- pagination? BitlinksPagination -
- links? BitlinkBody[] -
bitly: BitlinkScans
Fields
- unit? "minute"|"hour"|"day"|"week"|"month" -
- unitReference? string -
- scans? QRScans[] -
- units? int -
bitly: BitlinkScansSummary
Fields
- unit? "minute"|"hour"|"day"|"week"|"month" -
- unitReference? string -
- totalScans? int -
- units? int -
bitly: BitlinksPagination
Fields
- next? string -
- searchAfter? string -
- size? int -
bitly: BitlinkUpdate
Fields
- deeplinks? DeeplinkRule[] -
- dynamicRouting? DynamicRoutingRule[] - Dynamic routing rules for this bitlink. Only present when at least one rule is configured
- customBitlinks? string[] - list of previously edited backhalfs for the bitlink - these are in reverse chronological order, with the most recently edited backhalf first
- campaignIds? string[] -
- link? string -
- createdAt? string -
- longUrl? string -
- title? string -
- createdBy? string -
- clientId? string -
- tags? string[] -
- launchpadIds? string[] -
- archived? boolean -
- qrCodeIds? string[] - a list of qr code ids that are associated with this bitlink
- isDeleted? boolean -
- id? string -
- expirationAt? string - Optional expiration timestamp for the bitlink (e.g., 2025-01-28T14:30:00+0000)
bitly: BitlinkUpdateBody
Fields
- archived? boolean -
- deeplinks? DeeplinkRule[] -
- dynamicRouting? DynamicRoutingRule[] - Dynamic routing rules for this bitlink. Providing this field replaces all existing rules. Send an empty array to clear all rules
- title? string -
- longUrl? string -
- expirationAt? string - Optional expiration timestamp for the bitlink (e.g., 2025-01-28T14:30:00+0000). Minimum expiration time is 5 minutes from now and maximum is 1 year
- tags? string[] -
bitly: BitlySite
Fields
- groupGuid? string -
- buttonCount? int -
- created? string -
- isEdited? boolean -
- url? string -
- content? BitlySiteContent -
- lastPublished? string -
- siteGuid? string -
- appearance? BitlySiteAppearance -
- redirects? SiteRedirects[] -
- qrCodeId? string -
- modified? string -
- status? string -
bitly: BitlySiteAppearance
Fields
- layoutV2? int -
- backgroundImageUrl? string -
- avatarImageUrl? string -
- defaultButtonShadow? string -
- avatarImageGuid? string -
- themeId? int -
- defaultSocialIconPosition? string -
- defaultButtonBackgroundColor? string -
- backgroundImageGuid? string -
- bottomBackgroundColor? string -
- descriptionColor? string -
- headerAppearance? BitlySiteHeaderAppearance -
- defaultSocialIconLayout? string -
- layout? string -
- hideBitlyLogo? boolean -
- backgroundImageAlignment? SiteImageAlignment -
- backgroundColor? string -
- stylePreference? SiteStylePreference -
- defaultButtonTextColor? string -
- textColor? string -
- backgroundPreference? string -
- defaultButtonShape? string -
- defaultSocialIconColor? string -
- font? string -
bitly: BitlySiteContent
Fields
- description? string -
- displayName? string -
bitly: BitlySiteHeaderAppearance
Fields
- profileImageShape? SiteProfileImageShape -
- textLocation? SiteTextLocation -
- profileImageType? SiteProfileImageType -
- titleSize? SiteTextSizeEnum -
- profileImageLocation? SiteProfileImageLocation -
- titleBorderType? SiteTextBorderTypeEnum -
- profileImageSize? SiteProfileImageSize -
- descriptionAlignment? SiteTextAlignmentEnum -
- bannerImageAlignment? SiteImageAlignment -
- descriptionWeight? SiteTextWeightEnum -
- headerBackgroundColor? string -
- titleAlignment? SiteTextAlignmentEnum -
- bannerType? SiteBannerType -
- titleWeight? SiteTextWeightEnum -
- headerStylePreference? SiteStylePreference -
- profileImageOverflow? boolean -
- bannerImageUrl? string -
- profileImageBorderSize? SiteProfileImageBorderSize -
- descriptionBorderType? SiteTextBorderTypeEnum -
- descriptionSize? SiteTextSizeEnum -
bitly: BitlySites
Fields
- groupGuid string -
- pagination? MicrositePagination - Specifies how to query the next set of results
- sites BitlySite[] -
bitly: BitlySiteWithBlocks
A Bitly Site plus its content blocks. Returned by getSite; the blocks field is only present when the request sets include_blocks to true
Fields
- Fields Included from *BitlySite
- groupGuid string
- buttonCount int
- created string
- isEdited boolean
- url string
- content BitlySiteContent
- lastPublished string
- siteGuid string
- appearance BitlySiteAppearance
- redirects SiteRedirects[]
- qrCodeId string
- modified string
- status string
- anydata...
- blocks? SiteBlock[] - The site's draft content blocks, ordered by container and then by sort order within that container. Blocks nested inside a grid or carousel carry that container's ID in container_id. The field is absent unless include_blocks is true, and is an empty array when the site has no blocks. Blocks taken down by a Bitly admin are not returned. Every other draft block is, including ones that do not appear on the published site: check is_active for blocks that are hidden or scheduled, and is_sample for template placeholders that are still missing their destination. A block with is_sample true never renders on the published site, regardless of is_active
bitly: BSDSearchResult
Fields
- domain? string -
bitly: BSDSearchResults
Fields
- results? BSDSearchResult[] -
- inputDomain? InputDomain -
bitly: BSDsResponse
Fields
- bsds? string[] -
bitly: BulkUpdate
Fields
- links? string[] -
bitly: BulkUpdateRequest
Fields
- addTags? string[] -
- removeTags? string[] -
- action "archive"|"edit_tags" - archive or edit_tags
- archive? boolean -
- links? string[] - this is limited to 100 bitlink ids
bitly: Campaign
Fields
- Fields Included from *HasReferences
- references record { string... }
- anydata...
- groupGuid? string -
- created? string - ISO timestamp
- name? string -
- guid? string -
- description? string -
- modified? string - ISO timestamp
- createdBy? string -
bitly: CampaignModify
Fields
- groupGuid? string -
- channelGuids? string[] -
- name? string -
- description? string -
bitly: Campaigns
Fields
- campaigns? Campaign[] -
bitly: Channel
Fields
- Fields Included from *BaseChannel
- Fields Included from *HasReferences
- references record { string... }
- anydata...
bitly: ChannelModify
Fields
- Fields Included from *BaseChannel
- bitlinks? BaseChannelBitlink[] -
bitly: Channels
Fields
- channels? Channel[] -
bitly: CityMetric
Fields
- country? string -
- city? string -
- subregion? string -
- clicks? int -
- region? string -
bitly: CityMetrics
Fields
- Fields Included from *BaseMetrics
- otherMetrics? OtherMetrics -
- metrics? CityMetric[] -
bitly: CityScanMetric
Fields
- country? string -
- scans? int -
- city? string -
- subregion? string -
- region? string -
bitly: CityScanMetrics
Fields
- Fields Included from *BaseScanMetrics
- otherMetrics? OtherScanMetrics -
- metrics? CityScanMetric[] -
bitly: ClickLink
Fields
- clicks? int -
- id? string -
bitly: ClickMetric
Fields
- clicks? int -
- value? string -
bitly: ClickMetrics
Fields
- Fields Included from *BaseMetrics
- metrics? ClickMetric[] -
bitly: Clicks
Fields
- unit? "minute"|"hour"|"day"|"week"|"month" -
- linkClicks? LinkClicks[] -
- unitReference? string -
- units? int -
bitly: ClicksByCitiesFacet
Fields
- country? string -
- city? string -
- subregion? string -
- clicks? decimal -
- region? string -
bitly: ClicksByFacet
Fields
- clicks? decimal -
- value? string -
bitly: ClicksForAggregate
Fields
- date? int -
- clicks? int -
bitly: ClicksSummary
Fields
- unit? "minute"|"hour"|"day"|"week"|"month" -
- unitReference? string -
- totalClicks? int -
- units? int -
bitly: ConnectionConfig
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(default {}) - Configurations related to HTTP/1.x protocol
- http2Settings ClientHttp2Settings(default {}) - Configurations related to HTTP/2 protocol
- timeout decimal(default 30) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- followRedirects? FollowRedirects - Configurations associated with Redirection
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache CacheConfig(default {}) - 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
- cookieConfig? CookieConfig - Configurations associated with cookies
- responseLimits ResponseLimitConfigs(default {}) - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- socketConfig ClientSocketConfig(default {}) - Provides settings related to client socket configuration
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
- laxDataBinding boolean(default true) - Enables relaxed data binding on the client side. When enabled,
nilvalues are treated as optional, and absent fields are handled asnilabletypes. Enabled by default.
bitly: CountItem
Fields
- count? int -
- ts? string -
bitly: CreateLaunchpad
@deprecated LL-2507
Fields
- groupGuid string - GUID of the group that owns the Bitly Page
- domain string - Branded short domain the Bitly Page is published on
- keyword string - Back-half keyword of the Bitly Page
- uri? string - URI of the Bitly Page
bitly: CreateStaticQRCodePublicHeaders
Represents the Headers record for the operation: createStaticQRCodePublic
Fields
- accept? "application/json"|"image/svg+xml"|"image/png" - Controls the response format. Use
application/json(default) to receive a JSON-wrapped base64 image,image/svg+xmlto receive the raw SVG, orimage/pngto receive the raw PNG
bitly: CreateStaticQRCodePublicQueries
Represents the Queries record for the operation: createStaticQRCodePublic
Fields
- format "svg"|"png" (default "svg") - The image format. Supports
svgandpng. Ignored if the Accept header specifies an image type
bitly: CustomBitlink
Fields
- bitlinkHistory? CustomBitlinkHistory[] -
- bitlink? BitlinkBody -
- customBitlink? string -
bitly: CustomBitlinkHistory
Fields
- groupGuid? string -
- bsd? string -
- isActive? boolean -
- created? string -
- keyword? string -
- login? string -
- longUrl? string -
- hash? string -
- firstCreated? string -
- deactivated? string -
bitly: CustomDomainBody
information about given custom domain
Fields
- isActive? boolean - Whether the custom domain is active
- wildcardRedirect? string - URL that unknown back-halves on the domain redirect to
- created? string - ISO_TIMESTAMP
- validationError? string - Error found during domain validation, if any
- hstsEnabled? boolean - Whether HTTP Strict Transport Security is enabled for the domain
- rootRedirect? string - URL that the root of the domain redirects to
- groupGuids? string[] - GUIDs of the groups that can use the custom domain
- deeplinkApps? MinimalDeeplinkApp[] - Deep link apps configured for the domain
- configurationLastCheckTs? string - Time of the last DNS configuration check
- httpsEnabled? boolean - Whether HTTPS is enabled for the domain
- sslConfigurationError? string - Error found while configuring the SSL certificate, if any
- sslAutoconfigureError? boolean - Whether the automatic SSL configuration failed
- validationStatus? "ok"|"pending"|"error" - Result of the domain validation: ok, pending or error
- upgradeInsecureRequests? boolean - Whether browsers are told to upgrade insecure requests to HTTPS
- customDomain? string - The custom domain name
- httpsBitlinks? boolean - Whether Bitlinks on the domain are served over HTTPS
- sslCert? PublicSSLCert - SSL certificate in use on the domain
bitly: CustomDomains
Fields
- customDomains? CustomDomainBody[] -
bitly: Deeplink
Fields
- installUrl? string -
- appUriPath? string -
- appId? string -
- installType? InstallPreference -
bitly: DeeplinkRule
Fields
- appGuid? string -
- bitlink? string -
- installUrl? string -
- os? MobileOS -
- appUriPath? string -
- created? string - ISO timestamp
- brandGuid? string -
- guid? string -
- modified? string - ISO timestamp
- installType? InstallPreference -
bitly: DeletedLink
Fields
- id? string -
bitly: DeletedQRCode
Fields
- id? string -
bitly: DeviceMetric
Fields
- clicks? int -
- deviceType? string -
bitly: DeviceMetrics
Fields
- Fields Included from *BaseMetrics
- metrics? DeviceMetric[] -
bitly: DigitalBusinessCardContact
Fields
- contactMethod "email"|"phone"|"location"|"note"|"website" -
- bitlinkId? string -
- methodType? "no_label"|"email"|"work"|"personal"|"home"|"other"|"mobile"|"direct"|"main"|"fax"|"office"|"address"|"company"|"homepage" -
- value string -
- sortOrder int -
bitly: DigitalBusinessCardContent
Fields
- layout? DigitalBusinessCardLayout -
- file? DigitalBusinessCardContentFile -
- digitalBusinessCardId? string -
- downloadEnabled? boolean -
- lastName? string -
- linkTitle? string -
- pronouns? string -
- company? string -
- firstName? string -
- jobTitle? string -
- contacts? DigitalBusinessCardContact[] -
bitly: DigitalBusinessCardContentFile
Fields
- data string -
- fileName string -
bitly: DomainAgreement
Fields
- agreementKey? string -
- title? string -
- content? string -
- url? string -
bitly: DomainAgreements
Fields
- domainAgreements? DomainAgreement[] -
bitly: DomainDNS
Fields
- recordsValid? boolean - whether the returned records represent a valid configuration
- records? string[] - the records returned by the lookup
- domain? string - the requested domain
- dnsProvider? "unknown"|"godaddy"|"cloudflare"|"namecheap" - the detected DNS provider for the requested domain
- 'type? "A"|"CNAME"|"unknown" - the type of DNS record returned
- requiredRecords? DomainDNSRequiredRecords[] - The records to create at your registrar for the domain to verify. A root domain needs the A records. A subdomain needs the CNAME record
bitly: DomainDNSRequiredRecords
Fields
- host? string - the record name at your registrar, where @ means the root of the zone
- 'type? "A"|"CNAME" - the DNS record type to create
- value? string - what the record points to
bitly: DomainUpdate
The settings to change on a custom domain. Send only the settings to change
Fields
- wildcardRedirect? string - URL that unknown back-halves on the domain redirect to
- httpsEnabled? boolean - Whether HTTPS is enabled for the domain
- hstsEnabled? boolean - Whether HTTP Strict Transport Security is enabled for the domain
- rootRedirect? string - URL that the root of the domain redirects to
- upgradeInsecureRequests? boolean - Whether browsers are told to upgrade insecure requests to HTTPS
bitly: DomainValidate
custom domain in validation queue
Fields
- prevalidate? boolean - Whether to only check the domain without adding it to the organization
- domain? string - Registered domain part of the custom domain
- subdomain? string - Subdomain part of the custom domain
- organizationGuid string - GUID of the organization the domain belongs to
- groupGuids? string[] - GUIDs of the groups that can use the domain
- customDomain string - The custom domain name to validate
bitly: DomainValidateBody
custom domain in validation queue
Fields
- prevalidate? boolean - Check the domain without adding it. The response says whether the domain can be used, and no custom domain is created. Use this to catch a typo or a domain another account holds before you commit
- organizationGuid string - GUID of the organization the domain belongs to
- groupGuids? string[] - GUIDs of the groups that can use the domain
- customDomain string - The custom domain name to validate
bitly: DynamicRoutingRule
A dynamic routing rule that redirects traffic to a different destination based on user attributes
Fields
- deviceMatch? DynamicRoutingDeviceEnum[] - Device types that trigger this rule (e.g., ["mobile", "tablet"])
- regionExclude? string[] - ISO 3166-2 region codes that must NOT match for this rule to apply (e.g., ["US-CA", "CA-ON"])
- osMatch? DynamicRoutingPlatformEnum[] - Operating systems that trigger this rule (e.g., ["ios", "android"])
- regionMatch? string[] - ISO 3166-2 region codes that trigger this rule (e.g., ["US-CA", "CA-ON"])
- countryMatch? string[] - ISO 3166-1 alpha-2 country codes that trigger this rule (e.g., ["US", "CA"])
- countryExclude? string[] - ISO 3166-1 alpha-2 country codes that must NOT match for this rule to apply
- osExclude? DynamicRoutingPlatformEnum[] - Operating systems that must NOT match for this rule to apply
- deviceExclude? DynamicRoutingDeviceEnum[] - Device types that must NOT match for this rule to apply
- longUrl? string - The destination URL for requests matching this rule
bitly: Email
Fields
- isPrimary? boolean -
- isVerified? boolean -
- email? string -
bitly: Engagement
Fields
- libButtonClicks? int -
- scans? int -
- clicks? int -
bitly: Engagements
Fields
- date? string -
- engagementCount? int -
- engagements? Engagement -
bitly: EngagementSubtotal
Engagement-count subtotal for a single bitlink or decoupled QR code. The id references either a bitlink (<domain>/<hash>) or a QR code guid, and engagements is the combined count of bitlink clicks or QR code scans for that entity
Fields
- engagements? int - Number of engagements recorded for the Bitlink or QR code
- id? string - ID of the Bitlink or decoupled QR code the subtotal belongs to
bitly: ExpandBitlink
Fields
- bitlinkId? string -
bitly: ExpandedBitlink
Fields
- longUrls? string[] - The list of destination URLs for this bitlink, including the default long URL and any dynamically routed destination URLs
- link? string -
- createdAt? string -
- id? string -
- longUrl? string -
bitly: FetchDomainAgreementsQueries
Represents the Queries record for the operation: fetchDomainAgreements
Fields
- organizationGuid? string - A GUID for a Bitly organization
bitly: FullShorten
Either long_url (for new bitlinks) or bitlink_id (for adding keywords to existing bitlinks) must be provided, but not both
Fields
- groupGuid? string - Always include a specific group and custom domain in your shorten calls
- forceNewLink? boolean - Whether to create a new Bitlink even if one already exists for the long URL
- deeplinks? Deeplink[] - Deep links that open the destination in a mobile app
- dynamicRouting? DynamicRoutingRule[] - dynamic routing rules for this bitlink
- bitlinkId? string - Existing bitlink ID to add a keyword override to. Format: domain/hash. Cannot be used with long_url
- domain string(default "bit.ly") - Branded short domain to create the Bitlink on
- longUrl? string - URL to be shortened. Required when creating new bitlinks. Cannot be used with bitlink_id
- title? string - Title of the Bitlink
- keyword? string - Custom keyword for creating keyword overrides. If provided, creates an override at domain/keyword
- expirationAt? string - Optional expiration timestamp for the bitlink (e.g., 2025-01-28T14:30:00+0000). Minimum expiration time is 5 minutes from now and maximum is 1 year
- tags? string[] - Tags to add to the Bitlink
bitly: GetAgenticTrafficForBitlinkQueries
Represents the Queries record for the operation: getAgenticTrafficForBitlink
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetAggregateSitesOverviewQueries
Represents the Queries record for the operation: getAggregateSitesOverview
Fields
- site? string[] - Filter by given Bitly Site guids
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
- reportGuid? string - GUID of a saved report whose filters are applied to the metrics
bitly: GetAggregateSiteViewsByCityQueries
Represents the Queries record for the operation: getAggregateSiteViewsByCity
Fields
- site? string[] - Filter by given Bitly Site guids
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
- reportGuid? string - GUID of a saved report whose filters are applied to the metrics
bitly: GetAggregateSiteViewsByCountryQueries
Represents the Queries record for the operation: getAggregateSiteViewsByCountry
Fields
- site? string[] - Filter by given Bitly Site guids
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
- reportGuid? string - GUID of a saved report whose filters are applied to the metrics
bitly: GetAggregateSiteViewsByDeviceQueries
Represents the Queries record for the operation: getAggregateSiteViewsByDevice
Fields
- site? string[] - Filter by given Bitly Site guids
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
- reportGuid? string - GUID of a saved report whose filters are applied to the metrics
bitly: GetAggregateSiteViewsByReferrerQueries
Represents the Queries record for the operation: getAggregateSiteViewsByReferrer
Fields
- site? string[] - Filter by given Bitly Site guids
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
- reportGuid? string - GUID of a saved report whose filters are applied to the metrics
bitly: GetAggregateSiteViewsOverTimeQueries
Represents the Queries record for the operation: getAggregateSiteViewsOverTime
Fields
- site? string[] - Filter by given Bitly Site guids
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
- reportGuid? string - GUID of a saved report whose filters are applied to the metrics
bitly: GetBitlinkReferrersByDomainsQueries
Represents the Queries record for the operation: getBitlinkReferrersByDomains
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetBitlinkReferringDomainsQueries
Represents the Queries record for the operation: getBitlinkReferringDomains
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetBitlinksByGroupQueries
Represents the Queries record for the operation: getBitlinksByGroup
Fields
- hostnamePathQuery? string - The hostname and/or path you would like to search (case-insensitive). Subdomains included; query params and fragment ignored
- channelGuid? string - Filter to return only links for the given channel GUID, can be provided, overrides all other parameters
- createdAfter? int - Timestamp as an integer unix epoch (seconds only)
- deeplinks "on"|"off"|"both" (default "both") - Filter to only Bitlinks that contain deeplinks
- query? string - The value that you would like to search
- hasQrCodes "on"|"off"|"both" (default "both") - a filter value if the resource has any QR codes
- domainDeeplinks "on"|"off"|"both" (default "both") - Filter to only Bitlinks that contain deeplinks configured with a custom domain
- encodingLogin? string[] - Filter by the login of the authenticated user that created the Bitlink
- tags? string[] - Filter by given tags
- campaignGuid? string - Filter to return only links for the given campaign GUID, can be provided
- launchpadIds? string[] - Filter by launchpad id
- searchAfter? string - Token used to search next batch, only use response from API as input value
- archived "on"|"off"|"both" (default "off") - Whether or not to include archived resources
- isExpired "on"|"off"|"both" (default "both") - filter bitlinks by expiration status
- hasDynamicRouting "on"|"off"|"both" (default "both") - filter bitlinks by presence of dynamic routing rules
- size int(default 50) - The quantity of items to be be returned
- createdBefore? int - Timestamp as an integer unix epoch (seconds only)
- hasExpiration "on"|"off"|"both" (default "both") - filter bitlinks by presence of expiration
- customBitlink "on"|"off"|"both" (default "both") - Filter Bitlinks by whether they have a custom Bitlink: on, off or both
bitly: GetCampaignsQueries
Represents the Queries record for the operation: getCampaigns
Fields
- groupGuid? string - A GUID for a Bitly group
bitly: GetChannelsQueries
Represents the Queries record for the operation: getChannels
Fields
- campaignGuid? string - A GUID for a Bitly campaign
- groupGuid? string - A GUID for a Bitly group
bitly: GetClicksForBitlinkQueries
Represents the Queries record for the operation: getClicksForBitlink
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetClicksForCustomBitlinkQueries
Represents the Queries record for the operation: getClicksForCustomBitlink
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetClicksSummaryForBitlinkQueries
Represents the Queries record for the operation: getClicksSummaryForBitlink
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetCustomBitlinkMetricsByDestinationQueries
Represents the Queries record for the operation: getCustomBitlinkMetricsByDestination
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetCustomDomainDNSQueries
Represents the Queries record for the operation: getCustomDomainDNS
Fields
- organizationGuid string - A GUID for a Bitly organization
bitly: GetCustomDomainsQueries
Represents the Queries record for the operation: getCustomDomains
Fields
- organizationGuid? string - A GUID for a Bitly organization
bitly: GetDigitalCardDownloadsOverTimeQueries
Represents the Queries record for the operation: getDigitalCardDownloadsOverTime
Fields
- site? string[] - Filter by given Bitly Site guids
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
- reportGuid? string - GUID of a saved report whose filters are applied to the metrics
bitly: GetEngagementsQueries
Represents the Queries record for the operation: getEngagements
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetEngagementsSummaryQueries
Represents the Queries record for the operation: getEngagementsSummary
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupClicksQueries
Represents the Queries record for the operation: getGroupClicks
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupCodeScansByCityQueries
Represents the Queries record for the operation: getGroupCodeScansByCity
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupCodeScansByCountryQueries
Represents the Queries record for the operation: getGroupCodeScansByCountry
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupCodeScansOverTimeQueries
Represents the Queries record for the operation: getGroupCodeScansOverTime
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupFeatureUsageQueries
Represents the Queries record for the operation: getGroupFeatureUsage
Fields
- name? string[] - The limit name you would like usage for
bitly: GetGroupHistoricalUsageQueries
Represents the Queries record for the operation: getGroupHistoricalUsage
Fields
- endDate? string - The end date for the date range
- unit? TimeUnitDWM - A unit of time (day, week, or month)
- name? string[] - The limit name you would like usage for
- startDate? string - The start date for the date range
bitly: GetGroupLinkClicksByCityQueries
Represents the Queries record for the operation: getGroupLinkClicksByCity
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupLinkClicksByCountryQueries
Represents the Queries record for the operation: getGroupLinkClicksByCountry
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupLinkClicksByDeviceQueries
Represents the Queries record for the operation: getGroupLinkClicksByDevice
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupLinkClicksByReferrerQueries
Represents the Queries record for the operation: getGroupLinkClicksByReferrer
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupLinkClicksOverTimeQueries
Represents the Queries record for the operation: getGroupLinkClicksOverTime
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupMetricsByCitiesQueries
Represents the Queries record for the operation: getGroupMetricsByCities
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupMetricsByCountriesQueries
Represents the Queries record for the operation: getGroupMetricsByCountries
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupMetricsByDevicesQueries
Represents the Queries record for the operation: getGroupMetricsByDevices
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupMetricsByReferrerQueries
Represents the Queries record for the operation: getGroupMetricsByReferrer
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupMetricsByReferringNetworksQueries
Represents the Queries record for the operation: getGroupMetricsByReferringNetworks
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupMetricsOverTimeQueries
Represents the Queries record for the operation: getGroupMetricsOverTime
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupShortenCountsQueries
Represents the Queries record for the operation: getGroupShortenCounts
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupsQueries
Represents the Queries record for the operation: getGroups
Fields
- organizationGuid? string - A GUID for a Bitly organization
bitly: GetGroupTagsQueries
Represents the Queries record for the operation: getGroupTags
Fields
- 'type "bitlink"|"qr_code" (default "bitlink") - Tag set to return; defaults to bitlink
bitly: GetGroupTopCodeScansQueries
Represents the Queries record for the operation: getGroupTopCodeScans
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- decoupled? boolean - When true, ranks results by decoupled QR scan count and returns a TopLinksAndQRCodes response with links and QR codes partitioned into separate lists and a unified sorted_engagements ordering
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupTopLinkClicksQueries
Represents the Queries record for the operation: getGroupTopLinkClicks
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetGroupTopMetricsQueries
Represents the Queries record for the operation: getGroupTopMetrics
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetLinkPerformanceForSiteQueries
Represents the Queries record for the operation: getLinkPerformanceForSite
Fields
- unit? TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
- page int(default 1) - Integer specifying the numbered result at which to start
bitly: GetMetricsForBitlinkByCitiesQueries
Represents the Queries record for the operation: getMetricsForBitlinkByCities
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetMetricsForBitlinkByCountriesQueries
Represents the Queries record for the operation: getMetricsForBitlinkByCountries
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetMetricsForBitlinkByDevicesQueries
Represents the Queries record for the operation: getMetricsForBitlinkByDevices
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetMetricsForBitlinkByReferrerNameQueries
Represents the Queries record for the operation: getMetricsForBitlinkByReferrerName
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetMetricsForBitlinkByReferrersQueries
Represents the Queries record for the operation: getMetricsForBitlinkByReferrers
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetMetricsForSiteByCitiesQueries
Represents the Queries record for the operation: getMetricsForSiteByCities
Fields
- unit? TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetMetricsForSiteByDevicesQueries
Represents the Queries record for the operation: getMetricsForSiteByDevices
Fields
- unit? TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetMetricsForSiteByReferrersQueries
Represents the Queries record for the operation: getMetricsForSiteByReferrers
Fields
- unit? TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetMetricsForSitesByCountriesQueries
Represents the Queries record for the operation: getMetricsForSitesByCountries
Fields
- unit? TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetOrganizationShortenCountsQueries
Represents the Queries record for the operation: getOrganizationShortenCounts
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetOrganizationsQueries
Represents the Queries record for the operation: getOrganizations
Fields
- includeAll? boolean - When set to true, returns all of the user's organizations regardless of the token's allowed_orgs restrictions
bitly: GetPlatformLimitsQueries
Represents the Queries record for the operation: getPlatformLimits
Fields
- path? string - The specific path for which information is requested
bitly: GetQRCodeImagePublicHeaders
Represents the Headers record for the operation: getQRCodeImagePublic
Fields
- accept? string - The file format for the QR code's image. If the accept header is application/json the image data will be wrapped in a json object, base64 encoded and prefixed with its mime type as would be suitable for a HTML image src tag
bitly: GetQRCodeImagePublicQueries
Represents the Queries record for the operation: getQRCodeImagePublic
Fields
- format "svg"|"png" (default "svg") - The format type of the image. If there is an image format in the header it takes precedence
bitly: GetScanMetricsForQRCodeByBrowserQueries
Represents the Queries record for the operation: getScanMetricsForQRCodeByBrowser
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetScanMetricsForQRCodeByCitiesQueries
Represents the Queries record for the operation: getScanMetricsForQRCodeByCities
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetScanMetricsForQRCodeByCountriesQueries
Represents the Queries record for the operation: getScanMetricsForQRCodeByCountries
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetScanMetricsForQRCodeByDevicesOSQueries
Represents the Queries record for the operation: getScanMetricsForQRCodeByDevicesOS
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetScanMetricsForQRCodeQueries
Represents the Queries record for the operation: getScanMetricsForQRCode
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetScanMetricsSummaryForQRCodeQueries
Represents the Queries record for the operation: getScanMetricsSummaryForQRCode
Fields
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetSiteClicksByCitiesQueries
Represents the Queries record for the operation: getSiteClicksByCities
Fields
- site? string[] - Filter by given Bitly Site guids
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
- reportGuid? string - GUID of a saved report whose filters are applied to the metrics
bitly: GetSiteClicksByCountriesQueries
Represents the Queries record for the operation: getSiteClicksByCountries
Fields
- site? string[] - Filter by given Bitly Site guids
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
- reportGuid? string - GUID of a saved report whose filters are applied to the metrics
bitly: GetSiteClicksByDevicesQueries
Represents the Queries record for the operation: getSiteClicksByDevices
Fields
- site? string[] - Filter by given Bitly Site guids
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
- reportGuid? string - GUID of a saved report whose filters are applied to the metrics
bitly: GetSiteClicksOverTimeQueries
Represents the Queries record for the operation: getSiteClicksOverTime
Fields
- site? string[] - Filter by given Bitly Site guids
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
- reportGuid? string - GUID of a saved report whose filters are applied to the metrics
bitly: GetSiteFilteredTopPageButtonsQueries
Represents the Queries record for the operation: getSiteFilteredTopPageButtons
Fields
- site? string[] - Filter by given Bitly Site guids
- unit TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- brandGuid? string - GUID of the brand whose Bitly Pages are included in the metrics
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
- reportGuid? string - GUID of a saved report whose filters are applied to the metrics
bitly: GetSiteQueries
Represents the Queries record for the operation: getSite
Fields
- includeBlocks? boolean - When true, the response includes a blocks array holding the site's draft content blocks, ordered by container and then by sort order within that container. Blocks nested inside a grid or carousel carry that container's ID in container_id. The array is omitted entirely when this parameter is not set, and is an empty array when the site has no blocks
bitly: GetSitesForGroupQueries
Represents the Queries record for the operation: getSitesForGroup
Fields
- searchAfter? string - Token used to search next batch, only use response from API as input value
- size int(default 50) - The quantity of items to be be returned
- sitesUrlParam? string - Filter Bitly Pages by the URL path they are published under
bitly: GetSortedBitlinksQueries
Represents the Queries record for the operation: getSortedBitlinks
Fields
- unit? TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetTemplatesQueries
Represents the Queries record for the operation: getTemplates
Fields
- category? "Link-in-bio"|"Products and services"|"Promotions"|"Digital business card"|"Image gallery"|"Recommended" - A filter option for template categories
bitly: GetTopLinksAndQRCodesByEngagementsQueries
Represents the Queries record for the operation: getTopLinksAndQRCodesByEngagements
Fields
- unit? TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetViewsForSiteQueries
Represents the Queries record for the operation: getViewsForSite
Fields
- unit? TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GetViewsSummaryForSiteQueries
Represents the Queries record for the operation: getViewsSummaryForSite
Fields
- unit? TimeUnit - A unit of time
- unitReference? string - An ISO-8601 timestamp, indicating the most recent time for which to pull metrics. Will default to current time. Timestamp values should be url encoded (i.e. replace '+' with '%2B' and ':' with '%3A'; 2022-02-02T15:53:02+0000 becomes 2022-02-02T15%3A53%3A02%2B0000)
- size int(default 50) - The quantity of items to be be returned
- units int(default -1) - An integer representing the time units to query data for. pass -1 to return all units of time
bitly: GradientColor
Fields
- color? string - A color in hexadecimal format to be used in one of the gradient's <stop> elements
- offset int(default 0) - A number between 0-100 denoting the offset of the gradient color, interpreted as a percentage
bitly: Group
Fields
- Fields Included from *HasReferences
- references record { string... }
- anydata...
- isActive boolean -
- role string -
- created string -
- name string -
- guid string -
- modified string -
- organizationGuid string -
- bsds string[] -
bitly: GroupBitlinksCountRollup
Fields
- unit? string -
- unitReference? string -
- totalClicks? int -
- units? int -
bitly: GroupClicks
Fields
- unit? string -
- unitReference? string -
- data? CountItem[] -
- units? int -
bitly: GroupConsumableFeatureUsage
Fields
- name? string -
- count? int -
- description? string -
bitly: GroupDeviceClickMetric
Fields
- clicks? int -
- value? string -
bitly: GroupDeviceClicks
Fields
- unit? string -
- unitReference? string -
- units? int -
- metrics? GroupDeviceClickMetric[] -
- facet? "countries"|"cities"|"devices"|"referrers"|"referrers_by_domain"|"referring_domains"|"referring_networks"|"shorten_counts" -
bitly: GroupExportFilter
Search constraints used to resolve links or QR codes for export. Required for links_list and qr_codes_list
Fields
- campaignGuid? string - Filter links by campaign GUID. Ignored for qr_codes_list
- archived? "on"|"off"|"both" - Filter by archive state
- createdAfter? int - Include items created at or after this Unix timestamp (UTC)
- createdBefore? int - Include items created before this Unix timestamp (UTC)
- domain? string - Only export items on this domain
- query? string - Free-text search query
- tags? string[] - Only export items that carry these tags
bitly: GroupExportRequestBody
Fields
- filter? GroupExportFilter - Search constraints used to resolve links or QR codes for export. Required for links_list and qr_codes_list
- exportType "link_engagements_batch"|"links_list"|"qr_codes_list" - Which export shape to produce
- unixFrom? int - Start of the metrics date range (Unix seconds, UTC). Clamped to the caller's tier data window. For link_engagements_batch, required together with unix_to unless the tier max-history default applies. For links_list or qr_codes_list, used when include_metrics is true
- bitlinks? string[] - Fully qualified bitlinks (e.g. "bit.ly/abc"). Used by export_type link_engagements_batch when the caller already knows the exact links. Mutually exclusive with filter (provide one or the other)
- includeMetrics? boolean - When true on links_list or qr_codes_list, append clicks, scans, and button_clicks columns and apply the 200-row cap. Requires unix_from and unix_to (or tier-default window behavior where applicable)
- unixTo? int - End of the metrics date range (Unix seconds, UTC). See unix_from
bitly: GroupExportResponse
Fields
- dataUri? string - CSV file as a data:text/csv;base64,... URI
- exportType? "link_engagements_batch"|"links_list"|"qr_codes_list" -
- filename? string - Suggested download filename for the CSV
- sizeBytes? int - Size of the raw CSV bytes before base64 encoding
- mediaType? string -
- columnCount? int -
- columns? string[] - CSV column headers in order
- unixFrom? int - Metrics window start (Unix seconds) when metrics are included in the export
- truncated? boolean - True when the match set exceeded the per-request row cap and only the first cap rows were exported
- rowCount? int - Number of data rows in the CSV (excluding the header row)
- unixTo? int - Metrics window end (Unix seconds) when metrics are included in the export
bitly: GroupFeatureUsage
Fields
- groupGuid string - the group's guid
- limitUsage GroupConsumableFeatureUsage[] - an array of all of the group's consumable feature usage
bitly: GroupHistoricalUsage
Fields
- endDate string - End date (format "2006-01-02") of the historical usage
- groupGuid string - the group's guid
- unit string - A unit of time (day, week, or month)
- startDate string - Start date (format "2006-01-02") of the historical usage
- historicalLimitUsage HistoricalFeatureUsage[] - an array of all of the group's historical feature usage
bitly: GroupPreferences
Fields
- groupGuid? string -
- domainPreference? string -
bitly: Groups
Fields
- groups Group[] -
bitly: GroupUpdate
Fields
- name? string -
- organizationGuid? string -
- bsds? string[] -
bitly: GS1Metadata
Contains GS1 related metadata
Fields
- values? GS1Value[] - A list of GS1 application identifiers and their values
bitly: GS1Value
Fields
- value? string - A syntactically correct value associated with the application identifier in the key field
- 'key? string - A valid GS1 application identifier, qualifier, attribute, etc
bitly: HasReferences
Fields
- references? record { string... } -
bitly: HistoricalFeatureUsage
Fields
- usage? HistoricalUsage[] -
- name? string - feature name
bitly: HistoricalUsage
Fields
- count? int - the usage count during the time period
- unitStart? string - ISO_TIMESTAMP of the beginning of the time period
bitly: ImageCommon
Fields
- imageGuid? string -
- imageUrl? string -
- crop? string -
bitly: ImageContent
Fields
- Fields Included from *ImageCommon
- aspectRatio? string -
- bitlinkId? string -
- description? string -
- linkTitle? string -
bitly: ImageUploadResponse
Fields
- imageUrl? string -
- imageGuid? string -
bitly: InputDomain
Fields
- domain? string -
- status? string -
bitly: LinkClicks
Fields
- date? string -
- clicks? int -
bitly: LinkDeletionResponse
Fields
- linksDeleted? DeletedLink[] -
bitly: ListQRMinimalQueries
Represents the Queries record for the operation: listQRMinimal
Fields
- hostnamePathQuery? string - The hostname and/or path you would like to search (case-insensitive). Subdomains included; query params and fragment ignored
- createdAfter? int - Timestamp as an integer unix epoch (seconds only)
- query? string - The value that you would like to search
- hasRenderCustomizations "on"|"off"|"both" (default "both") - Whether or not QRCode has any render customizations (like color or shape changes)
- tags? string[] - Filter by given tags
- searchAfter? string - Token used to search next batch of qr codes, only use response from API as input value
- archived "on"|"off"|"both" (default "off") - Whether or not to include archived resources
- isExpired "on"|"off"|"both" (default "both") - filter bitlinks by expiration status
- hasDynamicRouting "on"|"off"|"both" (default "both") - filter bitlinks by presence of dynamic routing rules
- size int(default 50) - The quantity of items to be be returned
- createdBefore? int - Timestamp as an integer unix epoch (seconds only)
- hasExpiration "on"|"off"|"both" (default "both") - filter bitlinks by presence of expiration
- creatingLogin? string[] - Filter by the login of the authenticated user that created the QR Code
- qrcType ("bitlink"|"long_url")[](default ["bitlink","long_url"]) - Filter QR codes by the type of destination they point to: bitlink or long_url
- isGs1 "on"|"off"|"both" (default "both") - a filter value if the resource is a GS1 QR code
bitly: MethodLimit
Fields
- name? string -
- 'limit? int -
- count? int -
bitly: Metric
Fields
- value? int -
- 'key? string -
bitly: Metrics
Fields
- Fields Included from *BaseMetrics
- metrics? Metric[] -
bitly: MicrositePagination
Specifies how to query the next set of results
Fields
- next? string - A hyperlink to the next set of results
- searchAfter? string - The identifier of where to begin searching for the next set of results
- size? int - The number of results returned from this query
bitly: MinimalDeeplinkApp
Deep Linking object
Fields
- os? MobileOS - Mobile operating system the app runs on
- guid? string - GUID of the deep link app
bitly: OAuthApp
Fields
- name string -
- link string -
- description string -
- requireOauthPkce boolean -
- clientId string -
- internalApp? boolean - True for Bitly's own first-party apps (dashboard, mobile apps), as opposed to third-party integrations
bitly: Organization
Fields
- Fields Included from *HasReferences
- references record { string... }
- anydata...
- tierDisplayName string -
- require2fa? "none"|"sms" - Two-factor authentication requirement for this organization. Possible values: "none", "sms". Omitted when no auth requirements are configured.
- isActive boolean -
- role string -
- tier string -
- created string -
- requireSso? "none"|"any" - SSO authentication requirement for this organization. Possible values: "none", "any". Omitted when no auth requirements are configured.
- name string -
- guid string -
- modified string -
- bsds string[] -
- tierFamily string -
bitly: Organizations
Fields
- organizations Organization[] -
bitly: OtherMetrics
Fields
- otherCityClicks? int -
- noCityClicks? int -
bitly: OtherScanMetrics
Fields
- otherCityScans? int -
- noCityScans? int -
bitly: OtherViewMetrics
Fields
- otherCityViews? int -
- noCityViews? int -
bitly: PlanLimit
Fields
- name? string -
- 'limit? int -
- count? int -
- description? string -
bitly: PlanLimits
Fields
- Fields Included from *HasReferences
- references record { string... }
- anydata...
- planLimits? PlanLimit[] -
- organizationGuid? string -
bitly: PlatformLimit
Fields
- endpoint? string -
- methods? MethodLimit[] -
bitly: PlatformLimits
Fields
- platformLimits? PlatformLimit[] -
bitly: PrevalidateYouTubeVideoRequest
Fields
- videoId? string -
bitly: PublicCreateQRCodeRequest
Customization and content values for a QR code created through the public API
Fields
- archived? boolean - A boolean representing if the QR code should be archived (hidden from the UI) upon creation
- groupGuid string - Identify which group to place the QR Code
- renderCustomizations? QRCodeCustomizationsPublic - Options that control how the QR code looks
- gs1? GS1Metadata - GS1 Digital Link metadata for the QR code
- dynamicRouting? DynamicRoutingRule[] - Optional dynamic routing rules for this decoupled QR code. Only supported for long_url destinations. Providing this field replaces all existing rules. Send an empty array to clear all rules
- domain string(default "bit.ly") - Branded short domain to create the QR code's Bitlink on
- destination QRCodeDestination - Where the QR code sends people when it is scanned
- title? string - The title of the QR Code
- expirationAt? string - Optional expiration timestamp for the QR code's bitlink (e.g., 2025-01-28T14:30:00+0000). Minimum expiration time is 5 minutes from now and maximum is 1 year
- tags? string[] - A list of tags to add to the QR code
bitly: PublicCreateStaticQRCodeRequest
Request body for generating a static QR code image. Customizations such as gradient, background_gradient, frame, text and logo are not supported
Fields
- groupGuid string - The group (brand) GUID used for access control and analytics
- renderCustomizations? QRCodeCustomizationsStaticPublic - Options that control how the static QR code looks
- content string - The raw content to encode in the QR code (e.g. a URL)
bitly: PublicDeleteQRCodeResponse
QR Code delete response
Fields
- linksDeleted? DeletedLink[] - Bitlinks that were deleted along with the QR codes
- qrcodesDeleted? DeletedQRCode[] - QR codes that were deleted
bitly: PublicQRCodeImageResponse
Wraps the image data for a QR code
Fields
- qrCodeImage? string - The stringified data for the QR code's image
bitly: PublicSSLCert
SSL Certification
Fields
- validEnd? string - Time the certificate stops being valid
- customCert? boolean - Whether the certificate was supplied by the customer
- issuer? string - Authority that issued the certificate
bitly: PublicStaticQRCodeResponse
Response containing a generated static QR code image
Fields
- image? string - The image data, base64-encoded. Format is SVG or PNG depending on the requested format
bitly: PublicUpdateQRCodeRequest
Customization and content values for a QR code created through the public API
Fields
- archived? boolean - A boolean representing if the QR code has been archived
- renderCustomizations? QRCodeCustomizationsPublic - Options that control how the QR code looks
- dynamicRouting? DynamicRoutingRule[] - Dynamic routing rules for this QR code. Providing this field replaces all existing rules. Send an empty array to clear all rules
- title? string - New title of the QR code
- expirationAt? string - Optional expiration timestamp for the QR code's bitlink (e.g., 2025-01-28T14:30:00+0000). Minimum expiration time is 5 minutes from now and maximum is 1 year
- tags? string[] - A list of tags to add to the QR code
bitly: PurchaseBSD
Fields
- domain? string -
- organizationGuid? string -
- agreementKeys? string[] -
bitly: PurchaseBSDResponse
Fields
- validationStatus? "pending" - a registration always starts pending, because Bitly configures the DNS after it
- organizationGuid? string -
- customDomain? string - the custom domain the registration created
bitly: QRCBulkUpdate
Fields
- qrCodeIds? string[] -
bitly: QRCBulkUpdateRequest
Fields
- addTags? string[] -
- qrCodeIds? string[] - this is limited to 100 QR code ids; Pages QR codes are not supported
- removeTags? string[] -
- action "archive"|"edit_tags" - archive or edit_tags
- archive? boolean -
bitly: QRCodeBranding
Fields
- bitlyBrand? boolean - A boolean that determines if the QR code should have the bitly brand in its bottom right corner
bitly: QRCodeCorner
Represents one corner, both inner and outer, of a QR code, with color and shape values
Fields
- outerColor? string - The outer color of a corner of the QR code in hex code format
- shape "standard"|"slightly_round"|"rounded"|"extra_round"|"leaf"|"leaf_inner"|"leaf_outer"|"target"|"concave" (default "standard") - The shape one of the QR code's corners should take
- innerColor? string - The inner color of a corner of the QR code in hex code format
bitly: QRCodeCorners
An object representing all three corners of the QR code. The corners corresponding to each property are: corner_1 = top left, corner_2 = top right, and corner_3 = bottom right
Fields
- corner2? QRCodeCorner - Appearance of the top right corner
- corner3? QRCodeCorner - Appearance of the bottom right corner
- corner1? QRCodeCorner - Appearance of the top left corner
bitly: QRCodeCustomizationsPublic
Options for customizing a QR Code's appearance
Fields
- corners? QRCodeCorners - An object representing all three corners of the QR code. The corners corresponding to each property are: corner_1 = top left, corner_2 = top right, and corner_3 = bottom right
- backgroundColor? string - The QR code's background color in hex code format with values for alpha channel
- dotPatternType? QRCodeDotPatternType - Shape of the dots that make up the QR code
- gradient? QRCodeGradient - Gradient applied to the QR code dots
- backgroundGradient? QRCodeGradient - Gradient applied to the QR code background
- branding? QRCodeBranding - Whether the QR code carries Bitly branding
- logo? QRCodeLogoPublic - Logo placed in the center of the QR code
- specSettings? QRCodeSpecSettingsPublic - QR code specification settings, such as the error correction level
- dotPatternColor? string - The QR code's dot pattern color in hex code format
- text? QRCodeText - Contains the center, top, and bottom text to be used in the QR code
- frame? QRCodeFrameRequest - Frame drawn around the QR code
bitly: QRCodeCustomizationsStaticPublic
Appearance options for a static QR code. gradient, background_gradient, frame, text, and logo are not supported
Fields
- corners? QRCodeCorners - An object representing all three corners of the QR code. The corners corresponding to each property are: corner_1 = top left, corner_2 = top right, and corner_3 = bottom right
- backgroundColor? string - The QR code's background color in hex code format with values for alpha channel
- dotPatternType? QRCodeDotPatternType - Shape of the dots that make up the QR code
- branding? QRCodeBranding - Whether the QR code carries Bitly branding
- specSettings? QRCodeSpecSettingsPublic - QR code specification settings, such as the error correction level
- dotPatternColor? string - The QR code's dot pattern color in hex code format
bitly: QRCodeDestination
Fields
- bitlinkId? string -
- siteId? string -
- longUrl? string -
bitly: QRCodeDetails
Fields
- groupGuid? string -
- gs1? GS1Metadata - Contains GS1 related metadata
- renderCustomizations? QRCodeCustomizationsPublic -
- longUrls? string[] - A list of destination URLs that the qr code leads to
- dynamicRouting? DynamicRoutingRule[] - Dynamic routing rules for this QR code. Only present when at least one rule is configured
- created? string -
- title? string -
- tags? string[] - A list of tags associated with QR code
- archived? boolean -
- qrcodeId? string -
- bitlinkId? string - The bitlink associated with the qr code. Not all qr codes are associated with one
- domain? string - The short domain the qr code redirects from. Present for both bitlink and long_url qr codes
- serializedContent? string - The serialized string of the QR code's content
- modified? string -
- qrCodeType? QRCodeTypeEnum -
- expirationAt? string - Optional expiration timestamp for the QR code's bitlink (e.g., 2025-01-28T14:30:00+0000)
bitly: QRCodeFrameRequest
Fields
- id QRCodeFrameType -
- text? QRCodeFrameRequestText - The text to be inserted into the QR code's frame
- colors? QRCodeFrameRequestColors - An object of named colors denoting which color should go to which area of the frame
bitly: QRCodeFrameRequestColors
An object of named colors denoting which color should go to which area of the frame
Fields
- secondary? string - The secondary color of the frame in hex code format
- background? string - The background color of the frame in hex code format
- primary? string - The primary color of the frame in hex code format
bitly: QRCodeFrameRequestText
The text to be inserted into the QR code's frame
Fields
- secondary? Text - An object describing text with color
- primary? Text - An object describing text with color
bitly: QRCodeGradient
Fields
- angle? decimal - The angle by which the gradient will be rotated. Only applies to linear gradients
- style "no_gradient"|"linear"|"radial" (default "no_gradient") - The style of the gradient. Can be either linear or radial
- colors? GradientColor[] - The list of hex colors and their offsets to be used in the gradient
- excludeCorners? boolean - Ignore gradient mask on corners
bitly: QRCodeLogoPublic
Fields
- imageGuid? string - A GUID for an image uploaded to Bitly
bitly: QRCodeMinimal
Fields
- groupGuid? string -
- longUrls? string[] - A list of destination URLs that the qr code leads to
- dynamicRouting? DynamicRoutingRule[] - Dynamic routing rules for this QR code. Only present when at least one rule is configured
- created? string -
- title? string -
- createdBy? string - User that created the code
- tags? string[] - A list of tags associated with QR code
- archived? boolean -
- qrcodeId? string -
- bitlinkId? string - The bitlink ID associated with the qr code. Not all qr codes are associated with one
- domain? string - The short domain the qr code redirects from. Present for both bitlink and long_url qr codes
- serializedContent? string - A serialized string of the QR code's content
- modified? string -
- isCustomized? boolean - Set to true if the QR code's customization values have been changed from their default setting
- qrCodeType? QRCodeTypeEnum -
- expirationAt? string - Optional expiration timestamp for the QR code's bitlink (e.g., 2025-01-28T14:30:00+0000)
- isGs1? boolean - Set to true if QR code has GS1 values
bitly: QRCodesMinimal
QR code paginated list Response
Fields
- pagination? QRPagination - This object specifies how to query the next set of results
- qrCodes? QRCodeMinimal[] - QR codes on this page of results
bitly: QRCodeSpecSettingsPublic
The QR code's editable spec settings, which for now is just the error correction
Fields
- errorCorrection? int - The amount of error correction that the QR code was generated with
bitly: QRCodeText
Contains the center, top, and bottom text to be used in the QR code
Fields
- top? Text - An object describing text with color
- bottom? Text - An object describing text with color
- center? Text - An object describing text with color
bitly: QRPagination
This object specifies how to query the next set of results
Fields
- next? string - a hyperlink to the next set of results
- searchAfter? string - the identifier of where to begin searching for the next set of results
- size? int - the number of results returned from this query
bitly: QRScans
Fields
- date? string -
- scans? int -
bitly: RedirectQRCodeRequest
Request to redirect a QRCode
Fields
- longUrl string - New destination URL the QR code redirects to
bitly: ReferrersByDomain
Fields
- referrers? Metric[] -
- network? string -
bitly: ReferrersByDomains
Fields
- referrersByDomain? ReferrersByDomain[] -
- unit? string -
- unitReference? string -
- units? int -
- facet? "referrers_by_domains" -
bitly: ScanMetric
Fields
- scans? int -
- value? string -
bitly: ScanMetrics
Fields
- Fields Included from *BaseScanMetrics
- metrics? ScanMetric[] -
bitly: SearchAvailableDomainsQueries
Represents the Queries record for the operation: searchAvailableDomains
Fields
- query string - the domain name to search for, up to 32 characters
- 'limit int(default 25) - limit the amount of results returned, 25 maximum
- organizationGuid? string - A GUID for a Bitly organization
bitly: Shorten
Fields
- groupGuid? string -
- forceNewLink? boolean -
- domain string(default "bit.ly") -
- longUrl string -
bitly: ShortenBitlinkBody
Fields
- Fields Included from *HasReferences
- references record { string... }
- anydata...
- archived? boolean -
- deeplinks? DeeplinkRule[] -
- customBitlinks? string[] - list of previously edited backhalfs for the bitlink - these are in reverse chronological order, with the most recently edited backhalf first
- link? string -
- createdAt? string -
- id? string -
- longUrl? string -
- tags? string[] -
bitly: SiteBlock
Fields
- Fields Included from *SiteBlockCommon
- isActive boolean -
bitly: SiteBlockCommon
Fields
- isActive? boolean -
- siteId? string -
- scheduleEnd? string -
- 'type? SiteBlockTypeEnum - Available block types for Site blocks
- sortOrder? int -
- blockId? string -
- scheduleStart? string -
- isPinned? boolean -
- isSample? boolean -
bitly: SiteBlockContainerRequest
Fields
- 'type? SiteContainerTypeEnum - Available container types
bitly: SiteBlockCreateRequest
Fields
- Fields Included from *SiteBlockRequest
- parent string
- appearance TextBlockAppearanceRequest
- isActive boolean
- scheduleEnd string
- content SiteContentUnion
- scheduleStart string
- isPinned boolean
- anydata...
- 'type SiteBlockCreateTypeEnum - Block types that can be created directly (grid and carousel are created as containers)
- content SiteContentUnion -
bitly: SiteBlockRequest
Fields
- parent? string -
- appearance? TextBlockAppearanceRequest -
- isActive? boolean -
- scheduleEnd? string -
- content? SiteContentUnion -
- scheduleStart? string -
- isPinned? boolean -
bitly: SiteCityViewMetrics
Fields
- Fields Included from *BaseMetrics
- otherMetrics? OtherViewMetrics -
- siteViews? ViewMetric[] -
bitly: SiteClicks
Fields
- isActive? boolean -
- bitlinkId? string -
- domain? string -
- clicks? int -
- title? string -
- longUrl? string -
- 'type? SiteButtonTypeEnum - Available button types for Site content
- keyword? string -
bitly: SiteCloneRequest
Fields
- uri? string -
bitly: SiteImageUpload
Fields
- imageGuid? string -
- url? string -
- imageUse? "profile"|"background"|"banner"|"profile_life"|"background_live"|"banner_live" -
- crop? string -
bitly: SiteLinkPerformance
Fields
- performanceEnd? string -
- total? int -
- unit? "minute"|"hour"|"day"|"week"|"month" -
- linkClicks? SiteClicks[] -
- unitReference? string -
- performanceStart? string -
- units? int -
- page? SitesPagination -
bitly: SiteRedirects
Fields
- redirectDomain? string -
- redirectGuid? string -
- created? string -
- domain? string -
- modified? string -
- redirectUri? string -
- keyword? string -
- redirectKeyword? string -
- micrositeGuid? string -
- uri? string -
- status? string -
bitly: SitesOverview
Fields
- clicks? decimal -
- views? decimal -
- info? string -
bitly: SitesPagination
Fields
- next? string -
- total? int -
- size? int -
- prev? string -
- page? int -
bitly: SiteViewMetrics
Fields
- unit? "minute"|"hour"|"day"|"week"|"month" -
- unitReference? string -
- units? int -
- facet? "views"|"countries"|"referrers"|"devices" -
- siteViews? ViewMetric[] -
bitly: SiteViewsSummary
Fields
- unit? "minute"|"hour"|"day"|"week"|"month" -
- unitReference? string -
- totalViews? int -
- units? int -
bitly: SocialContent
Fields
- channel? string -
- url? string -
bitly: SortedButtons
Fields
- buttons? SortedButtonsButtons[] -
- pageViews? SortedButtonsPageViews[] -
- sortedButtons? ClickLink[] -
- info? string -
bitly: SortedButtonsButtons
Fields
- buttonType? LaunchpadButtonTypeEnum -
- id? string -
- title? string -
- micrositeGuid? string -
bitly: SortedButtonsPageViews
Fields
- micrositeGuid? string -
- uri? string -
- views? decimal -
bitly: SortedLinks
Fields
- sortedLinks? ClickLink[] -
- links? BitlinkBody[] -
bitly: Tags
Fields
- tags? string[] -
bitly: Template
Fields
- templateGuid? string -
- appearance? BitlySiteAppearance -
- isActive? boolean -
- blocks? SiteBlocks -
- created? string -
- modified? string -
- categories? string[] -
- isPaid? boolean -
- content? BitlySiteContent -
- status? string -
bitly: Text
An object describing text with color
Fields
- color string(default "#ffffff") - The color of the text in hex code format
- content string - The text to be used
bitly: TextBlockAppearanceRequest
Fields
- backgroundColor? string -
- fontSize? TextBlockAppearanceRequestFontSizeEnum -
- textColor? string -
- textBlockStyle? TextBlockStyle -
- alignment? TextBlockAppearanceRequestAlignmentEnum -
bitly: TextBlockContent
Fields
- text? string -
bitly: TextBlockStyle
Fields
- underline? boolean -
- bold? boolean -
- italic? boolean -
bitly: TopLinksAndQRCodes
Response shape for top bitlinks and decoupled QR codes in a group, ranked together by engagement count. links and qr_codes are independent lists (a link and a decoupled QR code are never the same entity); sorted_engagements is the unified descending-by-engagement ordering across both, with each entry's id referencing either a bitlink or a QR code guid. Coupled QRCs are listed by their bitlink ID
Fields
- qrCodes? QRCodeMinimal[] - Top decoupled QR codes in the group, ranked by engagements
- sortedEngagements? EngagementSubtotal[] - Engagement subtotals for the listed Bitlinks and QR codes, in ranking order
- links? BitlinkBody[] - Top Bitlinks in the group, ranked by engagements
bitly: TotalEngagements
Fields
- unit? "minute"|"hour"|"day"|"week"|"month" -
- unitReference? string -
- engagements? Engagements[] -
- units? int -
bitly: TotalEngagementsSummary
Fields
- unit? "minute"|"hour"|"day"|"week"|"month" -
- unitReference? string -
- totalEngagements? int -
- engagements? Engagement -
- units? int -
bitly: UpdateCustomBitlink
Fields
- bitlinkId? string -
bitly: UpdateSite
Fields
- qrCodeId? string - The ID of the QR code to attach to the site. Only allowed when the site does not already have a QR code attached
- description? string - The description displayed on the site. An empty value clears the current one
- displayName? string - The name displayed on the site. An empty value clears the current one
- uri? string - The domain and keyword the site is served from. Changing it creates a redirect from the previous URI
bitly: User
Fields
- emails Email[] -
- is2faEnabled boolean -
- isActive boolean -
- created string -
- name string -
- defaultGroupGuid? string -
- modified string -
- login string -
- isSsoUser boolean -
bitly: UserUpdate
Fields
- name? string -
- defaultGroupGuid? string -
bitly: ViewMetric
Fields
- value? string -
- views? int -
bitly: Webhook
Fields
- Fields Included from *HasReferences
- references record { string... }
- anydata...
- groupGuid? string -
- isActive boolean -
- fetchTags? boolean -
- created string -
- oauthUrl? string -
- isAlert boolean -
- organizationGuid string -
- deactivated string -
- url string -
- clientId? string -
- alerted string -
- modifiedBy string -
- name string -
- guid string -
- modified string -
- clientSecret? string -
- event string -
- status? string -
bitly: WebhookCreate
Fields
- groupGuid? string -
- isActive? boolean -
- fetchTags? boolean -
- name string -
- oauthUrl? string -
- clientSecret? string -
- organizationGuid string -
- event string -
- url string -
- clientId? string -
bitly: Webhooks
Fields
- webhooks? Webhook[] -
bitly: WebhookUpdate
Fields
- groupGuid? string -
- isActive? boolean -
- fetchTags? boolean -
- name? string -
- oauthUrl? string -
- guid string -
- clientSecret? string -
- organizationGuid? string -
- event? string -
- url? string -
- clientId? string -
bitly: YoutubeVideoRequest
Fields
- videoUrl? string -
- domain? string -
- linkTitle? string -
- thumbnailUrl? string -
Union types
bitly: SiteTextWeightEnum
SiteTextWeightEnum
Enum of text sizes on a Bitly Site
bitly: TimeUnit
TimeUnit
the unit of time queried for (minute, hour, day, week, month)
bitly: SiteProfileImageBorderSize
SiteProfileImageBorderSize
Enum of profile image border sizes on a Bitly Site
bitly: SiteStylePreference
SiteStylePreference
Enum of style preference values on a Bitly Site
bitly: TimeUnitDWM
TimeUnitDWM
the unit of time queried for (day, week, month)
bitly: QRCodeTypeEnum
QRCodeTypeEnum
The type of dynamic/static content the QR serves, e.g. Link In Bio page, micro site, bitlink, email, text, Wifi, etc
bitly: QRCodeFrameType
QRCodeFrameType
bitly: SiteBlockCreateTypeEnum
SiteBlockCreateTypeEnum
Block types that can be created directly (grid and carousel are created as containers)
bitly: SiteTextBorderTypeEnum
SiteTextBorderTypeEnum
Enum of border type values on a Bitly Site
bitly: SiteTextSizeEnum
SiteTextSizeEnum
Enum of text sizes on a Bitly Site
bitly: QRCodeDotPatternType
QRCodeDotPatternType
bitly: SiteProfileImageLocation
SiteProfileImageLocation
Enum of the profile image locations available on a Bitly Site
bitly: TextBlockAppearanceRequestFontSizeEnum
TextBlockAppearanceRequestFontSizeEnum
bitly: SiteContentUnion
SiteContentUnion
bitly: InstallPreference
InstallPreference
bitly: SiteImageAlignment
SiteImageAlignment
Available image alignment types for Site background images
bitly: SiteBlockTypeEnum
SiteBlockTypeEnum
Available block types for Site blocks
bitly: GroupTopCodeScans
GroupTopCodeScans
bitly: SiteTextAlignmentEnum
SiteTextAlignmentEnum
Enum of text alignment values on a Bitly Site
bitly: DynamicRoutingDeviceEnum
DynamicRoutingDeviceEnum
Device type values for use in dynamic routing rules (device_match / device_exclude)
bitly: SiteProfileImageSize
SiteProfileImageSize
Enum of profile image sizes on a Bitly Site
bitly: SiteButtonTypeEnum
SiteButtonTypeEnum
Available button types for Site content
bitly: SiteTextLocation
SiteTextLocation
Enum of the available text locations on a Bitly Site
bitly: LaunchpadButtonTypeEnum
LaunchpadButtonTypeEnum
Available button types for Launchpad content
bitly: SiteProfileImageType
SiteProfileImageType
Enum of the profile image type options on a Bitly Site
bitly: SiteContainerTypeEnum
SiteContainerTypeEnum
Available container types
bitly: SiteProfileImageShape
SiteProfileImageShape
Enum of profile image shapes on a Bitly Site
bitly: DynamicRoutingPlatformEnum
DynamicRoutingPlatformEnum
Platform (OS) values for use in dynamic routing rules (os_match / os_exclude)
bitly: TextBlockAppearanceRequestAlignmentEnum
TextBlockAppearanceRequestAlignmentEnum
bitly: DigitalBusinessCardLayout
DigitalBusinessCardLayout
bitly: MobileOS
MobileOS
bitly: SiteBannerType
SiteBannerType
Enum of banner type options on a Bitly Site
Array types
bitly: SiteBlocks
SiteBlocks
Import
import ballerinax/bitly;Metadata
Released date: about 18 hours ago
Version: 2.0.0
License: Apache-2.0
Security
Direct vulnerabilities: No known direct vulnerabilities
Indirect vulnerabilities:
Checked on 2026-11-20 via OSV.dev
Compatibility
Platform: any
Ballerina version: 2201.12.0
GraalVM compatible: Yes
Pull count
Total: 48
Current verison: 1
Weekly downloads
Keywords
Vendor/Bitly
Area/Marketing & Social Media
Type/Connector
Contributors