---
title: "Create a CSV Download Request"
method: POST
path: "/plug/downloads/csv"
tags: ["Downloads"]
---

# Create a CSV Download Request

`POST /plug/downloads/csv`

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:
- [Account and Statement Gap](https://docs.arcadia.com/reference/list-accounts)
- [Credential](https://docs.arcadia.com/reference/list-credentials)
- [File](https://docs.arcadia.com/reference/list-files)
- [Meter](https://docs.arcadia.com/reference/list-meters)
- [Site](https://docs.arcadia.com/reference/list-sites)
- [Statement](https://docs.arcadia.com/reference/list-statements)

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](https://docs.arcadia.com/reference/get-the-downloadrequest) endpoint to retrieve the file.


This endpoint supports [Sandbox Mode](https://docs.arcadia.com/docs/sandbox-testing).

## Headers

- `Arcadia-Version` string, required

## Request body

- PublicDownloadCSVRequest
  - `columns` string[]
  - `downloadMethod` 'EMAIL' | 'IN_BROWSER'
  - `entityType` 'CREDENTIAL' | 'METER' | 'STATEMENT' | 'SITE' | 'ACCOUNT' | 'FILE' | 'STATEMENT_GAP' | 'DISCOVERED_STATEMENT', required
  - `globalSearch` string
  - `search` string

## Response `200`

OK

- PublicDownloadRequestResource
  - `createdAt` string, date-time, required — A timestamp indicating when the entity was created.
  - `downloadMethod` 'EMAIL' | 'IN_BROWSER', required — Method used for downloading data.
  - `id` string, required — A unique identifier for the entity.
  - `status` 'SUCCESS' | 'PREPARING' | 'FAILURE' | 'NO_CONTENT', required — Status of the resource.
  - `token` string, 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.

---

[API](https://skmtc.net/arcadia/apis/plug-api.md) · [All operations](https://skmtc.net/arcadia/apis/plug-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/arcadia/plug-api/revisions/d00587742116/schema)