Sign in

v1

latestOpenAPI 3.0.12026-07-248498266.5 KB
Downloads

Create a CSV Download Request

This endpoint will generate a CSV report based on the provided parameters.

The globalSearch and search parameters reuse the search functionality for the list endpoints of the entityType specified:

The columns in the report will vary based on entityType. By default (if the columns parameter is not provided), all available fields will be included. The names of these columns can then be passed in the columns parameter for future reports to only include those fields.

If downloadMethod is set to IN_BROWSER, use information in the response to make a request to the Get the DownloadRequest endpoint to retrieve the file.

This endpoint supports Sandbox Mode.

post/plug/downloads/csv

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Request body

columnsstring[]
downloadMethod'EMAIL' | 'IN_BROWSER'
entityType'CREDENTIAL' | 'METER' | 'STATEMENT' | 'SITE' | 'ACCOUNT' | 'FILE' | 'STATEMENT_GAP' | 'DISCOVERED_STATEMENT' required
globalSearchstring
searchstring

Response

OK

createdAtstring date-time required

A timestamp indicating when the entity was created.

downloadMethod'EMAIL' | 'IN_BROWSER' required

Method used for downloading data.

idstring required

A unique identifier for the entity.

status'SUCCESS' | 'PREPARING' | 'FAILURE' | 'NO_CONTENT' required

Status of the resource.

tokenstring required

We require this token to be provided when you want to access the requested download file. If you made the request via an API call, this token can be found in our response to you. If you made the request via the Dashboard, this token already be included in the email we would send you.