Query reports
GET /report returns the transfer records of the authenticated user.
Parameters
| Parameter | Required | Default | Description |
|---|---|---|---|
filterdirection | Yes | — | Transfer type: 5 = completed downloads (the user received the file; event STCPEVTENDSENDFILE) or 7 = completed uploads (the user sent the file; event STCPEVTENDRECEIVEFILE). Other values return 400. |
days | No | 1 | Period queried, in days, counted back from the time of the request. 0 or an invalid value uses 1. |
page | No | 0 | Results page, starting at 0. Each page has up to 100 records (limit configurable by the administrator, up to 1000). |
filterfile | No | — | Filter by part of the file name. |
The report returns only transfers completed successfully by the authenticated user.
Query
curl -s -G \
-H "Authorization: Bearer ${ACCESS_TOKEN}" \
--data-urlencode 'filterdirection=5' \
--data-urlencode 'days=7' \
--data-urlencode 'page=0' \
--data-urlencode 'filterfile=report' \
"$API_BASE/report"Remove filterfile when you do not need to filter by name.
Response
{
"status": 0,
"description": "<description returned by the API>",
"apiver": "v2 (9.0.1)",
"user": "USER",
"page": 0,
"logs": [],
"time": "<date and time>"
}Each element of logs is a transfer record returned for the query. The event identifiers that can appear in the records are listed in Session and transfer events.
Full contract in Reference: Reports.