Retrieves a list of uploaded validation files.
Try it now
Test
RAM authorization
Request syntax
GET HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| StartTime |
string |
Yes |
The start time. The time is in UTC and follows the RFC 3339 format. |
2025-12-19T08:30:00Z |
| EndTime |
string |
Yes |
The end time. The time is in UTC and follows the RFC 3339 format. |
2025-12-19T20:30:00Z |
| FileKeyword |
string |
No |
A keyword in the file name. |
keyword |
| Page |
integer |
No |
The page number. |
1 |
| PageSize |
integer |
No |
The number of entries per page. |
10 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response object. |
||
| RequestId |
string |
The request ID. |
xxx |
| HasNext |
boolean |
Indicates whether a next page of data exists. |
true |
| Page |
integer |
The page number. |
1 |
| PageSize |
integer |
The number of entries per page. |
10 |
| TotalSize |
integer |
The total number of entries. |
100 |
| TotalPages |
integer |
The total number of pages. |
10 |
| Files |
array<object> |
The list of files. |
|
|
object |
|||
| FileName |
string |
The file name. |
test.csv |
| UploadTime |
string |
The time when the file was submitted. |
2000-01-01T00:00:00Z |
| Status |
string |
The status of the task. |
completed |
| Percentage |
string |
The task execution progress. |
100% |
| CompleteTime |
string |
The time when the task was completed. |
2000-01-01T00:00:00Z |
| TotalNum |
string |
The number of addresses to validate in the task. |
10 |
| ProcessedNum |
string |
The number of addresses that have been validated. |
10 |
| ValidNum |
string |
The number of addresses with the validation result 'Valid'. |
5 |
| InvalidNum |
string |
The number of addresses with the validation result 'Invalid'. |
4 |
| CatchAllNum |
string |
The number of addresses with the validation result 'CatchAll'. |
1 |
| DoNotMailNum |
string |
The number of addresses with the validation result 'DoNotMail'. |
0 |
| UnknownNum |
string |
The number of addresses with the validation result 'Unknown'. |
0 |
| IsDownloadable |
boolean |
Indicates whether the result can be downloaded. |
true |
| FileId |
string |
The file ID. |
xxx |
Examples
Success response
JSON format
{
"RequestId": "xxx",
"HasNext": true,
"Page": 1,
"PageSize": 10,
"TotalSize": 100,
"TotalPages": 10,
"Files": [
{
"FileName": "test.csv",
"UploadTime": "2000-01-01T00:00:00Z",
"Status": "completed",
"Percentage": "100%",
"CompleteTime": "2000-01-01T00:00:00Z",
"TotalNum": "10",
"ProcessedNum": "10",
"ValidNum": "5",
"InvalidNum": "4",
"CatchAllNum": "1",
"DoNotMailNum": "0",
"UnknownNum": "0",
"IsDownloadable": true,
"FileId": "xxx"
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.