Add Custom Bitlink (Premium)

Description

Add a Keyword to a Bitlink

Usage

bitly_add_cust_bitlink(
  bitlink_id = NULL,
  custom_bitlink = NULL,
  showRequestURL = FALSE
)

Arguments

Custom Bitlinks

Custom Bitlinks have both a branded short domain (BSD) AND a customized backend. For example, bit.ly/bitlinks would not be considered a Custom Bitlink because it does not have a branded short domain. es.pn/2yxklu would not be considered a custom Bitlink because while it has a branded short domain, it doesn't have a customized backhalf. An example of a link that would live in this section is es.pn/SuperBowl

See Also

https://dev.bitly.com/api-reference/#addCustomBitlink

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_add_cust_bitlink(custom_bitlink = "es.pn/SuperBowl", bitlink_id = "")

## End(Not run)

Retrieve OAuth App

Description

Retrieve details for the provided OAuth App client ID

Usage

bitly_app_details(
  client_id = "be03aead58f23bc1aee6e1d7b7a1d99d62f0ede8",
  showRequestURL = F
)

Arguments

Set bit.ly bearer API key

Description

Set bearer token as env. variable.

Usage

bitly_bearerToken(token)

See Also

https://dev.bitly.com/docs/getting-started/authentication/. Inspired by https://github.com/jhk0530/gemini.R

Examples

## Not run: 
bitly_bearerToken("access token")

## End(Not run)

Fetch all Branded Short Domains

Description

BSDs is an acronym for branded short domains. This is a custom 15 character or less domain for bitlinks. This allows you to customize the domain to your brand.

Usage

bitly_bsds(showRequestURL = F)

Arguments

See Also

https://dev.bitly.com/api-reference/#getBSDs

Branded Short Domains Group Overrides (Premium)

Description

Retrieves all account overrides matching specified group_guid and bsd query filters.

Usage

bitly_bsds_overrides(group_id = NA, showRequestURL = F)

Arguments

See Also

https://dev.bitly.com/api-reference/#getOverridesForGroups

Examples

## Not run: 
bitly_bearerToken("access token")
ui <- bitly_user_info(showRequestURL = TRUE)
bsds_over <- bitly_bsds_overrides(group_id = ui$default_group_guid[1])

## End(Not run)

Create a short Bitlink

Description

See https://dev.bitly.com/docs/getting-started/rate-limits and https://dev.bitly.com/api-reference/#createFullBitlink Convert a long url to a Bitlink and set additional parameters.

Usage

bitly_create_bitlink(
  long_url = NULL,
  domain = "bit.ly",
  title = NULL,
  tags = NULL,
  group_guid = NULL,
  deeplinks_list = list(app_uri_path = NULL, install_type = NULL, install_url = NULL,
    app_id = NULL),
  showRequestURL = FALSE
)

Arguments

Value

id - a short bitly identifier for long_url which is unique to the given account.

long_url - This may not always be equal to the URL requested, as some URL normalization may occur (e.g., due to encoding differences, or case differences in the domain). This long_url will always be functionally identical the the request parameter.

link - an bitly id with http(s) prefix

Note

Look in the vignette for bulk shortening of URLs. Each call of this function == 1 API call. Take that into consideration due to limits etc.

The bitly API does not support shortening more than one long URL with a single API call. Meaning 1 Long URL = 1 Function call.

Long URLs should be URL-encoded. You can not include a longUrl in the request that has &, ?, #, or other reserved parameters without first encoding it.

The default value for the domain parameter is selected by each user from within their bitly account settings at <https://app.bitly.com/settings/api/>.

Long URLs should not contain spaces: any longUrl with spaces will be rejected. All spaces should be either percent encoded spaces are all indications of errors. Please remember to strip leading and trailing whitespace from any user input before shortening.

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_create_bitlink(long_url = "http://slovnik.seznam.cz/")

## End(Not run)

Create Campaign (Premium)

Description

Create a new campaign

Usage

bitly_create_campaigns(
  group_guid = NULL,
  channel_guids = NULL,
  description = NULL,
  name = NULL,
  showRequestURL = T
)

Arguments

Campaigns

Bit.ly Campaigns allows you to build and manage omnichannel campaigns.

See Also

https://dev.bitly.com/api-reference/#createCampaign

Examples

## Not run: 
cc <- bitly_create_campaigns(
  group_guid = "testing", showRequestURL = TRUE, channel_guids = list("1", "2", "3"),
  description = "description", name = "name"
)

## End(Not run)

Create channel (Premium)

Description

Create a new channel

Usage

bitly_create_channel(
  group_guid = NULL,
  guid = NULL,
  name = NULL,
  modified = NULL,
  created = NULL,
  campaign_guid = NULL,
  bitlink_id = NULL,
  showRequestURL = T
)

Arguments

Campaigns

Bit.ly Campaigns allows you to build and manage omnichannel campaigns.

See Also

https://dev.bitly.com/api-reference/#createChannel

Examples

## Not run: 
gc <- bitly_create_channel(group_guid = "testing", ...)

## End(Not run)

Expand a Bitlink

Description

See https://dev.bitly.com/api-reference/#expandBitlink This endpoint returns public information for a Bitlink.

Usage

bitly_expand_link(
  bitlink_id = NULL,
  access_token = NULL,
  showRequestURL = FALSE
)

Arguments

Value

long_url - a full URL to which bitlink points to

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_expand_link(bitlink_id = "bit.ly/DPetrov")
bitly_expand_link(bitlink_id = "on.natgeo.com/1bEVhwE")

## manyHashes <- list("bit.ly/DPetrov", "bit.ly/1QU8CFm", "bit.ly/1R1LPSE", "bit.ly/1LNqqva")
## for (u in 1:length(manyHashes)) {
##   print(bitly_expand_link(bitlink_id = manyHashes[[u]], showRequestURL = TRUE))
## }

## End(Not run)

Create QR code with bit.ly link

Description

Create a new QR Code and return its metadata

Usage

bitly_qr_create_code(title = NULL, group_guid = NULL, bitly_link = NULL)

Arguments

See Also

https://dev.bitly.com/api-reference/#createQRCodePublic

Examples

## Not run: 
bitly_bearerToken("access token")
qr <- bitly_qr_create_code(group_guid = "Be2oejZbDDc", bitly_link = "bit.ly/abc1234")

## End(Not run)

bitly_rate_limits

Description

Provides bit.ly rate limits by endpoint. See https://dev.bitly.com/api-reference/#getPlatformLimitss

Usage

bitly_rate_limits(showRequestURL = F)

Arguments

Value

data.frame of end points and their rate limits by action

Retrieve a Bitlink

Description

This endpoint returns information for a Bitlink.

Usage

bitly_retrieve_bitlink(bitlink = NULL, showRequestURL = FALSE)

Arguments

See Also

See https://dev.bitly.com/api-reference/#getBitlink

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_retrieve_bitlink(bitlink = "cnn.it/2HomWGB")

## End(Not run)

Retrieve Bitlinks by Group

Description

See https://dev.bitly.com/api-reference/#getBitlinksByGroup Retrieve a paginated collection of Bitlinks for a Group

Usage

bitly_retrieve_bitlinks_by_groups(
  group_guid = NULL,
  size = 50,
  page = 1,
  showRequestURL = FALSE,
  keyword = NULL,
  query_q = NULL,
  created_before = NULL,
  created_after = NULL,
  modified_after = NULL,
  archived = "both",
  deeplinks = "both",
  campaign_guid = NULL,
  channel_guid = NULL,
  custom_bitlink = "both",
  tags = NULL,
  encoding_login = NULL,
  domain_deeplinks = "both"
)

Arguments

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_retrieve_bitlinks_by_groups(group_guid = "bit.ly/DPetrov", keyword = "novy titulek")

## End(Not run)

Retrieve a Campaign

Description

Retrive details for a campaign

Usage

bitly_retrieve_campaign(campaign_guid = NULL, showRequestURL = T)

Arguments

Campaigns

Bit.ly Campaigns allows you to build and manage omnichannel campaigns.

See Also

https://dev.bitly.com/api-reference/#getCampaign

Examples

## Not run: 
gc <- bitly_retrieve_campaign(campaign_guid = "testing")

## End(Not run)

Retrieve campaigns (Premium)

Description

Retrieve the campaigns for the current user

Usage

bitly_retrieve_campaigns(group_guid = NULL, showRequestURL = T)

Arguments

Campaigns

Bit.ly Campaigns allows you to build and manage omnichannel campaigns.

See Also

https://dev.bitly.com/api-reference/#getCampaigns

Examples

## Not run: 
gc <- bitly_retrieve_campaigns(group_guid = "testing")

## End(Not run)

Get a Channel (Premium)

Description

Get a channel's details

Usage

bitly_retrieve_channel(channel_guid = NULL, showRequestURL = T)

Arguments

Campaigns

Bit.ly Campaigns allows you to build and manage omnichannel campaigns.

See Also

https://dev.bitly.com/api-reference/#getChannel

Examples

## Not run: 
gc <- bitly_retrieve_channel(channel_guid = "testing")

## End(Not run)

Retrieve channels (Premium)

Description

Retrieve the channels available to a user

Usage

bitly_retrieve_channels(
  group_guid = NULL,
  campaign_guid = NULL,
  showRequestURL = T
)

Arguments

Campaigns

Bit.ly Campaigns allows you to build and manage omnichannel campaigns.

See Also

https://dev.bitly.com/api-reference/#getChannels

Examples

## Not run: 
gc <- bitly_retrieve_channels(group_guid = "testing", campaign_guid = "test")

## End(Not run)

Get Clicks for a Bitlink

Description

See https://dev.bitly.com/api-reference/#getClicksForBitlink This will return the click counts for a specified Bitlink. This returns an array with clicks based on a date.

Usage

bitly_retrieve_clicks(
  bitlink = NULL,
  size = 50,
  unit_reference = NULL,
  unit = NULL,
  units = -1,
  showRequestURL = FALSE
)

Arguments

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_retrieve_clicks(bitlink = "cnn.it/2HomWGB", unit = "day", units = -1, size = 100)

## End(Not run)

Get Clicks Summary for a Bitlink

Description

See https://dev.bitly.com/api-reference/#getClicksSummaryForBitlink This will return the click counts for a specified Bitlink. This rolls up all the data into a single field of clicks.

Usage

bitly_retrieve_clicks_summary(
  bitlink = NULL,
  size = 50,
  unit_reference = NULL,
  unit = NULL,
  units = -1,
  showRequestURL = FALSE
)

Arguments

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_retrieve_clicks_summary(bitlink = "cnn.it/2HomWGB", unit = "day", units = -1, size = 100)

## End(Not run)

Retrieve Custom Bitlink (Premium)

Description

Retrieve the details and history of a Custom Bitlink

Usage

bitly_retrieve_cust_bitlink(custom_bitlink = NULL, showRequestURL = FALSE)

Arguments

See Also

https://dev.bitly.com/api-reference/#getCustomBitlink

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_retrieve_cust_bitlink(custom_bitlink = "es.pn/SuperBowl")

## End(Not run)

Get Clicks for a Custom Bitlink's Entire History (Premium)

Description

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

Usage

bitly_retrieve_cust_bitlink_clicks_history(
  custom_bitlink = NULL,
  showRequestURL = FALSE
)

Arguments

See Also

https://dev.bitly.com/api-reference/#getClicksForCustomBitlink

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_retrieve_cust_bitlink_clicks_history(custom_bitlink = "es.pn/SuperBowl")

## End(Not run)

Get Metrics for a Custom Bitlink by Destination (Premium)

Description

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

Usage

bitly_retrieve_cust_bitlink_metrics_destination(
  custom_bitlink = NULL,
  showRequestURL = FALSE
)

Arguments

See Also

https://dev.bitly.com/api-reference/#getCustomBitlinkMetricsByDestination

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_retrieve_cust_bitlink_metrics_destination(custom_bitlink = "es.pn/SuperBowl")

## End(Not run)

Get Metrics for a Custom Bitlink by destination (Premium)

Description

Get Click Metrics for a Custom Bitlink by historical Bitlink destinations

Usage

bitly_retrieve_destination_metrics(
  custom_bitlink = NULL,
  showRequestURL = FALSE
)

Arguments

See Also

https://dev.bitly.com/api-reference/#getCustomBitlinkMetricsByDestination

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_retrieve_destination_metrics(custom_bitlink = "es.pn/SuperBowl")

## End(Not run)

Retrieve a single group

Description

Retrive details for a specific group that a user belongs to.

Usage

bitly_retrieve_group(group_id = NA, showRequestURL = F)

Arguments

Group

Groups are a subdivision within an organization. A user will belong to a group within an organization. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

See Also

https://dev.bitly.com/api-reference#getGroup

Examples

## Not run: 
ui <- bitly_user_info(showRequestURL = TRUE)
rg <- bitly_retrieve_group(group_guid = ui$default_group_guid)

## End(Not run)

Get Click Metrics for a specified group by city (Premium)

Description

Returns the geographic origins of click traffic by city for the specified group. Requires a premium account.

Usage

bitly_retrieve_group_click_metrics_by_cities(group_id = NA, showRequestURL = F)

Arguments

Group

Groups are a subdivision within an organization. A user will belong to a group within an organization. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

See Also

https://dev.bitly.com/api-reference/#getGroupMetricsByCities

Examples

## Not run: 
ui <- bitly_user_info(showRequestURL = TRUE)
rg <- bitly_retrieve_group_click_metrics_by_cities(group_id = ui$default_group_guid[1])

## End(Not run)

Get Click Metrics for a Group by countries

Description

This endpoint will return metrics about the countries referring click traffic rolled up to a Group

Usage

bitly_retrieve_group_click_metrics_by_countries(
  group_id = NA,
  showRequestURL = F
)

Arguments

Group

Groups are a subdivision within an organization. A user will belong to a group within an organization. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

See Also

https://dev.bitly.com/api-reference#getGroupMetricsByCountries

Examples

## Not run: 
ui <- bitly_user_info(showRequestURL = TRUE)
rg <- bitly_retrieve_group_click_metrics_by_countries(group_id = ui$default_group_guid[1])

## End(Not run)

Get Click Metrics for a specified group by devices (Premium)

Description

Returns the device types generating click traffic to the specified group's links. Requires a premium account.

Usage

bitly_retrieve_group_click_metrics_by_devices(
  group_id = NA,
  showRequestURL = F
)

Arguments

Group

Groups are a subdivision within an organization. A user will belong to a group within an organization. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

See Also

https://dev.bitly.com/api-reference/#getGroupMetricsByDevices

Examples

## Not run: 
ui <- bitly_user_info(showRequestURL = TRUE)
rg <- bitly_retrieve_group_click_metrics_by_devices(group_id = ui$default_group_guid[1])

## End(Not run)

Get Click Metrics for a Group by referring networks

Description

This endpoint will return metrics about the referring network click traffic rolled up to a Group

Usage

bitly_retrieve_group_click_metrics_by_ref_networks(
  group_id = NA,
  showRequestURL = F
)

Arguments

Group

Groups are a subdivision within an organization. A user will belong to a group within an organization. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

See Also

https://dev.bitly.com/api-reference#GetGroupMetricsByReferringNetworks

Examples

## Not run: 
ui <- bitly_user_info(showRequestURL = TRUE)
rg <- bitly_retrieve_group_click_metrics_by_ref_networks(group_id = ui$default_group_guid[1])

## End(Not run)

Retrieve group's feature limit usage

Description

Get a group's current feature limit usage.

Usage

bitly_retrieve_group_feature_usage(group_id = NA, showRequestURL = F)

Arguments

See Also

https://dev.bitly.com/api-reference/#getGroupFeatureUsage

Examples

## Not run: 
ui <- bitly_user_info(showRequestURL = TRUE)
rg <- bitly_retrieve_group_feature_usage(group_guid = ui$default_group_guid)

## End(Not run)

Retrieve Group Preferences

Description

Retrieve preferences for a specific group

Usage

bitly_retrieve_group_pref(group_id = NA, showRequestURL = F)

Arguments

Group

Groups are a subdivision within an organization. A user will belong to a group within an organization. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

See Also

https://dev.bitly.com/api-reference#getGroupPreferences

Examples

## Not run: 
ui <- bitly_user_info(showRequestURL = TRUE)
group_pref <- bitly_retrieve_group_pref(group_id = ui$default_group_guid[1])

## End(Not run)

Retrieve Group Shorten Counts

Description

Get all the shorten counts for a specific group

Usage

bitly_retrieve_group_shorten_counts(group_id = NA, showRequestURL = F)

Arguments

Group

Groups are a subdivision within an organization. A user will belong to a group within an organization. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

See Also

https://dev.bitly.com/api-reference#getGroupShortenCounts

Examples

## Not run: 
ui <- bitly_user_info(showRequestURL = TRUE)
rg <- bitly_retrieve_group_shorten_counts(group_id = ui$default_group_guid[1])

## End(Not run)

Retrieve a list of all groups

Description

Retrive details for all groups that a user belongs to.

Usage

bitly_retrieve_groups(organization_id = NULL, showRequestURL = F)

Arguments

Group

Groups are a subdivision within an organization. A user will belong to a group within an organization. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

See Also

https://dev.bitly.com/api-reference#getGroups

Examples

## Not run: 
rg <- bitly_retrieve_groups("") # will still work ok

## End(Not run)

Retrieve Bitlinks by Group

Description

Retrieve a paginated collection of Bitlinks for a Group

Usage

bitly_retrieve_links_grouped(
  group_id = NA,
  keyword = NULL,
  search_query = NULL,
  created_before = NULL,
  created_after = NULL,
  modified_after = NULL,
  archived = "off",
  deeplinks = "both",
  domain_deeplinks = "both",
  campaign_guid = NULL,
  channel_guid = NULL,
  custom_bitlink = "both",
  tags = NULL,
  encoding_login = NULL,
  page = 1,
  size = 50,
  showRequestURL = F
)

Arguments

Group

Groups are a subdivision within an organization. A user will belong to a group within an organization. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

See Also

https://dev.bitly.com/api-reference#getBitlinksByGroup

Examples

## Not run: 
ui <- bitly_user_info(showRequestURL = TRUE)
rg <- bitly_retrieve_links_grouped(group_id = ui$default_group_guid[1])

## End(Not run)

Get Metrics for a Bitlink by countries

Description

This endpoint will return metrics about the countries referring click traffic to a single Bitlink.

Usage

bitly_retrieve_metrics_by_countries(
  bitlink = NULL,
  size = 100,
  unit = NULL,
  unit_reference = NULL,
  units = -1,
  showRequestURL = FALSE
)

Arguments

See Also

https://dev.bitly.com/api-reference/#getMetricsForBitlinkByCountries

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_retrieve_metrics_by_countries(
  bitlink = "bit.ly/DPetrov", unit = "day", units = -1,
  size = 100
)

## End(Not run)

Get Metrics for a Bitlink by referrers

Description

This endpoint will return metrics about the referrers referring click traffic to a single Bitlink.

Usage

bitly_retrieve_metrics_by_referrers(
  bitlink = NULL,
  size = 100,
  unit = NULL,
  unit_reference = NULL,
  units = -1,
  showRequestURL = FALSE
)

Arguments

See Also

https://dev.bitly.com/api-reference/#getMetricsForBitlinkByReferrers

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_retrieve_metrics_by_referrers(
  bitlink = "bit.ly/DPetrov", unit = "day",
  units = -1, size = 100
)

## End(Not run)

Get Metrics for a Bitlink by referrers by domain

Description

This endpoint will group referrers metrics about a single Bitlink.

Usage

bitly_retrieve_metrics_by_referrers_by_domain(
  bitlink = NULL,
  size = 50,
  unit_reference = NULL,
  unit = NULL,
  units = -1,
  showRequestURL = FALSE
)

Arguments

See Also

https://dev.bitly.com/api-reference/#getMetricsForBitlinkByReferrersByDomains

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_retrieve_metrics_by_referrers_by_domain(
  bitlink = "bit.ly/DPetrov", unit = "day",
  units = -1, size = 100
)

## End(Not run)

Retrieve a single Organization

Description

Retrive details for the specified organization.

Usage

bitly_retrieve_org(organization_id = NULL)

Arguments

Organizations

Organizations are part of our hierarchy. This is the top level where a group and user will belong.

See Also

https://dev.bitly.com/api-reference/#getOrganization

Examples

## Not run: 
bitly_bearerToken("access token")
all_orgs <- bitly_retrieve_orgs()
ro <- bitly_retrieve_org(organization_id = all_orgs$guid)

## End(Not run)

Get Plan Limits

Description

Returns all plan limits and counts available for an organization.

Usage

bitly_retrieve_org_plan_limits(organization_id = NULL)

Arguments

Organizations

Organizations are part of our hierarchy. This is the top level where a group and user will belong.

See Also

https://dev.bitly.com/api-reference/#getPlanLimits

Examples

## Not run: 
bitly_bearerToken("access token")
all_orgs <- bitly_retrieve_orgs()
plan <- bitly_retrieve_org_plan_limits(organization_id = all_orgs$guid)

## End(Not run)

Retrieve Organization Shorten Counts

Description

Retrieve all the shorten counts for a specific organization

Usage

