Whether the specific request has been completed

GET /requests/{requestId}/complete
O auth

This is a convenience endpoint to quickly check if a particular request has been completed or not. If you wish to check multiple requests at once, use the regular /reqeusts endpoint that will list all outstanding data requests.

Path parameters

  • requestId string Required

    A random identifier that uniquely identifies a request. A version 4 UUID is strongly recommended. Note: the generated identifier must be random. The identifier must not include any information that can be related to the requester. Additionally, requestIds must not be incremental.

Responses

  • 200

    OK

    Returns 0 if the request is still pending, returns 1 if the request is complete

    Values are 0 or 1.
  • 401

    Unauthorized

    Hide response attributes Show response attributes object
    • error string

      Value is Unauthorized.

    • message string

      Value is You are not authorized. Generate authentication tokens via OAuth to access this resource..
  • 404

    Not Found

    Hide response attributes Show response attributes object
    • error string

      Value is Not Found.

    • message string

      Value is Could not find a data request with this id..
GET /requests/{requestId}/complete 
curl \
 -X GET http://api.example.com/requests/{requestId}/complete \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
"0"
"1"
Response examples (200) 
0
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "You are not authorized. Generate authentication tokens via OAuth to access this resource."
}
Response examples (401) 
{
  "error": "Unauthorized",
  "message": "You are not authorized. Generate authentication tokens via OAuth to access this resource."
}
Response examples (404) 
{
  "error": "Not Found",
  "message": "Could not find a data request with this id."
}
Response examples (404) 
{
  "error": "Not Found",
  "message": "Could not find a data request with this id."
}