API Reference

Create report

post
https://api.apply.akahu.nz/v1/applications//reports

An Akahu Apply report provides an aggregate, enriched view of the data from the application's resources.

The output of a report can be downloaded as an HTML document for human consumption, or as JSON data for further processing.

Report processing is asynchronous, so you must poll the GET /v1/applications/{applicationId}/report/{reportId} endpoint until it reaches a final status. The output of a report can only by accessed once it has been assigned a status of completed.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
_documents
array of objects
length ≥ 1

Optionally specify which documents to include in the report. If omitted, all documents in the application will be included.

The provided value must reference a subset of the documents from this application. Documents from other applications cannot be included.

_documents
Responses

Updated 5 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago