How do Clarisights Widget Exports Work?
Widget Exports are deprecated. They are being replaced by Export Pipelines, a more flexible export system with custom metrics, dimensions, filters, flexible scheduling, and no row limit. Existing Widget Exports keep running for now, but don't set up new ones: use Export Pipelines for any new export and plan your move.
Get started with Export Pipelines →
Moving an existing export? Follow Migrating from Legacy Exports to Export Pipelines.
You may need to export data from Clarisights for reasons like top-management reporting, or cost reporting for finance teams. Clarisights has offered this through 2 legacy features: widget exports and data exports.
Widget exports deliver data from widgets to data warehouses maintained by customers. By default, these exports run once a day, at an hour you choose in your company's timezone. They can also run more often (every 1 to 24 hours). Files are delivered to the destination bucket specified by the customer.
Widget exports have these limitations:
Only up to 100k rows can be exported. Rows beyond 100,000 are left out of the file without any warning. If your widget returns more rows, narrow the date range, remove dimensions, or add filters, or use Export Pipelines, which have no row limit.
Data can only be delivered to an AWS S3 or Google Cloud Storage bucket.
Step 1: Set up your widget
Set up the widget whose data you want to export from Clarisights, then share the link to this widget with the Clarisights team.
Step 2: Grant permissions
Grant the Clarisights team the permissions needed to export data (data exporters need the same permissions).
Google Cloud Storage
Grant the following permissions to the service account "101712083634-compute@developer.gserviceaccount.com":
storage.objects.create
storage.objects.delete
storage.objects.get
storage.objects.list
AWS S3
Grant the following permissions to the role "arn:aws:iam::747179778889:role/ClarisightsExternalAccessRole":
GetObject
PutObject
PutObjectAcl
DeleteObject
ListBucket
Important: after granting these permissions, share the bucket name, the bucket region and the path with the Clarisights team.
Step 3: Receive the data
The Clarisights team sets up the exports, and you receive them in the specified bucket on the schedule you chose. Points to note:
You can receive the exports compressed (gzip) or as plain
.csvfiles. By default, exports are compressed.You can provide a filename for the export. The file with that exact name is overwritten on every run, with
.gzadded when compressed. By default, the filename is the date of export (in your company's timezone), for example2021-05-26.gzwhen compressed or2021-05-26.csvwhen not compressed.The export has the same structure as the widget being exported.
Your widget exports are now set up. If you have any issues, reach out to the Clarisights team.