Get Failed Ingest File Download URL

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/measurements/failedIngest/getDownloadUrl \
  --header 'Authorization: Bearer <token>'

{
  "url": "<string>"
}

Get Failed Ingest File Download URL

Returns a presigned download URL for failed ingest file download based on the file path provided.

If a usage data ingest measurement you submit to the m3ter platform fails, an ingest.validation.failure Event is generated. Use this call to obtain a download URL which you can then use to download a file containing details of what went wrong with the attempted usage data measurement ingest, and allowing you to follow-up and resolve the issue.

To obtain the file query parameter:

Use the List Events call with the ingest.validation.failure for the eventName query parameter.
The response contains a getDownloadUrl response parameter and this contains the file path you can use to obtain the failed ingest file download URL.

Notes:

The presigned Url returned to use for failed ingest file download is time-bound and expires after 5 minutes.
If you make a List Events call for ingest.validation.failure Events in your Organization, then you can perform this GET call using the full URL returned for any ingest failure Event to obtain a failed ingest file download URL for the Event.

GET

organizations

{orgId}

measurements

failedIngest

getDownloadUrl

Get Failed Ingest File Download URL

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/measurements/failedIngest/getDownloadUrl \
  --header 'Authorization: Bearer <token>'

{
  "url": "<string>"
}

Authorizations

Authorization

string

header

required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

Path Parameters

orgId

string

required

UUID of the Organization

Query Parameters

file

string

The file path

Response

Returns a presigned URL for failed ingest file download

It contains details for downloading a file

url

string

The presigned download URL

Get Original File Download URL

⌘I

Getting Started

Endpoints

Get Failed Ingest File Download URL

Authorizations

Path Parameters

Query Parameters

Response