Sign in
Reports

Returns real-time click events for a campaign.

Returns the most recent click events for the specified campaign in real time. Only applicable to campaigns with a lander — direct-linking campaigns never record clicks.

get/report/live/clicks/{campaignId}

Path parameters

campaignIdstring uuid required

Campaign ID

Query parameters

offsetinteger

Pagination offset (zero-based). Default: 0. The live feed moves between calls, so a row can shift across pages; for a stable snapshot fetch one page with a larger limit instead.

tzstring

Time zone for date aggregation, e.g. 'America/New_York', 'Europe/Warsaw', or 'Etc/GMT'. Default: Etc/GMT. Affects how day, dayOfWeek, and hourOfDay boundaries are calculated.

limitinteger

Maximum rows to return per request. Omit to return every row, which for a busy campaign is a large response. totalRows always reflects the true count, so compare it with the number of rows returned to tell whether more are available. Note this trims the response only — the server still reads and decodes the campaign's whole live buffer, so a small limit makes the payload smaller but not the call faster.

Response

Real-time event data for a specific campaign. Contains the most recent visit or click events as they occur.

Changes

Changed in 1 of the 6 revisions of this API.4

  • c1c1dd6b0c074See the full diff
    • ○

      added the new optional query request parameter limit

      new-optional-request-parameter

    • ○

      added the new optional query request parameter offset

      new-optional-request-parameter

    • ○

      added the optional property limit to the response with the 200 status

      response-optional-property-added

    • ○

      added the required property offset to the response with the 200 status

      response-required-property-added

Of the 6 revisions, 1 has no diff computed.