requests

The requests endpoint lets you monitor the status of a download you requested.

Returns

A requests object with the following fields:

Response FieldDescription
idA unique identifier for the request.
records
queryThe query you ran.
dataTypeThe data type you queried.
dataFormatThe data format you requested.
accountIDYour API token.
planIDThe Datafiniti plan level you're using.
viewThe view you chose. This determines which fields are shown in the data.
asyncShould always be set to 1. Indicates this is a download request.
statusThe current progress of the request. As the download request is running, this will be set to STARTED. When it's done, it will be set to COMPLETED.
errorAn error message in case anything went wrong with the download. Hopefully this is blank!
numDownloadedThe number of records that have been downloaded so far.
numFoundThe number of total records in Datafiniti that matched your query.
numRequestedThe number of records you requested to download.
date_startedThe date and time the download started.
date_completedThe date and time the download finished.

Response Codes and Messages

Response CodeError MessageWhat You Should Do
200N/AEverything worked! You should be looking at a download request object, which tells you the status of your download.
400N/AYou might be trying to look at an invalid request ID. Check to make sure you're using a relevant ID. You can see all of your requests by calling /requests/ without an ID.
401N/AYou're using an invalid API token. Check out your account page on the Datafiniti Portal to make sure you have the right token.
Language
Authorization
apiKey