Changelog

New Feature

Async Dataset Export with Webhook Notifications

• Introduced /dataset/export endpoint for asynchronous dataset exports with webhook delivery
• Perfect for large datasets that would timeout with synchronous requests
• Supports both CSV and JSONL output formats with gzip compression
• HMAC signature verification ensures webhook authenticity using your API key
• Download URLs are valid for 30 days from export completion
• Requires Query Builder subscription for full access

Key Benefits:

• Process large datasets without timeout constraints
• Integrate with automated data pipelines and workflows
• Receive results asynchronously via secure webhook notifications
• Track exports using unique query UUIDs for request/response matching

Example Request:

{
  "dataset": {
    "scopes": [
      {"column": "street_address"},
      {"column": "asking_rent", "aggregate": "Avg"}
    ],
    "filters": [
      {"column": "msa", "filter": {"equals": "Seattle, WA"}},
      {"column": "bed", "filter": {"in": [1, 2, 3]}}
    ],
    "limit": 10000
  },
  "webhookURL": "https://yourapp.com/webhook/dataset-export",
  "name": "Seattle Rental Data Export",
  "format": "csv"
}

Webhook Response:

{
  "queryUUID": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Seattle Rental Data Export",
  "format": "csv",
  "gcsBlob": {
    "url": "https://storage.googleapis.com/...",
    "expires": "2024-07-26T10:30:00Z",
    "timeTakenMs": 45000,
    "numberRows": 12847
  },
  "hmacSignature": "a1b2c3d4...",
  "requestedOn": "2024-06-26T10:00:00Z",
  "completedOn": "2024-06-26T10:00:45Z"
}

See our Dataset Webhook Export Guide for complete implementation details and webhook handler examples.