HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Download Sites' Usage

Downloading a CSV file with high-level summary information for statements, sites, and associated metadata is a 2 step process. The first step (this one) prepares the download and provides a URL in the response body that can be used for downloading the CSV file. The next step is to download the file using a GET request with the response body URL. The maximum number of site IDs is 500. If you need to download more than 500 sites, you will need to make multiple requests. The format of the generated CSV is separate from and will not exactly match the JSON you receive from the API endpoint.

Body Params

requestResource

siteIds
array of strings
required

An array of site IDs

siteIds*
date
required

Start date for site usage statements (YYYY-MM-DD)

date
required

End date for site usage statements (YYYY-MM-DD)

string
enum

Used to determine wether a download is in JSON or CSV format. The default download is in CSV format

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Response

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