urlshorteneR (version 1.5.7)

bitly_retrieve_links_grouped: 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_id

- a required string | A GUID for a Bitly group

keyword

- Custom keyword to filter on history entries

search_query

- string | the value that you would like to search

created_before

- Timestamp as an integer unix epoch

created_after

- Timestamp as an integer unix epoch

modified_after

- Timestamp as an integer unix epoch, see as_datetime or anytime's as_datetime

archived

- string | Default: "off" | Enum:"on" "off" "both" | Whether or not to include archived bitlinks

deeplinks

- string | Default: "both" | Enum:"on" "off" "both" | Filter to only Bitlinks that contain deeplinks

domain_deeplinks

- string | Default: "both" | Enum:"on" "off" "both" | Filter to only Bitlinks that contain deeplinks configured with a custom domain

campaign_guid

- Filter to return only links for the given campaign GUID, can be provided

channel_guid

- Filter to return only links for the given channel GUID, can be provided, overrides all other parameters

custom_bitlink

- string | Default: "both" | Enum:"on" "off" "both"

tags

- Array of string | filter by given tags

encoding_login

- Array of string | Filter by the login of the authenticated user that created the Bitlink

page

- Default: 1 | Integer specifying the numbered result at which to start

size

- string | Default: 50 | The quantity of items to be be returned

showRequestURL

- an optional T/F value to whether show URL which has been build and requested from server. For debug purposes, default FALSE.

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

if (FALSE) {
ui <- bitly_user_info(showRequestURL = TRUE)
rg <- bitly_retrieve_links_grouped(group_id = ui$default_group_guid[1])
}