ClickLookup
Dashboard

Retrieve a rotator

Returns one rotator with its configuration.
GEThttps://api.clicklookup.com/v1/rotators/{rotator_id}

Requires an API key

Path parameters1

  • rotator_idstring · uuidrequired

Response · 20024

  • backupUrlstring · urlrequired

    Absolute http(s) URL

  • blankReferrerbooleanrequired
  • blockedUrlstring · urlrequired

    Absolute http(s) URL

  • 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
    min 0
  • costTypeenumrequired
    One oftotalcpccpcRawcpacpsdailymonthly
  • createdAtstring · date-timerequired

    ISO-8601 timestamp with offset

  • domainIdstring · uuidrequired
  • 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"
  • groupIdstring · uuidrequired

    Group to file this under; null for none.

  • idstring · uuidrequired

    UUID primary key

  • lastResetAtstring · date-timerequired

    When its clicks and counters were last wiped

  • modeenumrequired
    One offulfillmentspilloverrandomsequential
  • 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
  • randomizeobjectrequired
    Show 5 child attributes
    • enabledboolean

      Whether the item is active.

      Default false
    • everyMinutesintegernullable

      Re-shuffle order every N minutes

      1–1440
    • ignoreFirstboolean

      Keep URL 1 pinned at the top

      Default false
    • ignoreLastboolean

      Keep the last URL pinned at the bottom

      Default false
    • realtimeboolean

      Shuffle on every click instead of on a timer

      Default false
  • repeatPolicyenumrequired
    One ofsameUrlnextUrlrandomUrl
  • 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
  • slugstringrequired

    URL-safe slug

    3–64 chars
  • spilloverEndenumrequired
    One ofbackupUrllastUrltopOfRotator
  • statusenumrequired

    Lifecycle state.

    One ofactivepausedarchived
  • updatedAtstring · date-timerequired

    ISO-8601 timestamp with offset

  • workspaceIdstring · uuidrequired

    UUID primary key