ドキュメント本文へスキップ
API

エクスポートに何が含まれるかを見る

エクスポートを今すぐ始められるか、どれだけ含まれるか。

GET/exports/preview

実際の呼び出しをワークスペースに対して実行します。

GET /exports/preview

エクスポートを今すぐ始められるか、どれだけ含まれるか。

例

threads:read が必要。allowed が false のとき、reason は not-permitted、mailbox-login、two-factor-required のいずれかで、counts は null。nextAvailableAt は 1 日の上限が続く間設定され、activeExportId はまだ作成中のエクスポートを示す。

curl
curl "$OE/exports/preview" -H "$AUTH"
レスポンス
{  "object": "export_preview",  "allowed": true,  "reason": null,  "nextAvailableAt": null,  "activeExportId": null,  "counts": {    "threads": 18420,    "attachments": 6211,    "attachmentBytes": 1532871224,    "deletedFiles": 14,    "contacts": 912,    "audiences": 6,    "calendarEvents": 233,    "templates": 18,    "rules": 9,    "labels": 24,    "notes": 41,    "addresses": 7  }}

ワークスペースをエクスポートできるのは、そのオーナーか、すべての権限を持つロールのメンバーだけで、API キーか、すべてのアドレスで接続したアプリを使う。特定のアドレスやドメインに限定されたキーやアプリは 422 capability_unsupported になる。

リファレンス