Sign in
Aggregation

List Aggregations

Retrieve a list of Aggregations that can be filtered by Product, Aggregation ID, or Code.

get/organizations/{orgId}/aggregations

Path parameters

orgIdstring required

UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service.

Query parameters

pageSizeinteger

Number of Aggregations to retrieve per page.

nextTokenstring

nextToken for multi-page retrievals.

productIdstring[]

The UUIDs of the Products to retrieve Aggregations for.

idsstring[]

List of Aggregation IDs to retrieve.

codesstring[]

List of Aggregation codes to retrieve. These are unique short codes to identify each Aggregation.

Response

Returns the list of Aggregations

nextTokenstring

Changes

Changed in 3 of the 10 revisions of this API.242

  • 0f92c877619f1See the full diff
    • ●

      added the new CUSTOM_SQL enum value to the data/items/allOf[subschema #4]/aggregation response property for the response status 200

      response-property-enum-value-added

  • 9f9e5f3dbde712See the full diff
    • ▲

      the response's body type/format changed from / to object/ for status 200

      response-body-type-changed

    • ○

      added the optional property data to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property nextToken to the response with the 200 status

      response-optional-property-added

    This revision also has 53 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 9433593378b513See the full diff
    • ▲

      the response's body type/format changed from object/ to / for status 200

      response-body-type-changed

    • ●

      for the query request parameter productId, the type/format of property items/ was changed from object/ to string/

      request-parameter-property-type-changed

    • ●

      removed the optional property data from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property nextToken from the response with the 200 status

      response-optional-property-removed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog