urlshorteneR (version 1.5.7)

bitly_retrieve_bitlinks_by_groups: 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

group_guid

- a GUID for a Bitly group

size

- The quantity of items to be be returned

page

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

showRequestURL

- show URL which has been build and requested from server. For debug purposes.

keyword

- Custom keyword to filter on history entries

query_q

- a query to look for in bitlinks; acts a filter

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

campaign_guid

- string | A GUID for a Bitly campaign

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, use e.g. c("test1", "test2")

encoding_login

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

domain_deeplinks

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

Examples

if (FALSE) {
bitly_retrieve_bitlinks_by_groups(group_guid = "bit.ly/DPetrov", keyword = "novy titulek")
}