Clickstream S3 setup

Clickstream S3 integration delivers real-time click events to a bucket in your AWS account. This makes click data available to other AWS services for analysis and management.

Setup requires granting Rebrandly read and write access to your S3 bucket via a bucket policy.

Prerequisites

Clickstream must be enabled on your account.
You need an AWS account with permission to create S3 buckets and configure bucket policies.

Setup process

Create an S3 bucket in your AWS account.
Request activation — contact Rebrandly to enable the S3 integration on your account.
Configure the bucket policy — add the following policy to your bucket, replacing your-bucket-name-here with your bucket name:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Sid": "RebrandlyWorkersIntegration",
      "Effect": "Allow",
      "Principal": {
        "AWS": "arn:aws:iam::617090640476:root"
      },
      "Action": [
        "s3:PutObject",
        "s3:GetObject"
      ],
      "Resource": "arn:aws:s3:::your-bucket-name-here/*"
    }
  ]
}

Share your bucket name with the Rebrandly support team (include it in the same ticket used to request activation).
Rebrandly will confirm when the integration is live. Permission can be revoked at any time by removing the bucket policy.

Storage class

We recommend the Standard storage class. Files delivered by the stream are typically smaller than 128 KB.

Click event example

{
  "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"]
        }
      }
    }
  }
}