List FOCUS exports
Lists the FOCUS exports of the last 7 days, and whether export is on.
GET/v1/workspaces/{regionId}/focus-exports
Returns
200 OK with the object shown in the response.
More details
Returns whether FOCUS export is switched on for the workspace and its exports of the last 7 days, newest first, at most 20. The list has no download links; get them with GetFocusExport.
Needs 'view' access to invoices. An API key can call it.
Response fields
enabledbooleanWhether FOCUS export is switched on for the workspace.
from, tostringThe first and last billing period of the export, as YYYY-MM.
rowCount, documentCountnumberThe rows in the dataset and the invoices, debit notes and credit notes they come from.
expiresAtstringWhen Pleaxy deletes the export's files, 7 days after it was created.
Errors
- 401 Unauthorized - No credential was presented, or the Bearer token / X-Api-Key value is missing, invalid, expired, or revoked.
- 403 Forbidden - The caller's Bearer token or API key doesn't grant access to this workspace (regionId), or lacks the required role.
curl "$PLEAXY_API_BASE_URL/v1/workspaces/{regionId}/focus-exports" \
-H "X-Api-Key: $PLEAXY_API_KEY"{
"enabled": boolean,
"exports": [
{
"id": "string",
"status": "ready",
"createdAt": "string",
"version": "1.2" | "1.4",
"include": "all" | "non_cloud",
"from": "string",
"to": "string",
"format": "csv" | "parquet",
"rowCount": number,
"documentCount": number,
"commitmentCount": number,
"expiresAt": "string"
}
]
}