Alpha APIActions

Export Report

View as Markdown

Export a whole dataset from this vault as a file: every finding, or every contradiction, as xlsx, csv or PDF. The only path that produces a PDF. For a table you assembled yourself, use export_workbook. Returns a url and an artifactId that send_email can attach. Requires a manager API key, since it stores a file.

Authentication

AuthorizationBearer
Create a personal key in Alpha settings, or use an access token issued to an approved OAuth client.

Request

This endpoint expects an object.
vaultstringOptional

Exact vault id or name from list_vaults. Required whenever the key can reach more than one vault; never guess or use one client’s vault for another.

datasetenumOptional
Default findings
Allowed values:
formatenumOptional
Default xlsx
Allowed values:

Response headers

X-Request-IdstringOptional
Stable identifier for tracing this request in Alpha logs.

Response

Export Report completed.
datamap from strings to any or list of maps from strings to any
The result returned by the selected Alpha tool.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error