List Uploads
List Uploads
GET
/api/portal/v1/charts/uploads
Description
List the chart uploads on the account, ordered most recent first. Each upload record includes its current processing status and aggregated logs from the ingestion job, which is suitable for polling progress after a call to Upload Chart.
Authentication
This endpoint requires a Bearer token in the Authorization header.
- Authorization:
Bearer <token>. A valid Portal API session token or API token.
Query Parameters
- limit (Optional): Maximum number of uploads to return. Defaults to
100. - offset (Optional): Number of uploads to skip from the start of the list. Defaults to
0. Combine withlimitto page through results.
Response Schema
The endpoint returns a paginated list of upload records.
uploads: An array of upload records.uploads[].id: The unique identifier for the upload.uploads[].filename: The sanitized original filename.uploads[].fileSize: The size of the uploaded file in bytes.uploads[].status: The processing status of the upload. See Charts for the full lifecycle.uploads[].createdAt: Timestamp when the upload was received, in milliseconds since unix epoch.uploads[].updatedAt: Timestamp when the upload record was last modified, in milliseconds since unix epoch.uploads[].uploaderEmail: The email of the user who uploaded the file.uploads[].totalCharts: The total number of chart cells contained in the upload.uploads[].expiredCharts: The number of chart cells in the upload that are past their expiry date.uploads[].logs: An array of log entries emitted by the ingestion job. Each entry hastimestamp(ISO 8601 UTC string),type(one ofinfo,warning,error), andmessage.pagination.limit: Thelimitvalue applied to the request.pagination.offset: Theoffsetvalue applied to the request.
Error Responses
- 401 Unauthorized: The
Authorizationheader is missing or the token is not valid.
Example Request
GET https://<your-host>:9909/api/portal/v1/charts/uploads?limit=10&offset=0
Authorization: Bearer <token>
Example Response
Status Code: 200 OK
Response Body:
{
"uploads": [
{
"id": 5,
"filename": "US5MA10M.000",
"fileSize": 104857600,
"status": "succeeded",
"createdAt": 1736942400000,
"updatedAt": 1736946000000,
"uploaderEmail": "example@zydromarine.com",
"totalCharts": 12,
"expiredCharts": 2,
"logs": [
{
"timestamp": "2026-01-15T08:00:10.000+00:00",
"type": "info",
"message": "Indexing 12 cells"
}
]
}
],
"pagination": {
"limit": 10,
"offset": 0
}
}