Clickstream overview

Clickstream forwards raw click events from your branded links to your own systems or third-party platforms in real time. Each event includes metadata such as timestamp, referrer, device type, and location.

Clickstream is intended for teams with existing data pipelines or event-driven architectures that need direct access to link click data beyond what Rebrandly's built-in analytics provide.

Delivery options

Click data can be sent via two methods:

Webhook — stream events to any REST API endpoint. See Clickstream webhook setup.
AWS S3 — deliver events to an S3 bucket for downstream processing by other AWS services. See Clickstream S3 setup.

Supported destinations

Webhook delivery works with any system that accepts HTTP POST or PUT requests, including:

Data warehouses
Analytics platforms
Workflow automation platforms
Custom APIs

Event payload

Each click event contains the following fields:

Field	Description
`timestamp`	ISO 8601 timestamp of the click event
`client.language`	Browser or client language
`client.location.country`	Two-letter country code
`client.agent.browser.name`	Browser name
`client.agent.browser.version`	Browser version
`client.agent.os.name`	Operating system name
`client.agent.os.version`	Operating system version
`client.agent.device.name`	Device type
`client.agent.type`	`human` or bot classification
`client.session.started`	Session start timestamp
`client.session.first`	Whether this is the first click in the session
`referral.hostname`	Referring domain
`referral.protocol`	Referring protocol
`referral.origin.type`	Traffic source type (e.g., `social`)
`referral.origin.name`	Traffic source name (e.g., `facebook`)
`route.id`	Internal link ID
`route.slashtag`	Link slashtag
`route.creator.id`	Creator user ID
`route.creator.workspace.id`	Workspace ID
`route.domain.raw`	Custom domain
`route.destination.raw`	Full destination URL including query parameters

Event payload example

{
  "data": [
    {
      "timestamp": "2019-07-02T14:07:06.981094Z",
      "client": {
        "language": "pt",
        "location": {
          "country": "br"
        },
        "agent": {
          "browser": {
            "name": "facebook-app",
            "version": "227.0.0.43.158"
          },
          "os": {
            "name": "android",
            "version": "android-9.0-pie"
          },
          "device": {
            "name": "smartphone"
          },
          "type": "human"
        },
        "session": {
          "started": "2019-07-02T14:07:06.981094Z",
          "first": true
        }
      },
      "referral": {
        "hostname": "m.facebook.com",
        "protocol": "http",
        "path": "/",
        "origin": {
          "type": "social",
          "name": "facebook"
        }
      },
      "route": {
        "id": "a1ec86bf91bfe763ad02f602259ea0a9",
        "slashtag": "",
        "creator": {
          "id": "wf09bfww4eb9jkw2844555e1ce9af4f2",
          "workspace": {
            "id": "d88bfe5fgd14b2ghb44538b9aekpw89",
            "name": ""
          }
        },
        "domain": {
          "id": "9a5ae320f3e247ef8c9b6061131bb517",
          "raw": ""
        },
        "destination": {
          "raw": "https://www.yourdestination.com/?utm_source=cs_facebook_post&utm_medium=customersuccess",
          "protocol": "https",
          "hostname": "www.yourdestination.com",
          "path": "/",
          "params": {
            "query": {
              "utm_source": ["cs_facebook_post"],
              "utm_medium": ["customersuccess"]
            }
          }
        }
      }
    }
  ],
  "key": "abcxyz123"
}