它的形状
仅限管理员
导出端点需要工作区管理员权限。它们覆盖整个工作区,因此只有拥有完整访问权限的角色才能访问。
异步设计
请求会将一个后台任务加入队列,该任务负责组装归档文件,因此大型工作区不会因单个 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 密钥、凭证和令牌被特意排除在存档之外。数据可移植性绝不意味着将密钥导出到您的集成。
每个成员的个人数据都有其独立的导出功能
此工作区存档包含运营数据。关于单个成员的详细个人数据通过每个成员的 数据主体导出 提供。