bitly_retrieve_org_shorten_counts(organization_id = NULL)

Arguments

Value

facet - Enum: "countries" "referrers" "referrers_by_domain" "referring_domains" "referring_networks" "shorten_counts"

Organizations

Organizations are part of our hierarchy. This is the top level where a group and user will belong.

See Also

https://dev.bitly.com/api-reference/#getOrganizationShortenCounts

Examples

## Not run: 
bitly_bearerToken("access token")
all_orgs <- bitly_retrieve_orgs()
osc <- bitly_org_shorten_counts(organization_id = all_orgs$guid)
df_org_short_counts <- data.frame(osc)

## End(Not run)

Retrieve Organization Shorten Counts by Group

Description

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

Usage

bitly_retrieve_org_shorten_counts_by_group(organization_id = NULL)

Arguments

Organizations

Organizations are part of our hierarchy. This is the top level where a group and user will belong.

See Also

https://dev.bitly.com/api-reference/#getOrganizationShortenCountsByGroup

Examples

## Not run: 
bitly_bearerToken("access token")
all_orgs <- bitly_retrieve_orgs()
osc <- bitly_retrieve_org_shorten_counts_by_group(organization_id = all_orgs$guid)
df_org_short_counts <- data.frame(osc)

## End(Not run)

Retrieve all Organizations

Description

Retrieve a list of organizations

Usage

bitly_retrieve_orgs()

Organizations

Organizations are part of our hierarchy. This is the top level where a group and user will belong.

See Also

https://dev.bitly.com/api-reference/#getOrganizations

Examples

## Not run: 
bitly_bearerToken("access token")
ros <- bitly_retrieve_orgs()

## End(Not run)

Retrieve Sorted Bitlinks for Group

Description

See https://dev.bitly.com/api-reference/#getSortedBitlinks This will retrieve a paginated response for Bitlinks that are sorted for the Group

Usage

bitly_retrieve_sorted_bitlinks_by_groups(
  group_guid = NULL,
  unit = "day",
  units = -1,
  sort = "clicks",
  size = 50,
  unit_reference = NULL,
  showRequestURL = FALSE
)

Arguments

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_retrieve_sorted_bitlinks_by_groups(group_guid = "", sort = "clicks")

## End(Not run)

Retrieve Sorted Bitlinks for Group

Description

This will retrieve a paginated response for Bitlinks that are sorted for the Group. This method returns a combined object which end-user (you) have to further process for your needs.

Usage

bitly_retrieve_sorted_links(
  group_id = NA,
  to_sort_by = "clicks",
  unit = "day",
  units = -1,
  unit_reference = NULL,
  size = 50,
  showRequestURL = F
)

Arguments

Group

Groups are a subdivision within an organization. A user will belong to a group within an organization. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

See Also

https://dev.bitly.com/api-reference#getSortedBitlinks

Examples

## Not run: 
ui <- bitly_user_info(showRequestURL = TRUE)
rg <- bitly_retrieve_sorted_links(group_id = ui$default_group_guid[1])

## End(Not run)

Retrieve Tags by Group

Description

Retrieve the currently used tags for a group

Usage

bitly_retrieve_tags(group_id = NA, showRequestURL = F)

Arguments

Group

Groups are a subdivision within an organization. A user will belong to a group within an organization. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

See Also

https://dev.bitly.com/api-reference#getGroupTags

Examples

## Not run: 
ui <- bitly_user_info(showRequestURL = TRUE)
rg <- bitly_retrieve_tags(group_id = ui$default_group_guid[1])

## End(Not run)

Shorten a Link

Description

See https://dev.bitly.com/api-reference/#createBitlink Convert a long url to a Bitlink

Usage

bitly_shorten_link(
  domain = "bit.ly",
  group_guid = NULL,
  long_url = NULL,
  access_token = NULL,
  showRequestURL = FALSE
)

Arguments

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_shorten_link(url = "http://www.seznam.cz/")
bitly_shorten_link(url = "http://www.seznam.cz/", showRequestURL = TRUE)

manyUrls <- list(
  "http://www.seznam.cz/", "http://www.seznamasdas.cz/",
  "http://www.seznam.cz/asadasd", "http://www.seznam.cz/adqwrewtregt"
)
for (u in 1:length(manyUrls)) {
  print(bitly_shorten_link(long_url = manyUrls[[u]], showRequestURL = TRUE))
}

## End(Not run)

