List clicks

Returns individual clicks, newest first, with filters for link, rotator, country and more.
GEThttps://api.clicklookup.com/v1/clicks

Requires an API key

Query parameters12

  • linkIdstring · uuidnullable

    Only clicks on this link.

  • rotatorIdstring · uuidnullable

    Only clicks on this rotator.

  • from_string · date-timenullable

    Start of the period (ISO-8601). Overrides days.

  • tostring · date-timenullable

    End of the period (ISO-8601). Defaults to now.

  • daysinteger

    Length of the period, counted back from now. Ignored when from_ is set.

    Default 301–366
  • countrystringnullable

    ISO 3166-1 alpha-2 country code, e.g. US.

    max 2 chars
  • devicestringnullable

    Device type, e.g. mobile, desktop, tablet.

    max 16 chars
  • filteredbooleannullable

    Only filtered (true) or only clean (false) clicks.

  • uniquebooleannullable

    Only unique (true) or only repeat (false) clicks.

  • sub1stringnullable

    Exact match on the sub1 tracking parameter.

    max 255 chars
  • limitinteger

    Page size.

    Default 501–100
  • offsetinteger

    Number of items to skip.

    Default 0min 0

Response · 2002

  • itemsarray of objectsrequired
    Show 32 child attributes
    • asnintegerrequired
      -9007199254740990–9007199254740990
    • browserstringrequired
      max 60 chars
    • citystringrequired
      max 80 chars
    • costnumberrequired

      Attributed cost for cpc / cpcRaw links

      min 0
    • countrystringrequired

      ISO 3166-1 alpha-2 country code, e.g. US.

    • createdAtstring · date-timerequired

      ISO-8601 timestamp with offset

    • destinationUrlstringrequired

      Where this visitor was actually sent

      max 2048 chars
    • deviceTypeenumrequired
      One ofdesktopmobiletabletbotunknown
    • filterReasonsarray of stringsrequired
      max 10 items
    • idstring · uuidrequired

      UUID primary key

    • ipHashstringrequired

      sha256(salt + ip) — raw IPs are never stored

      64–64 chars
    • isBlockedbooleanrequired

      Sent to the blocked URL (or 404) instead of the destination

    • isBotbooleanrequired
    • isFilteredbooleanrequired

      At least one filter flagged or blocked it

    • isUniquebooleanrequired

      First click from this visitor within the unique scope in 24h

    • ispstringrequired
      max 120 chars
    • languagestringrequired
      max 16 chars
    • linkIdstring · uuidrequired

      Only clicks on this link.

    • osstringrequired
      max 60 chars
    • qualityScoreintegerrequired

      100 = clean human traffic

      0–100
    • referrerstringrequired
      max 2048 chars
    • regionstringrequired
      max 80 chars
    • rotatorIdstring · uuidrequired

      Only clicks on this rotator.

    • rotatorUrlIdstring · uuidrequired
    • ruleIdstringrequired

      Rule that decided the destination, if any

      max 32 chars
    • sub1stringrequired

      ?sub1= (or ?sub=) pass-through from the traffic source

      max 255 chars
    • sub2stringrequired
      max 255 chars
    • sub3stringrequired
      max 255 chars
    • sub4stringrequired
      max 255 chars
    • sub5stringrequired
      max 255 chars
    • userAgentstringrequired
      max 512 chars
    • workspaceIdstring · uuidrequired

      UUID primary key

  • metaobjectrequired
    Show 3 child attributes
    • limitintegerrequired

      Page size.

      1–9007199254740990
    • offsetintegerrequired

      Number of items to skip.

      0–9007199254740990
    • totalintegerrequired
      0–9007199254740990