ClickLookup
Dashboard

Create a rotator URL

Adds a destination URL to the rotator.
POSThttps://api.clicklookup.com/v1/rotators/{rotator_id}/urls

Requires an API key

Path parameters1

  • rotator_idstring · uuidrequired

Request body23

  • namestringrequired

    Display name, shown in the dashboard and reports.

    1–120 chars
  • urlstring · urlrequired

    Absolute http(s) URL

  • bonusPctintegernullable
    0–100
  • capsobjectnullable
    Show 4 child attributes
    • maxRawintegernullable
      1–9007199254740990
    • maxRawDailyintegernullable
      1–9007199254740990
    • maxUniqueintegernullable
      1–9007199254740990
    • maxUniqueDailyintegernullable
      1–9007199254740990
  • endAtstring · date-timenullable
  • finishActivateIdstring · uuidnullable
  • minQualityScoreintegernullable
    0–100
  • mobileMaxPctintegernullable
    0–100
  • mobileMinPctintegernullable
    0–100
  • notesstringnullable
    max 2000 chars
  • notifyobjectnullable
    Show 4 child attributes
    • emailstring · emailnullable

      Extra recipient, e.g. the client

      max 255 chars
    • onCapboolean
      Default false
    • onEndboolean
      Default false
    • onStartboolean
      Default false
  • pixelIdsarray of strings · uuidnullable

    Retargeting pixels fired on the interstitial.

    max 20 items
  • positionintegernullable

    Order in the rotation (0 = first).

    0–9007199254740990
  • priorityintegernullable
    1–9
  • qualityMaxPctintegernullable
    0–100
  • remoteStatsUrlstring · urlnullable

    Absolute http(s) URL

  • rulesarray of objectsnullable
    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
  • smartSwapIdstring · uuidnullable
  • startAtstring · date-timenullable
  • statusenumnullable

    Lifecycle state.

    One ofactivepausedarchived
  • tier1MaxPctintegernullable
    0–100
  • tier1MinPctintegernullable
    0–100
  • weightintegernullable

    Relative share of traffic in weighted mode.

    1–100

Response · 20128

  • bonusPctintegerrequired

    Over-deliver this % beyond the cap

    0–100
  • capsobjectrequired
    Show 4 child attributes
    • maxRawintegernullable
      1–9007199254740990
    • maxRawDailyintegernullable
      1–9007199254740990
    • maxUniqueintegernullable
      1–9007199254740990
    • maxUniqueDailyintegernullable
      1–9007199254740990
  • createdAtstring · date-timerequired

    ISO-8601 timestamp with offset

  • endAtstring · date-timerequired
  • finishActivateIdstring · uuidrequired

    Rotator URL to activate when this one finishes

  • idstring · uuidrequired

    UUID primary key

  • minQualityScoreintegerrequired

    Min IP quality score (QIQ) a visitor needs for this URL

    0–100
  • mobileMaxPctintegerrequired
    0–100
  • mobileMinPctintegerrequired
    0–100
  • namestringrequired

    Display name, shown in the dashboard and reports.

    1–120 chars
  • notesstringrequired
    max 2000 chars
  • notifyobjectrequired
    Show 4 child attributes
    • emailstring · emailnullable

      Extra recipient, e.g. the client

      max 255 chars
    • onCapboolean
      Default false
    • onEndboolean
      Default false
    • onStartboolean
      Default false
  • pixelIdsarray of strings · uuidrequired

    Retargeting pixels fired on the interstitial.

    max 20 items
  • positionintegerrequired

    Order in the rotation (0 = first).

    0–9007199254740990
  • priorityintegerrequired

    Spillover order: 1 is served first, 9 last, 5 is the default

    1–9
  • qualityMaxPctintegerrequired

    Max share of low-quality visitors

    0–100
  • remoteStatsUrlstring · urlrequired

    The client's own stats page, linked as Remote

  • rotatorIdstring · uuidrequired

    UUID primary key

  • 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
  • smartSwapIdstring · uuidrequired

    Rotator URL that swaps positions with this one when it finishes

  • startAtstring · date-timerequired
  • statusenumrequired

    Lifecycle state.

    One ofactivepausedarchived
  • tier1MaxPctintegerrequired
    0–100
  • tier1MinPctintegerrequired

    Min share of tier-1 (US/UK/CA/AU/NZ) visitors

    0–100
  • updatedAtstring · date-timerequired

    ISO-8601 timestamp with offset

  • urlstring · urlrequired

    Absolute http(s) URL

  • weightintegerrequired

    Relative share of traffic in weighted mode.

    1–100
  • workspaceIdstring · uuidrequired

    UUID primary key