URL Expired

The URL for this request expired after 30 days.

filter

array of strings

One or more filters to apply. Uses the AND approach, so all filters should match for meter jobs to show up. Use the /v1.1/jobs/meter-job-filters endpoint to retrieve all available filters that can be applied when querying meter jobs. When you provide multiple values for a key (e.g. transmission_region), the IN operator is used. Combine multiple filters like this: ?filter=file_name:Test&filter=status:FAILED

filter

ADD string

page_token

string

If there are more meter jobs to fetch, this token will be populated as next_page_token in the response. Use it to fetch the next page of meter jobs.

page_size

integer

Defaults to 100

Amount of results to return. Defaults to 100.

search_query

string

Search query to apply. Comma-separate multiple values. This is a free-text search that will be applied when searching through the meter jobs. Define the fields to search through in the search_fields parameter.

search_fields

array of strings

length ≥ 0

Fields to search through. Required if search_query is provided. If the string from search_query is found in any of these fields, the meter jobs will be included in the results.

search_fields

ADD string

``200 List of jobs

object

jobs

array of objects

required

jobs*

object

job_id

uuid

required

The id of the create meters job

status

string

enum

required

PROCESSING``FAILED``COMPLETED``COMPLETED_WITH_ERRORS

file_name

string

The original name of the file uploaded to the Job. If the file was uploaded before this field was introduced, this value will be null as the original file name was not available at that time.

assets_count

integer

The number of assets that were created, updated, or failed as a result of the API call.

assets_created_count

integer

The number of assets that were created as a result of the API call.

assets_updated_count

integer

The number of assets that were updated as a result of the API call.

assets_failed_count

integer

The number of assets that failed as a result of the API call.

transmission_regions

array of objects

Defines the transmission region of the meter

CAISO``ERCOT``NYISO``ISONE``PJM``SERC``WECC_SW``WECC_PC

created_at

date-time

required

updated_at

date-time

required

next_page_token

string

If there are more provisional assets to fetch, this token will be populated. Use it to fetch the next page of provisional assets.

Updated 10 days ago

Base URL

https://api.staging.leap.energy/v1.1/jobs/meters

Example CURL Command

curl --request GET \
     --url 'https://api.staging.leap.energy/v1.1/jobs/meters?page_size=100' \
     --header 'accept: application/json'

Response

{
  "jobs": [
    {
      "job_id": "5961a37f-6325-431c-97cb-82f35e3c09cf",
      "status": "COMPLETED",
      "file_name": "meters_upload.csv",
      "assets_count": 10,
      "assets_created_count": 8,
      "assets_updated_count": 2,
      "assets_failed_count": 0,
      "transmission_regions": [
        "CAISO"
      ],
      "created_at": "2024-03-21T09:43:51.186Z",
      "updated_at": "2024-03-21T09:50:51.186Z"
    }
  ],
  "next_page_token": "abc123"
}