Method: Bitly::API::Client#group_bitlinks

Defined in:
lib/bitly/api/client.rb

Retrieve a list of bitlinks by group [‘GET /v4/groups/group_guid/bitlinks`](dev.bitly.com/api-reference/#getBitlinksByGroup)

Examples:

bitlinks = client.group_bitlinks(group_guid: guid)

Parameters:

  • client (Bitly::API::Client) —

    An authorized API client

  • group_guid (String) —

    The group guid for which you want bitlinks

  • size (Integer) (defaults to: nil) —

    The number of Bitlinks to return, max 100

  • page (Integer) (defaults to: nil) —

    The page of bitlinks to request

  • keyword (String) (defaults to: nil) —

    Custom keyword to filter on history entries

  • query (String) (defaults to: nil) —

    A value to search for Bitlinks

  • created_before (Integer) (defaults to: nil) —

    Timestamp as an integer unix epoch

  • created_after (Integer) (defaults to: nil) —

    Timestamp as an integer unix epoch

  • modified_after (Integer) (defaults to: nil) —

    Timestamp as an integer unix epoch

  • archived (String) (defaults to: nil) —

    Whether or not to include archived Bitlinks. One of “on”, “off” or “both”. Defaults to “off”.

  • deeplinks (String) (defaults to: nil) —

    Filter to only Bitlinks that contain deeplinks. One of “on”, “off” or “both”. Defaults to “both”.

  • domain_deeplinks (String) (defaults to: nil) —

    Filter to only Bitlinks that contain deeplinks configured with a custom domain. One of “on”, “off” or “both”. Defaults to “both”.

  • campaign_guid (String) (defaults to: nil) —

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

  • channel_guid (String) (defaults to: nil) —

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

  • custom_bitlink (String) (defaults to: nil) —

    Filter to return only custom Bitlinks. One of “on”, “off” or “both”. Defaults to “both”.

  • tags (Array<String>) (defaults to: nil) —

    Filter by the given tags.

  • encoding_login (Array<String>) (defaults to: nil) —

    Filter by the login of the authenticated user that created the Bitlink.

Returns:



448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/bitly/api/client.rb', line 448

def group_bitlinks(
  group_guid:,
  size: nil,
  page: nil,
  keyword: nil,
  query: nil,
  created_before: nil,
  created_after: nil,
  modified_after: nil,
  archived: nil,
  deeplinks: nil,
  domain_deeplinks: nil,
  campaign_guid: nil,
  channel_guid: nil,
  custom_bitlink: nil,
  tags: nil,
  encoding_login: nil
)
  Bitlink.list(
    client: self,
    group_guid: group_guid,
    size: size,
    page: page,
    keyword: keyword,
    query: query,
    created_before: created_before,
    created_after: created_after,
    modified_after: modified_after,
    archived: archived,
    deeplinks: deeplinks,
    domain_deeplinks: domain_deeplinks,
    campaign_guid: campaign_guid,
    channel_guid: channel_guid,
    custom_bitlink: custom_bitlink,
    tags: tags,
    encoding_login: 
  )
end