Update a Bitlink

Description

See https://dev.bitly.com/api-reference/#updateBitlink Update fields in the Bitlink

Usage

bitly_update_bitlink(
  bitlink = NULL,
  archived = NULL,
  tags = NULL,
  showRequestURL = FALSE,
  created_at = NULL,
  title = NULL,
  created_by = NULL,
  long_url = NULL,
  client_id = NULL,
  custom_bitlinks = NULL,
  link = NULL,
  id = NULL,
  deeplinks = list(bitlink = NULL, install_url = NULL, created = NULL, modified = NULL,
    app_uri_path = NULL, install_type = NULL, app_guid = NULL, guid = NULL, os = NULL)
)

Arguments

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_update_bitlink(bitlink = "bit.ly/DPetrov", title = "novy titulek")

## hash is the one which is only returned. Dont use
bitly_update_bitlink(bitlink = "on.natgeo.com/1bEVhwE")

## manyHashes <- list("bit.ly/DPetrov", "bit.ly/1QU8CFm", "bit.ly/1R1LPSE", "bit.ly/1LNqqva")
## for (u in 1:length(manyHashes)) {
##   print(bitly_update_bitlink(bitlink = manyHashes[[u]],
##                 title = stri_rand_strings(1, 8, pattern = "[A-Za-z0-9]")))
## }

## End(Not run)

Update A Channel (Premium)

Description

Update an existing Channel

Usage

bitly_update_campaign(
  campaign_guid = NULL,
  group_guid = NULL,
  channel_guids = NULL,
  description = NULL,
  name = NULL,
  showRequestURL = T
)

Arguments

Campaigns

Bit.ly Campaigns allows you to build and manage omnichannel campaigns.

See Also

https://dev.bitly.com/api-reference/#updateCampaign

Examples

## Not run: 
cc <- bitly_update_campaign(
  group_guid = "", channel_guids = list("1", "2", "3"),
  description = "description", name = "name"
)

## End(Not run)

Update A Channel (Premium)

Description

Update an existing Channel

Usage

bitly_update_channel(
  channel_guid = NULL,
  group_guid = NULL,
  guid = NULL,
  name = NULL,
  modified = NULL,
  created = NULL,
  campaign_guid = NULL,
  bitlink_id = NULL,
  showRequestURL = T
)

Arguments

Campaigns

Bit.ly Campaigns allows you to build and manage omnichannel campaigns.

See Also

https://dev.bitly.com/api-reference/#updateChannel

Examples

## Not run: 
uc <- bitly_update_channel(channel_guid = "testing", group_guid = "", name = "name")

## End(Not run)

Update Custom Bitlink (Premium)

Description

Move a Keyword to a different Bitlink

Usage

bitly_update_cust_bitlink(
  custom_bitlink = NULL,
  bitlink_id = NULL,
  showRequestURL = FALSE
)

Arguments

See Also

https://dev.bitly.com/api-reference/#updateCustomBitlink

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_update_cust_bitlink(custom_bitlink = "es.pn/SuperBowl", bitlink_id = "")

## End(Not run)

Update a Group

Description

Update the details of a group

Usage

bitly_update_group(
  group_id = NA,
  name = NA,
  organization_id = NA,
  showRequestURL = F
)

Arguments

Group

Groups are a subdivision within an organization. A user will belong to a group within an organization. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

See Also

https://dev.bitly.com/api-reference#updateGroup

[bitly_update_user()]

Examples

## Not run: 
ui <- bitly_user_info(showRequestURL = TRUE)
up_group <- bitly_update_group(
  group_id = ui$default_group_guid[1], name = "New Group Name",
  organization_id = "asd"
)

## End(Not run)

Update Group Preferences

Description

Update preferences for a specific group

Usage

bitly_update_group_pref(group_id = NA, domain_pref = NA, showRequestURL = F)

Arguments

Group

Groups are a subdivision within an organization. A user will belong to a group within an organization. Most actions on our API will be on behalf of a group. For example, when you shorten a link, it will be on behalf of a user and a group.

See Also

https://dev.bitly.com/api-reference#updateGroupPreferences

Examples

## Not run: 
ui <- bitly_user_info(showRequestURL = TRUE)
group_pref <- bitly_update_group_pref(group_id = ui$default_group_guid[1])

## End(Not run)

Update your name and/or default group ID

Description

