Skip to main content
POST
/
organizations
/
{orgId}
/
dataexplorer
/
commitments
/
obligations
Query and filter for obligations.
curl --request POST \
  --url https://api.m3ter.com/organizations/{orgId}/dataexplorer/commitments/obligations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "dimensions": [
    {
      "name": "<string>",
      "filter": [
        "<string>"
      ],
      "attributes": [
        "<string>"
      ]
    }
  ],
  "limit": 1000
}
'
[
  {
    "dateMonth": "<string>",
    "obligations": {}
  }
]

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.

Body

application/json

Data Explorer Obligations query.

​
startDate
string<date-time>
required

ISO 8601 formatted start date for the obligations.

​
endDate
string<date-time>
required

ISO 8601 formatted end date for the obligations.

​
dimensions
object[]

Dimensions to filter by

Maximum array length: 100
​
limit
integer<int32>

Limit the number of data points returned

Required range: 1 <= x <= 2000

Response

Returns a list of obligations.

​
dateMonth
string
​
obligations
object