Skip to main content
GET
Get a report
Once a report request has been accepted for processing, you can poll the report resource endpoint at /reports/{report_id} for its status. When status is ready, the final report is uploaded and available at {file_url}.

API Key Permissions

This endpoint requires either the “view” or “trade” permission.

Authorizations

cb-access-key
string
header
required
cb-access-passphrase
string
header
required
cb-access-sign
string
header
required
cb-access-timestamp
string
header
required

Path Parameters

report_id
string
required

Response

id
string
required
type
string
required
created_at
string<date-time>
required
completed_at
string<date-time>
required
expires_at
string<date-time>
required
status
enum<string>
default:pending
required
Available options:
pending,
creating,
ready,
failed
user_id
string
required
file_url
string
required
params
object
required
Example:
file_count
string<uint64>