ipumspy.api.IpumsApiClient.extract_status#
- IpumsApiClient.extract_status(extract, collection=None)[source]#
Check on the status of an extract request. If no such extract exists, return ‘not found’.
- Parameters:
extract (
Union
[BaseExtract
,int
]) – The extract to download. This extract must have been submitted. Alternatively, can be an extract id. If an extract id is provided, you must supply the collection namecollection (
Optional
[str
]) – The name of the collection to pull the extract from. If None, thenextract
must be aBaseExtract
- Returns:
- The status of the request. Valid statuses are:
’queued’, ‘started’, ‘completed’, ‘failed’, or ‘not found’
- Return type: