ワークスペースデータのエクスポート

エクスポートをリクエストする

1 つの管理者専用エンドポイントがバックグラウンド ジョブを開始します。すぐにジョブ 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.

カバレッジマニフェスト

アーカイブは 1 つの 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 として 1 回または日次/週次スケジュールで独自にエクスポートし、オプションで署名付き 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.

データの取り扱い方法

当社が遵守する基準とお客様のコンプライアンス義務のサポート方法については、「データ コンプライアンス」の概要と「データ セキュリティ」開発者ガイドをご覧ください。