Bulk API

Files list

Get a list of files according to the given filters

get/bulkapi/v2/filelist

Request

  • Base URL: //bulkapi.millionverifier.com (relative, and the document’s source URL is not known)
  • URL: //bulkapi.millionverifier.com/bulkapi/v2/filelist
  • Auth: none declared

Query parameters

keystring required
Example:your-api-key

Your API key

offsetinteger

Offset for pagination

limitinteger
Example:25

The amount of files to show on one page. Defaults to 50, which is also the maximum amount that can be used for limit

idinteger
Example:1

Filter for file IDs. To filter for multiple file IDs, use comma separated values e.g.: id=1,2,3

namestring
Example:myfile.txt

Filter for file name. It checks if any of the file names contain the given filter

status'in_progress' | 'error' | 'finished' | 'canceled' | 'paused' | 'in_queue_to_start'
Example:in_progress,error

Filter for file state. To filter for multiple file states, use comma separatedvalues e.g.: status=in_progress,finished. Any state type that does not match the possible values will be ignored

updated_at_fromstring yyyy-MM-dd HH:mm:ss
Example:2023-01-01 15:00:05

Filter for files that were updated after the given date time. If the given value does not match the format, the filter will be ignored

updated_at_tostring yyyy-MM-dd HH:mm:ss
Example:2023-01-01 15:00:05

Filter for files that were updated before the given date time. If the given value does not match the format, the filter will be ignored

createdate_fromstring yyyy-MM-dd HH:mm:ss
Example:2023-01-01 15:00:05

Filter for files that were created after the given date time. If the given value does not match the format, the filter will be ignored

createdate_tostring yyyy-MM-dd HH:mm:ss
Example:2023-01-01 15:00:05

Filter for files that were created before the given date time. If the given value does not match the format, the filter will be ignored

percent_frominteger
Example:50

Filter for files that has a progress over the given percentage

percent_tointeger
Example:75

Filter for files that has a progress below the given percentage

has_error'1' | 't' | 'T' | 'TRUE' | 'True' | 'true' | '0' | 'f' | 'F' | 'FALSE' | 'False' | 'false'

Filter for files that either had or didn't have any errors. It accepts the listed boolean values. Any other values will be ignored

Response

Succesful request

totalinteger

The amount of total files matching the given filters

Example response

{
  "files": [
    {
      "file_id": "940",
      "file_name": "mails500.txt",
      "status": "in_progress",
      "unique_emails": 257,
      "updated_at": "2021-05-16 12:25:42",
      "createdate": "2021-05-16 12:25:42",
      "percent": 60,
      "total_rows": 500,
      "estimated_time_sec": 120
    }
  ],
  "total": 1
}

Changes

No recorded changes to this operation across all 1 revision of this API.