Queue one bounded export as a recently step-up-authenticated external-tenant member.

Artifact delivery is deliberately outside this operation and contract.

Authorization

platformSession

laravel_session<token>

In: cookie

Header Parameters

X-XSRF-TOKEN*string

CSRF token paired with the current web session.

Length1 <= length <= 2048

Idempotency-Key*string

Match^[A-Za-z0-9][A-Za-z0-9._:-]*$

Length16 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

export_class*ExportClass

Value in

"dashboard_extract"
"canonical_detail"
"rejected_rows"
"allocation_detail"
"statement"
"ledger_reconciliation"
"audit_evidence"

format*ExportFormat

Value in

"csv"
"json"
"parquet"
"pdf"
"zip"

specification*

max_attempts?integer

Range1 <= value <= 20

Default5

retention_days?integer

Range1 <= value <= 30

Default7

Response Body

`application/json`

curl -X POST "https://example.com/platform/v1/exports" \  -H "X-XSRF-TOKEN: string" \  -H "Idempotency-Key: stringstringstri" \  -H "Content-Type: application/json" \  -d '{    "specification": {      "currency_basis": "reported",      "filters": {        "property1": "string",        "property2": "string"      },      "locale": "string",      "max_bytes": 1,      "payee_ref": "89c1dfe1-70b4-4a1f-81bf-5e370fdeac3c",      "reporting_period": {        "from": "2019-08-24",        "to": "2019-08-24"      },      "schema_version": "string",      "source_ref": "6e70152b-5bde-43b8-b74c-6ec074ae590c",      "source_type": "analytics_generation",      "timezone": "string"    },    "export_class": "ledger_reconciliation",    "format": "json"  }'

{  "data": {    "request": "60448f3a-8291-43df-9526-c3d4a574e4d2",    "export_class": "dashboard_extract",    "format": "csv",    "status": "queued",    "requested_at": "2019-08-24T14:15:22Z",    "ready_at": "2019-08-24T14:15:22Z",    "failed_at": "2019-08-24T14:15:22Z",    "cancelled_at": "2019-08-24T14:15:22Z",    "expired_at": "2019-08-24T14:15:22Z",    "revoked_at": "2019-08-24T14:15:22Z",    "expires_at": "2019-08-24T14:15:22Z",    "artifact": {      "artifact": "d314337b-6c0d-4d0e-a3b2-d6fc0160357d",      "format": "csv",      "media_type": "string",      "bytes": 1,      "row_count": 0,      "expires_at": "2019-08-24T14:15:22Z"    }  },  "meta": {    "idempotent_replay": true  }}

Authorization

Header Parameters

Request Body

Response Body

200application/json

201application/json

401application/json

403application/json

409application/json

422application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`