Deeplink Metrics

/v3/deeplink/event_clicks

Returns metrics for deeplink events on a single bitlink.

Authentication: oauth2

Parameters

  • smartlink_id - a bitlink hash
  • unit - minute | hour | day | week | month default:day
    Note: when unit is minute the maximum value for units is 60
  • units = an integer representing the time units to query data for. pass -1 to return all units of time.
  • 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.
    Note: historical data is stored hourly beyond the most recent 60 minutes. If a unit_reference_ts is specified, unit cannot be minute.

Return Values

  • event_clicks - clicks per event by os
  • 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.
  • unit_reference_ts - an echo of the specified unit_reference_ts value.

Example Request

API Address: https://api-ssl.bitly.com
GET /v3/deeplink/event_clicks?access_token=ACCESS_TOKEN&smartlink_id=1234

Example Response

{
  "data": {
    "event_clicks": {
      "android": {
        "app_installs": 0, 
        "app_opens": 0, 
        "interstitial_views": 0, 
        "store_visits": 0, 
        "web_opens": 0
      }, 
      "ios": {
        "app_installs": 0, 
        "app_opens": 0, 
        "interstitial_views": 0, 
        "store_visits": 0, 
        "web_opens": 0
      }, 
      "other": {
        "app_installs": 0, 
        "app_opens": 1, 
        "interstitial_views": 0, 
        "store_visits": 0, 
        "web_opens": 0
      }
    }, 
    "tz_offset": -4, 
    "unit": "day", 
    "unit_reference_ts": null, 
    "units": -1
  }, 
  "status_code": 200, 
  "status_txt": "OK"
}