Skip to main content
GET
/
organizations
/
{orgId}
/
dataexports
/
jobs
/
{id}
Retrieve Job
curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/dataexports/jobs/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "version": 123,
  "scheduleId": "<string>",
  "startedAt": "2023-11-07T05:31:56Z",
  "dateCreated": "2023-11-07T05:31:56Z",
  "sourceType": "USAGE",
  "status": "PENDING"
}

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

​
id
string
required

The UUID of the Job to retrieve.

Response

Returns the requested Export Job.

Base Response containing data export job

​
id
string
required

The id of the Export Job.

​
version
integer<int64>

The version number:

  • Create: On initial Create to insert a new entity, the version is set at 1 in the response.
  • Update: On successful Update, the version is incremented by 1 in the response.
​
scheduleId
string

The id of the data Export Schedule.

​
startedAt
string<date-time>

When the data Export Job started running

​
dateCreated
string<date-time>

When the data Export Job was created.

​
sourceType
enum<string>
Available options:
USAGE,
OPERATIONAL
​
status
enum<string>
Available options:
PENDING,
RUNNING,
SUCCEEDED,
FAILED