Deprecated Endpoints

/v3/clicks

deprecated Note: this is deprecated in favor of /v3/link/clicks

returns the daily timeseries clicks for a given Bitlink

Parameters

  • hash - refers to one or more bitly hashes. e.g.: 2bYgqR or a-custom-name
  • shortUrl - refers to one or more Bitlinks e.g.: http://bit.ly/1RmnUT or http://j.mp/1RmnUT

Note: The maximum number of shortUrl and hash parameters is 15

Return Values

  • short_url this matches the shortUrl request parameter.
  • hash this matches the hash request parameter.
  • user_hash is the corresponding bitly user identifier.
  • global_hash is the corresponding bitly aggregate identifier.
  • user_clicks this is the total count of clicks to this user's Bitlink.
  • global_clicks this is the total count of clicks to all Bitlinks that point to the same same long url.
  • error indicates there was an error retrieving data for a given shortUrl or hash. An example error is "NOT_FOUND"

/v3/clicks_by_day

For one or more Bitlinks, provides time series clicks per day for the last 1-30 days in reverse chronological order (most recent to least recent).

deprecated Note: this is deprecated in favor of /v3/link/clicks?unit=day&units=7

Parameters

  • hash - refers to one or more bitly hashes. e.g.: 2bYgqR or a-custom-name
  • shortUrl - refers to one or more Bitlinks e.g.: http://bit.ly/1RmnUT or http://j.mp/1RmnUT
  • days - specifies the number of days for which to retrieve click data, from 1 to 30 (default 7).

Note: The maximum number of shortUrl and hash parameters is 15

Return Values

  • short_url this matches the shortUrl request parameter.
  • hash this matches the hash request parameter.
  • user_hash is the corresponding bitly user identifier.
  • global_hash is the corresponding bitly aggregate identifier.
  • user_clicks this is the total count of clicks to this user's Bitlink.
  • clicks is the number of clicks received for a given link that day.
  • day_start is time code representing the start of the day for which click data is provided.

/v3/clicks_by_minute

For one or more Bitlinks, provides time series clicks per minute for the last hour in reverse chronological order (most recent to least recent).

deprecated Note: this is deprecated in favor of /v3/link/clicks?unit=minute&units=60

Parameters

  • hash - refers to one or more bitly hashes. e.g.: 2bYgqR or a-custom-name
  • shortUrl - refers to one or more Bitlinks e.g.: http://bit.ly/1RmnUT or http://j.mp/1RmnUT

Note: The maximum number of shortUrl and hash parameters is 15

Return Values

  • short_url this matches the shortUrl request parameter.
  • hash this matches the hash request parameter.
  • user_hash is the corresponding bitly user identifier.
  • global_hash is the corresponding bitly aggregate identifier.
  • clicks is the number of clicks received for a given link that minute.

/v3/countries

deprecated Note: this is deprecated in favor of /v3/link/countries

Parameters

  • hash - refers to a bitly hash. e.g.: 2bYgqR or a-custom-name
  • shortUrl - refers to a Bitlinks e.g.: http://bit.ly/1RmnUT or http://j.mp/1RmnUT

Note: Either shortUrl or hash must be given as a parameter

Return Values

  • short_url this matches the shortUrl request parameter.
  • hash this matches the hash request parameter.
  • user_hash is the corresponding bitly user identifier.
  • global_hash is the corresponding bitly aggregate identifier.
  • countries is a list of countries from which clicks on the Bitlink have originated.
  • clicks is the number of clicks from the corresponding referrer.

/v3/lookup

deprecated Note: this is deprecated in favor of /v3/link/lookup

This is used to query for a Bitlink based on a long URL. For example you would use /v3/lookup followed by /v3/link/clicks to find click data when you have a long URL to start with.

This endpoint exists to maintain backwards compatibility with the old response format of /v3/lookup; use the new, preferred, endpoint /v3/link/lookup

Parameters

  • url - one or more long URLs to lookup

Return Values

  • url - an echo back of the url parameter.
  • short_url - the corresponding Bitlink.
  • global_hash - the corresponding bitly aggregate identifier.

/v3/referrers

deprecated Note: this is deprecated in favor of /v3/link/referrers and /v3/link/referring_domains

Parameters

  • hash - refers to a bitly hash. e.g.: 2bYgqR or a-custom-name
  • shortUrl - refers to a Bitlinks e.g.: http://bit.ly/1RmnUT or http://j.mp/1RmnUT

Note: Either shortUrl or hash must be given as a parameter

Return Values

  • short_url this matches the shortUrl request parameter.
  • hash this matches the hash request parameter.
  • user_hash is the corresponding bitly user identifier.
  • global_hash is the corresponding bitly aggregate identifier.
  • referrer is a referring site for a given Bitlink.
  • referrer_app is a referring application (such as Tweetdeck) for a given Bitlink.
  • url is the URL of a referring application (such as http://tweetdeck.com).
  • clicks is the number of clicks from the corresponding referrer.

/v3/validate

deprecated Note: this is deprecated in favor of OAuth 2.0.

For any given a bitly user login and apiKey, you can validate that the pair is active.

Parameters

  • x_login - the end users user's bitly login (for validation).
  • x_apiKey - the end users bitly apiKey (for validation).

Return Values

  • valid 0 or 1 designating whether the x_login and x_apiKey pair is currently valid.