This will overwrite your (display) username and/or group ID you belong to.

Usage

bitly_update_user(default_group_guid = NULL, name = "", showRequestURL = FALSE)

Arguments

User

User operations such as changing your name or fetching basic user information apply only to the authenticated user.

Note

Applies only to the authenticated user: Changing group/org ID is only permitted to premium users. Thus, if you are a "free" user and will try to change your default group id to something else, you will get an error. In that case, only changing display name is permitted.

See Also

https://dev.bitly.com/api-reference/#updateUser

Examples

## Not run: 
bitly_bearerToken("access token")
# this applies only for "free" users
uu <- bitly_update_user(name = "Malc")

# if you are premium user, you can additionally adjust your group id
uug <- bitly_update_user(name = "Malc", default_group_guid = "TestGroupID")

## End(Not run)

Retrieve information for the current authenticated user

Description

Retrieve information for the current authenticated user

Usage

bitly_user_info(showRequestURL = FALSE)

Arguments

Value

login - the specified bitly login or the login of the authenticated user

name - the user's full/display name

default_group_guid - a group to which user belongs

created - Timestamp for the moment the user signed up (uses ymd_hms)

is_active - whether a user profile is active

modified - Timestamp of the last modification to the user profile (uses ymd_hms)

is_sso_user - is Single-Sign-On enabled for the user (PREMIUM FEATURE)

is_2fa_enabled - is 2 Step verification enabled ?

email - user's emails

User

User operations such as changing your name or fetching basic user information apply only to the authenticated user.

See Also

https://dev.bitly.com/api-reference/#getUser

Examples

## Not run: 
bitly_bearerToken("access token")
ui <- bitly_user_info(showRequestURL = TRUE)

## End(Not run)

Get Metrics for a Bitlink by referring domains

Description

This endpoint will rollup the click counts to a referrer about a single Bitlink.

Usage

bitly_user_metrics_referring_domains(
  bitlink = NULL,
  unit = "day",
  units = -1,
  size = 50,
  unit_reference = NULL,
  showRequestURL = FALSE
)

Arguments

Value

facet - string | One of "countries" "referrers" "referrers_by_domain" "referring_domains" "referring_networks" "shorten_counts"

See Also

See https://dev.bitly.com/api-reference/#getMetricsForBitlinkByReferringDomains

Examples

## Not run: 
bitly_bearerToken("access token")
bitly_user_metrics_referring_domains(
  bitlink = "cnn.it/2HomWGB", unit = "month", units = -1,
  size = 100
)

## End(Not run)

Check if authenticated user holds premium account

Description

Check if authenticated user holds premium account

Usage

is_bitly_user_premium_holder()

See Also

[bitly_user_info()]

Expand a short URL to a longer one

Description

See https://is.gd/apilookupreference.php

Usage

isgd_LinksExpand(shorturl = "", showRequestURL = FALSE)

Arguments

Examples

## Not run: 
isgd_LinksExpand(shorturl = "https://is.gd/4oIAXJ", showRequestURL = TRUE)

## End(Not run)

Given a long URL, returns a short is.gd link.

Description

See https://is.gd/apishorteningreference.php

Usage

isgd_LinksShorten(
  longUrl = "",
  logstats = "0",
  shorturl = NULL,
  showRequestURL = FALSE
)

Arguments

Examples

## Not run: 
short_lin <- isgd_LinksShorten(longUrl = "https://novinky.cz/", showRequestURL = TRUE)

## End(Not run)

Shorten an URL

Description

Call this function as an addin to prompt a url shortener. bit.ly accepts a custom domain, see bitly_shorten_link.

Usage

shortenerAddin()

Expand a short URL to a longer one

Description

See https://v.gd/apilookupreference.php

Usage

vgd_LinksExpand(shorturl = "", showRequestURL = FALSE)

Arguments

Examples

## Not run: 
isgd_LinksExpand(shorturl = "https://v.gd/4oIAXJ", showRequestURL = TRUE)

## End(Not run)

Given a long URL, returns a short v.gd link.

Description

See https://v.gd/apishorteningreference.php

Usage

vgd_LinksShorten(
  longUrl = "",
  logstats = "0",
  shorturl = NULL,
  showRequestURL = FALSE
)

Arguments

Examples

## Not run: 
assd <- vgd_LinksShorten(longUrl = "https://novinky.cz/", showRequestURL = TRUE)

## End(Not run)