URL Expired

The URL for this request expired after 30 days.

📘

Interval Upload Automation Interval Upload Automation

For automating the upload of device-level interval data, check out the Interval Data Upload (SFTP) guide.

from

date-time

to

date-time

file_path

string

status

string

enum

The status of the ingestion.

PROCESSING - file ingestion in process
COMPLETED - all data ingested successfully
FAILED - one or more data validation errors were found, check 'List data validation errors' endpoint for details

PROCESSINGPROCESSINGCOMPLETEDFAILED

Allowed:

PROCESSING``COMPLETED``FAILED

page_size

integer

1 to 500

page_token

string

``200 Successfully queried the uploads.

object

uploads

array of objects

required

The list of found uploads.

uploads*

object

The list of found uploads.

last_job_id

uuid

required

The last ingestion attempt of this file. Usually Leap will just perform a single attempt to ingest the file. Leap can make an exception to correct for a known bug. This ID can be used to find the errors associated with the file ingestion.

uploaded_file_path

string

required

The file path as it has been uploaded to the Leap sftp server. This file will not be present after ingestion and will be moved to a folder based on the success of ingestion. On successful ingestion, this file will be moved to the interval-data/accepted/[filename] folder. On unsuccessful ingestion, the file will be moved to the interval-data/failed/[filename] folder.

current_file_path

string

required

The ingested file. This may not be the original location of the upload, as after ingestion this file will be moved to a folder according to the success of ingestion (see uploaded_file_path)

uploaded_at_date_time

date-time

required

The date the file was uploaded to the Leap SFTP server

status

string

enum

required

The status of the ingestion.

PROCESSING``COMPLETED``FAILED

feedback_csv_file_path

string

Path of the CSV on the Leap SFTP server that contains the summary of the ingestion of the file. Note that this field is only set when the file has been parsed.

error_csv_file_path

string

Path of the CSV on the Leap SFTP server that contains the errors that occurred trying to ingest the file. Note that this value is only set when the status field is equal to FAILED. You can also get the errors through the API by using the v1/jobs/interval-data-uploads/{job_id} endpoint.

next_page_token

string

Use this value to get the next page of content. Will only be provided if there might be more data available.

``400 Malformed or invalid query.

``401 You are not authorized to perform this operation.

``403 You do not have the necessary permissions for this operation.

``500 An internal server error occurred.

Base URL

https://api.staging.leap.energy/v1.1/jobs/interval-data-uploads

xxxxxxxxxx

curl --request GET \

--url https://api.staging.leap.energy/v1.1/jobs/interval-data-uploads \

--header 'accept: application/json'

xxxxxxxxxx

{

"uploads": [\
\
    {\
\
      "last_job_id": "34af68c0-5317-4844-b0c6-4ac4cd35b63f",\
\
      "uploaded_file_path": "/interval-data/devices-hvac-january-2024.72.csv",\
\
      "current_file_path": "/interval-data/accepted/devices-hvac-january-2024.72.csv/devices-hvac-january-2024.72.csv",\
\
      "uploaded_at_date_time": "2024-05-24T15:17:35Z",\
\
      "status": "COMPLETED"\
\
    }\
\
  ]

}