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