其結構
限管理員
匯出端點需要工作區管理員權限。它們覆蓋整個工作區，因此只有擁有完整存取權限的角色才能存取。
非同步設計
請求會將一個背景任務加入佇列，該任務負責組裝歸檔文件，因此大型工作區不會因單一 HTTP 請求而阻塞。您只需輪詢狀態，然後下載即可。
簽名式、短時下載
最終存檔透過簽名連結獲取，該連結在發出後不久即失效——而非公開或永久URL。
端對端審計
每次匯出請求和每次下載都會寫入審計跟踪，因此誰在何時導出了什麼內容始終有記錄。
請求匯出
一個僅限管理員使用的端點啟動後台作業。它會立即返回作業 ID；歸檔資料在背景產生。
// Kick off a full-workspace export. Requires a workspace ADMIN session (org owner/admin).
// The whole export is scoped to the caller's own workspace (tenant-isolated).
POST https://flash.socialhub.ai/api/flash/account/data-export
// → { data: { id: "<jobId>", status: "pending", deduped: false } }
// The archive is assembled in the background — this returns immediately. If an
// export is already pending/running, the same job is returned (deduped: true).投票，然後下載
// Poll for status, then download when it's ready.
GET https://flash.socialhub.ai/api/flash/account/data-export
// → { data: {
// jobs: [ { id, status, rowCount, createdAt, completedAt, error } ],
// dataHandling: { summary, facts: [ ... ] } // the honest data-handling notes
// } }
// status is one of: "pending" | "running" | "completed" | "failed"
//
// When a job is "completed", fetch a short-lived signed download link:
GET https://flash.socialhub.ai/api/flash/exports/{id}/download
// → { data: { url: "<short-lived signed link>" } }
// Download the archive before the link expires; re-request to get a fresh one.覆蓋範圍清單
存檔是一個 JSON 文檔，打開時會顯示每個包含的部分及其記錄計數的清單 - 因此完整性是可驗證的，而不是假設的。下面的欄位名稱說明了清單的形狀。
// The archive is a single JSON document that LEADS with a coverage manifest:
// exactly which sections are included and how many records are in each. Large
// sections are capped for a manageable export — the manifest flags where a cap applied.
{
"manifest": {
"generatedAt": "<timestamp>",
"sections": [
{ "name": "members", "recordCount": <n>, "capped": <bool> },
{ "name": "orders", "recordCount": <n>, "capped": <bool> },
{ "name": "campaigns", "recordCount": <n>, "capped": <bool> }
// …one entry per included section
]
},
// …the section payloads follow.
}營運和計劃出口
除了完整的工作區存檔外，管理員還可以單獨匯出 members 或 orders 表——匯出格式為 CSV 或 JSONL，可一次匯出，也可按日/週定時匯出——並且可以選擇將每次匯出操作透過簽章 Webhook 推送到您的資料倉儲。相同的管理員權限控制、非同步作業、簽章下載和稽核追蹤；匯出量有限，便於管理。
// Operational export of a single entity — admin-only, async, same signed-link download.
// Choose CSV or JSONL, and optionally have Flash push the finished file to your warehouse.
POST https://flash.socialhub.ai/api/flash/exports
{
"entity": "members", // "members" | "orders"
"format": "csv", // "csv" | "jsonl"
"webhookUrl": "https://..." // optional reverse-ETL: your loader is notified with a
// short-lived signed link when the run completes (HTTPS only)
}
// → { data: { id: "<jobId>", status: "pending" } } // poll + download like the workspace export
// Capped at ~200k rows per run. Configure daily/weekly schedules from Account → Data & Export.檔案涵蓋的內容
導出範圍涵蓋整個工作區。為了方便下載，大型部分會被限制，清單中會註明所有限制情況。
成員訂單團隊段標籤區域行銷活動 + 效果推播模板策略舉措廣告連結忠誠度計劃優惠券池會員入口網頁NPS目錄品牌和類別自訂對象自訂指標嵌入式應用程式隱私權政策資料主體存取請求 (DSAR) 歷史記錄
秘密被排除
API 金鑰、憑證和令牌被刻意排除在存檔之外。資料可攜性絕不意味著將密鑰匯出到您的整合。
每個成員的個人資料都有其獨立的匯出功能
此工作區存檔包含營運資料。關於單一成員的詳細個人資料透過每個成員的 資料主體匯出 提供。