Status of a report order
GET
/reports/{order_no}
Returns the state of an order. While the file is being built the status is queued, running or processing; when it is ready the status becomes done and download_url appears. A failure gives error with a code and a message.
Orders are visible only to the account that created them.
Authorizations
ApiKeyAuth
API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.
Type
API Key (header: X-API-KEY)
Parameters
Header Parameters
X-Real-IP*
An IP address from the key's whitelist. A request from an address outside the whitelist is rejected with 401.
Type
Requiredstring
Example
"203.0.113.10"Format
"ipv4"Path Parameters
order_no*
Order number returned when the report was queued. Always starts with REP, which is what keeps this path apart from /reports/webhooks/....
Type
Requiredstring
Example
"REPxxxxxxxxxxxx"Pattern
"^REP[A-Za-z0-9._:-]+$"Responses
Order state.
application/json
JSON "status": "success", "code": 0, "msg": "", "data": { "order_no": "REPxxxxxxxxxxxx", "client_request_id": "string", "type": "string", "status": "string", "address": "string", "token_id": "string", "date_from": "string", "date_to": "string", "format": "string", "progress_pct": 100, "created_at": "string", "finished_at": "string", "expires_at": "string", "download_url": "string", "artifact_sha256": "string", "artifact_size": 0, "error_code": "string", "error_message": "string" }
{
}