Rotator URL report

Totals, a time series and breakdowns for one URL of a rotator.
GEThttps://api.clicklookup.com/v1/rotator-urls/{subject_id}/report

Requires an API key

Path parameters1

  • subject_idstring · uuidrequired

Query parameters6

  • 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
  • intervalenumnullable

    Bucket size of the time series. Picked from the period length when omitted.

    One ofhourday
  • compareboolean

    Also return totals for the same-length period before from.

    Default false
  • bystringnullable

    Comma-separated breakdown dimensions, e.g. country,device,sub1. Defaults to country, device, os, browser, referrerHost and sub1.

Response · 20012

  • breakdownsmaprequired
    Show 9 child attributes
    • actionsintegerrequired
      0–9007199254740990
    • clicksintegerrequired
      0–9007199254740990
    • conversionsintegerrequired
      0–9007199254740990
    • engagementsintegerrequired
      0–9007199254740990
    • keystringrequired
    • labelstringrequired

      Human name where the key is an id

    • revenuenumberrequired
    • salesintegerrequired
      0–9007199254740990
    • uniqueClicksintegerrequired
      0–9007199254740990
  • fromstring · date-timerequired

    ISO-8601 timestamp with offset

  • intervalenumrequired

    Bucket size of the time series. Picked from the period length when omitted.

    One ofhourday
  • previousTotalsobjectrequired

    Same-length period before from

    Show 26 child attributes
    • actionsintegerrequired

      Conversions of type action

      0–9007199254740990
    • backupRedirectsintegerrequired

      Clicks sent to the backup URL (BUR)

      0–9007199254740990
    • blockedClicksintegerrequired
      0–9007199254740990
    • botClicksintegerrequired
      0–9007199254740990
    • clicksintegerrequired
      0–9007199254740990
    • conversionRatenumberrequired

      conversions / uniqueClicks, 0..1

      min 0
    • conversionsintegerrequired
      0–9007199254740990
    • costnumberrequired
    • engagementsintegerrequired
      0–9007199254740990
    • epcnumberrequired

      Earnings per unique click

    • filteredClicksintegerrequired
      0–9007199254740990
    • goodQualityClicksintegerrequired

      Quality score ≥ 50

      0–9007199254740990
    • mobileClicksintegerrequired

      Mobile + tablet

      0–9007199254740990
    • mobileRedirectsintegerrequired

      Clicks sent to the mobile / iOS URL (MUR)

      0–9007199254740990
    • profitnumberrequired
    • proxyClicksintegerrequired

      Clicks the proxy filter matched

      0–9007199254740990
    • resalesintegerrequired
      0–9007199254740990
    • revenuenumberrequired
    • roinumberrequired

      (revenue - cost) / cost; null when cost is 0

    • salesintegerrequired
      0–9007199254740990
    • tier1Clicksintegerrequired

      US, GB, CA, AU, NZ

      0–9007199254740990
    • tier2Clicksintegerrequired

      EU + other high-income countries

      0–9007199254740990
    • tier3Clicksintegerrequired
      0–9007199254740990
    • uniqueClicksintegerrequired
      0–9007199254740990
    • uniqueRationumberrequired

      uniqueClicks / clicks, 0..1

      min 0
    • upsellsintegerrequired
      0–9007199254740990
  • publicMetricsarray of stringsrequired

    Public stats pages only: the metric keys the workspace chose to show

  • seriesarray of objectsrequired
    Show 12 child attributes
    • actionsintegerrequired
      0–9007199254740990
    • blockedClicksintegerrequired
      0–9007199254740990
    • botClicksintegerrequired
      0–9007199254740990
    • clicksintegerrequired
      0–9007199254740990
    • conversionsintegerrequired
      0–9007199254740990
    • costnumberrequired
    • engagementsintegerrequired
      0–9007199254740990
    • filteredClicksintegerrequired
      0–9007199254740990
    • revenuenumberrequired
    • salesintegerrequired
      0–9007199254740990
    • tsstring · date-timerequired

      ISO-8601 timestamp with offset

    • uniqueClicksintegerrequired
      0–9007199254740990
  • subjectIdstring · uuidrequired
  • subjectKindenumrequired
    One ofworkspacelinkrotatorrotatorUrl
  • subjectNamestringrequired

    Name of the link / rotator / URL, for public pages

  • subjectUrlstringrequired

    Where the subject sends visitors, for public pages: a link's primary URL, a rotator's first active URL

  • tostring · date-timerequired

    ISO-8601 timestamp with offset

  • totalsobjectrequired
    Show 26 child attributes
    • actionsintegerrequired

      Conversions of type action

      0–9007199254740990
    • backupRedirectsintegerrequired

      Clicks sent to the backup URL (BUR)

      0–9007199254740990
    • blockedClicksintegerrequired
      0–9007199254740990
    • botClicksintegerrequired
      0–9007199254740990
    • clicksintegerrequired
      0–9007199254740990
    • conversionRatenumberrequired

      conversions / uniqueClicks, 0..1

      min 0
    • conversionsintegerrequired
      0–9007199254740990
    • costnumberrequired
    • engagementsintegerrequired
      0–9007199254740990
    • epcnumberrequired

      Earnings per unique click

    • filteredClicksintegerrequired
      0–9007199254740990
    • goodQualityClicksintegerrequired

      Quality score ≥ 50

      0–9007199254740990
    • mobileClicksintegerrequired

      Mobile + tablet

      0–9007199254740990
    • mobileRedirectsintegerrequired

      Clicks sent to the mobile / iOS URL (MUR)

      0–9007199254740990
    • profitnumberrequired
    • proxyClicksintegerrequired

      Clicks the proxy filter matched

      0–9007199254740990
    • resalesintegerrequired
      0–9007199254740990
    • revenuenumberrequired
    • roinumberrequired

      (revenue - cost) / cost; null when cost is 0

    • salesintegerrequired
      0–9007199254740990
    • tier1Clicksintegerrequired

      US, GB, CA, AU, NZ

      0–9007199254740990
    • tier2Clicksintegerrequired

      EU + other high-income countries

      0–9007199254740990
    • tier3Clicksintegerrequired
      0–9007199254740990
    • uniqueClicksintegerrequired
      0–9007199254740990
    • uniqueRationumberrequired

      uniqueClicks / clicks, 0..1

      min 0
    • upsellsintegerrequired
      0–9007199254740990