Organization Metrics

/v3/organization/brand_messages

Returns the top Bitlinks created by you with traffic, that did not also have non-organization traffic in the same time period, ordered by clicks.

This endpoint is only available to Bitly Enterprise customers.

Authentication: oauth2

Parameters

  • domain - a tracking or e2e domain for this organization. May be specified more than once, or omitted for all domains.
  • unit - hour | day | week | month default:day
  • units - an integer representing the time units to query data for.
  • timezone - an integer hour offset from UTC (-14..14), or a timezone string. default:America/New_York.
  • limit - 1..1000 (default=100)
  • unit_reference_ts - an epoch timestamp, indicating the most recent time for which to pull metrics. default:now
    Note: the value of unit_reference_ts rounds to the nearest unit.

Return Values

  • tz_offset - the offset for the specified timezone, in hours.
  • unit - an echo of the specified unit value.
  • units - an echo of the specified units value.
  • brand_messages - a list of links ordered by clicks:
    • link - the aggregate link.
    • clicks - the number of clicks in the specified time frame.

/v3/organization/clicks

Returns the number of clicks on Bitlinks created by your organization or by other Bitly users that point to your domains.

This endpoint is only available to Bitly Enterprise customers.

Authentication: oauth2

Parameters

  • domain - filter to a tracking or e2e domain for this organization. If unspecified, aggregate of all domains in this organization is pulled.
  • login - an account in this organization. If unspecified, aggregate of all accounts in this organization is pulled. ! is a valid option to exclude the organizations Bitlinks.
  • unit - hour | day | week | month default:day
  • units - an integer representing the time units to query data for.
  • timezone - an integer hour offset from UTC (-14..14), or a timezone string. default:America/New_York.
  • limit - 1..1000 (default=100)
  • unit_reference_ts - an epoch timestamp, indicating the most recent time for which to pull metrics. default:now
    Note: the value of unit_reference_ts rounds to the nearest unit.

Return Values

  • tz_offset - the offset for the specified timezone, in hours.
  • unit - an echo of the specified unit value.
  • units - an echo of the specified units value.
  • organization_clicks - a list of ts, click count pairs
    • dt - a unix timestamp
    • clicks - the clicks count for this specified time frame

Example Request

API Address: https://api-ssl.bitly.com
GET /v3/organization/clicks?units=7&access_token=ACCESS_TOKEN&unit=day

/v3/organization/leaderboard

Returns the top-performing organization members ordered by clicks or shortens.

This endpoint is only available to Bitly Enterprise customers.

Authentication: oauth2

Parameters

  • domain - a tracking or e2e domain for this organization. May be specified more than once.
  • orderby - either clicks or shortens. Default is clicks.
  • unit - hour | day | week | month default:day
  • units - an integer representing the time units to query data for.
  • timezone - an integer hour offset from UTC (-14..14), or a timezone string. default:America/New_York.
  • limit - 1..1000 (default=100)
  • unit_reference_ts - an epoch timestamp, indicating the most recent time for which to pull metrics. default:now
    Note: the value of unit_reference_ts rounds to the nearest unit.

Return Values

  • tz_offset - the offset for the specified timezone, in hours.
  • unit - an echo of the specified unit value.
  • units - an echo of the specified units value.
  • leaderboard - a list of elements ordered by clicks or shortens:
    • login - the user's login.
    • clicks - the number of clicks on the user's Bitlinks in the specified time frame.
    • shortens - the number of Bitlinks shortened by the user in the specified time frame.

Example Request

API Address: https://api-ssl.bitly.com
GET /v3/organization/leaderboard?units=1&access_token=ACCESS_TOKEN&unit=day

/v3/organization/missed_opportunities

Returns the top links shared by your audience, but not by you, ordered by clicks.

This endpoint is only available to Bitly Enterprise customers.

Authentication: oauth2

Parameters

  • domain - a tracking or e2e domain for this organization. May be specified more than once, or omitted for all domains.
  • unit - hour | day | week | month default:day
  • units - an integer representing the time units to query data for.
  • timezone - an integer hour offset from UTC (-14..14), or a timezone string. default:America/New_York.
  • limit - 1..1000 (default=100)
  • unit_reference_ts - an epoch timestamp, indicating the most recent time for which to pull metrics. default:now
    Note: the value of unit_reference_ts rounds to the nearest unit.

Return Values

  • tz_offset - the offset for the specified timezone, in hours.
  • unit - an echo of the specified unit value.
  • units - an echo of the specified units value.
  • missed_opportunities - a list of links ordered by clicks:
    • link - the aggregate link.
    • clicks - the number of clicks in the specified time frame.

/v3/organization/shorten_counts

Returns the number of Bitlinks created by your organization or by other Bitly users that point to your domains.

This endpoint is only available to Bitly Enterprise customers.

Authentication: oauth2

Parameters

  • domain - filter to a tracking or e2e domain for this organization. If unspecified, aggregate of all domains in this organization is pulled.
  • login - an account in this organization. If unspecified, aggregate of all accounts in this organization is pulled. ! is a valid option to exclude the organizations Bitlinks.
  • unit - hour | day | week | month default:day
  • units - an integer representing the time units to query data for.
  • timezone - an integer hour offset from UTC (-14..14), or a timezone string. default:America/New_York.
  • limit - 1..1000 (default=100)
  • unit_reference_ts - an epoch timestamp, indicating the most recent time for which to pull metrics. default:now
    Note: the value of unit_reference_ts rounds to the nearest unit.

Return Values

  • tz_offset - the offset for the specified timezone, in hours.
  • unit - an echo of the specified unit value.
  • units - an echo of the specified units value.
  • organization_shorten_counts - a list of ts, bitlinks created pairs
    • dt - a unix timestamp
    • shortens - the Bitlinks created in this specified time frame

Example Request

API Address: https://api-ssl.bitly.com
GET /v3/organization/shorten_counts?units=7&access_token=ACCESS_TOKEN&unit=day