exports

Export usage metering records

Changed on
post/exports/usage-metering

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/exports/usage-metering
  • Auth: one of:
    • API key in cookie session
    • HTTP bearer

Request body

format'csv' | 'json' | 'xlsx'
fromstring date-time
tostring date-time
filtersobject
columnsstring[]

Response

Export job queued

idinteger required
domainstring required
format'csv' | 'json' | 'xlsx' required
status'queued' | 'running' | 'completed' | 'failed' | 'expired' required
rowCountinteger nullable
fileSizeBytesinteger nullable
downloadTokenstring nullable
downloadUrlstring nullable
expiresAtstring date-time nullable
requestedByinteger required
createdAtstring date-time required
completedAtstring date-time nullable

Changes