ClickLookup
Dashboard

Retrieve a link

Returns one link with its full configuration.
GEThttps://api.clicklookup.com/v1/links/{link_id}

Requires an API key

Path parameters1

  • link_idstring · uuidrequired

Response · 20029

  • backupUrlstring · urlrequired

    Where capped or rule-excluded visitors go

  • blankReferrerbooleanrequired

    Strip the referrer so the destination cannot see the source

  • blockedUrlstring · urlrequired

    Where blocked (filtered) visitors go; null = 404

  • campaignstringrequired
    max 120 chars
  • capsobjectrequired
    Show 4 child attributes
    • maxRawintegernullable
      1–9007199254740990
    • maxRawDailyintegernullable
      1–9007199254740990
    • maxUniqueintegernullable
      1–9007199254740990
    • maxUniqueDailyintegernullable
      1–9007199254740990
  • cloakobjectrequired
    Show 4 child attributes
    • descriptionstringnullable
      max 300 chars
    • enabledboolean

      Whether the item is active.

      Default false
    • imageUrlstring · urlnullable

      Absolute http(s) URL

    • titlestringnullable
      max 120 chars
  • costnumberrequired

    What the traffic costs, interpreted by costType

    min 0
  • costTypeenumrequired
    One oftotalcpccpcRawcpacpsdailymonthly
  • createdAtstring · date-timerequired

    ISO-8601 timestamp with offset

  • destinationUrlstring · urlrequired

    Absolute http(s) URL

  • disablePixelsbooleanrequired
  • domainIdstring · uuidrequired

    Custom tracking domain; null = default domain

  • filtersobjectrequired
    Show 8 child attributes
    • blockedIpenum

      Matches the workspace IP block list

      One ofoffflagblockDefault "block"
    • datacenterenum

      Hosting / cloud ASN — servers, not people

      One ofoffflagblockDefault "flag"
    • noCookieenum

      Advanced: visitor refused the cookie

      One ofoffflagblockDefault "off"
    • noJsenum

      Advanced: visitor never ran the beacon

      One ofoffflagblockDefault "off"
    • proxyenum

      Known anonymous proxy / VPN exit

      One ofoffflagblockDefault "flag"
    • serverenum

      Scripted clients: curl, python-requests…

      One ofoffflagblockDefault "flag"
    • spiderenum

      Search-engine and social crawlers

      One ofoffflagblockDefault "block"
    • velocityenum

      30+ clicks from one visitor within a minute

      One ofoffflagblockDefault "flag"
  • funnelEntrybooleanrequired

    This link is the front of a funnel; children roll up into it

  • groupIdstring · uuidrequired

    Group to file this under; null for none.

  • idstring · uuidrequired

    UUID primary key

  • namestringrequired

    Display name, shown in the dashboard and reports.

    1–120 chars
  • notesstringrequired
    max 2000 chars
  • pixelIdsarray of strings · uuidrequired

    Retargeting pixels fired on the interstitial.

    max 20 items
  • redirectTypeenumrequired

    HTTP status used for the redirect.

    One of301302307
  • rulesarray of objectsrequired
    max 50 items
    Show 5 child attributes
    • actionobjectrequired

      What to do.

      Show 2 child attributes
      • typeenumrequired
        One ofredirectblockpass
      • urlstring · urlnullable

        Required when type = redirect

    • conditionsarray of objectsrequired
      max 10 items
      Show 3 child attributes
      • fieldenumrequired
        One ofcountrycontinenttier1deviceosbrowserlanguagereferrerHostsub1sub2sub3sub4sub5hourweekdayisRepeatqualityScore
      • openumrequired
        One ofinnotIneqneqgtltcontainsregex
      • valuesarray of stringsrequired
        max 250 items
    • idstringrequired

      Client-generated short id, stable across edits

      1–32 chars
    • enabledboolean

      Whether the item is active.

      Default true
    • namestringnullable

      Display name, shown in the dashboard and reports.

      max 80 chars
  • skipUrlCheckbooleanrequired

    Do not probe the destination for liveness

  • slugstringrequired

    URL-safe slug

    3–64 chars
  • statusenumrequired

    Lifecycle state.

    One ofactivepausedarchived
  • tagsarray of stringsrequired

    Free-form labels for filtering.

    max 20 items
  • trafficSourcestringrequired

    e.g. facebook, google-ads, newsletter

    max 80 chars
  • uniqueScopeenumrequired
    One oflinkgroupworkspace
  • updatedAtstring · date-timerequired

    ISO-8601 timestamp with offset

  • workspaceIdstring · uuidrequired

    UUID primary key