openapi: 3.0.1 info: title: m3ter Account LookupTableRevision API description: "If you are using Postman, you can:\n- Use the **Download** button above to download the m3ter Open API spec JSON file and then import this file as the **m3ter API Collection** into your Workspace. See [Importing the m3ter Open API](https://www.m3ter.com/docs/guides/m3ter-apis/getting-started-with-api-calls#importing-the-m3ter-open-api) in our main user Documentation for details.\n- Copy this link: [m3ter-Template API Collection](https://www.datocms-assets.com/78893/1672846767-m3ter-template-api-collection-postman_collection.json) and use it to import the **m3ter-Template API Collection** into your Workspace. See [Importing the m3ter Template API Collection](https://www.m3ter.com/docs/guides/m3ter-apis/getting-started-with-api-calls#importing-the-m3ter-template-api-collection) in our main user Documentation for details.\n\n---\n\n# Introduction\nThe m3ter platform supports two HTTP-based REST APIs returning JSON encoded responses:\n- The **Ingest API**, which you can use for submitting raw data measurements. *(See the [Submit Measurements](https://www.m3ter.com/docs/api#tag/Measurements/operation/SubmitMeasurements) endpoint in this API Reference.)*\n- The **Config API**, which you can use for configuration and management. *(All other endpoints in this API Reference.)* \n\n## Authentication and Authorization\nOur APIs use an industry-standard authorization protocol known as the OAuth 2.0 specification.\n\nOAuth2 supports several grant types, each designed for a specific use case. m3ter uses the following two grant types:\n - **Authorization Code**: Used for human login access via the m3ter Console.\n - **Client Credentials**: Used for machine-to-machine communication and API access.\n\nComplete the following flow for API access:\n\n1. **Create a Service User and add Permissions**: Log in to the m3ter Console, go to **Settings**, **Access** then **Service Users** tab, and create a Service User. To enable API calls, grant the user **Administrator** permissions. \n \n2. **Generate Access Keys**: In the Console, open the *Overview* page for the Service User by clicking on the name. Generate an **Access Key id** and **Api Secret**. Make sure you copy the **Api Secret** because it is only visible at the time of creation. \n\nSee [Service Authentication](https://www.m3ter.com/docs/guides/authenticating-with-the-platform/service-authentication) for detailed instructions and an example.\n\n3. **Obtain a Bearer Token using Basic Auth**: We implement the OAuth 2.0 Client Credentials Grant authentication flow for Service User Authentication. Submit a request to the m3ter OAuth Client Credentials authentication flow, using your concatenated **Access Key id** and **Api Secret** to obtain a Bearer Token for your Service User. *See examples below.* \n \n4. **Bearer Token Usage**: Use the HTTP 'Authorization' header with the bearer token to authorise all subsequent API requests. \n\n> Warning: The Bearer Token is valid for 18,000 seconds or 5 hours. When the token has expired, you must obtain a new one.\n\nBelow are two examples for obtaining a Bearer Token using Basic Auth: the first in cURL and the second as a Python script. \n\n### cURL Example\n1. Open your terminal or command prompt. \n2. Use the following `cURL` command to obtain a Bearer Token:\n\n```bash\ncurl -X POST https://api.m3ter.com/oauth/token \\\n -H 'Content-Type: application/x-www-form-urlencoded' \\\n -u your_access_key_id:your_api_secret \\\n -d 'grant_type=client_credentials'\n```\n\nReplace `your_access_key_id` and `your_api_secret` with your actual **Access Key id** and **Api Secret**.\n\n3. Run the command, and if successful, it will return a JSON response containing the Bearer Token. The response will look like this:\n\n```json\n{\n \"access_token\": \"your_bearer_token\",\n \"token_type\": \"Bearer\",\n \"expires_in\": 18000\n}\n```\n\nYou can then use the Bearer Token *(the value of `\"access_token\"`)* for subsequent API calls to m3ter.\n\n### Python Example\n1. Install the `requests` library if you haven't already:\n\n```bash\npip install requests\n```\n\n2. Use the following Python script to obtain a Bearer Token:\n\n```python\nimport requests\nimport base64\n\n# Replace these with your Access Key id and Api Secret\naccess_key_id = 'your_access_key_id'\napi_secret = 'your_api_secret'\n\n# Encode the Access Key id and Api Secret in base64 format\ncredentials = base64.b64encode(f'{access_key_id}:{api_secret}'.encode('utf-8')).decode('utf-8')\n\n# Set the m3ter token endpoint URL\ntoken_url = 'https://api.m3ter.com/oauth/token'\n\n# Set the headers for the request\nheaders = {\n 'Authorization': f'Basic {credentials}',\n 'Content-Type': 'application/x-www-form-urlencoded'\n}\n\n# Set the payload for the request\npayload = {\n 'grant_type': 'client_credentials'\n}\n\n# Send the request to obtain the Bearer Token\nresponse = requests.post(token_url, headers=headers, data=payload)\n\n# Check if the request was successful\nif response.status_code == 200:\n # Extract the Bearer Token from the response\n bearer_token = response.json()['access_token']\n print(f'Bearer Token: {bearer_token}')\nelse:\n print(f'Error: {response.status_code} - {response.text}')\n```\n\nReplace `your_access_key_id` and `your_api_secret` with your actual **Access Key id** and **Api Secret**. \n\n3. Run the script, and if successful, it will print the Bearer Token. You can then use this Bearer Token for subsequent API calls to m3ter.\n\n## Submitting Personally Identifiable Information (PII)\n**IMPORTANT!** Under the [Data Processing Agreement](https://www.m3ter.com/docs/legal/dpa), the only fields permissible for use in submitting any of your end-customer PII data in m3ter are the ``name``, ``address``, and ``emailAddress`` fields on the **Account** entity - see the details for [Create Account](https://www.m3ter.com/docs/api#operation/PostAccount). See also section 4.2 of the [Terms of Service](https://www.m3ter.com/docs/legal/terms-of-service).\n\n## Rate and Payload Limits\n### Config API Request Rate Limits\nSee [Config API Limits](https://www.m3ter.com/docs/guides/m3ter-apis/config-api-limits).\n\n### Data Explorer API Request Rate Limits\nSee [Data Explorer Request Rate Limits](https://www.m3ter.com/docs/guides/m3ter-apis/config-api-limits#date-explorer-request-rate-limits).\n\n### Ingest API Request Rate and Payload Limits\nSee [Ingest API Limits](https://www.m3ter.com/docs/guides/m3ter-apis/ingest-api-limits) for more information.\n\n## Pagination\n**List Endpoints**\nAPI endpoints that have a List resources request support cursor-based pagination - for example, the `List Accounts` request. These List calls support pagination by taking the two parameters `pageSize` and `nextToken`. \n\nThe response of a List API call is a single page list. If the `nextToken` parameter is not supplied, the first page returned contains the newest objects chronologically. Specify a `nextToken` to retrieve the page of older objects that occur immediately after the last object on the previous page.\n\nUse `pageSize` to limit the list results per page, typically this allows up to a maximum of 100 or 200 per page.\n\n**Search Endpoints**\nAPI endpoints that have a Search resources request support cursor-based pagination - for example, the `Search Accounts` request. These Search calls support pagination by taking the two parameters `pageSize` and `fromDocument`.\n\nThe response of a Search API call is a single page list. If the `fromDocument` parameter is not supplied, the first page returned contains the newest objects chronologically. Specify a `fromDocument` to retrieve the page of older objects that occur immediately after the last object on the previous page.\n\nUse `pageSize` to limit the list results per page, typically this allows up to a maximum of 100 or 200 per page. Default is 10.\n\n## API Quick Start\nSee [Getting Started with API Calls](https://www.m3ter.com/docs/guides/m3ter-apis/getting-started-with-api-calls) for detailed guidance on how to use our API to:\n* Create a Service User and add permissions.\n* Generate access keys for the Service User.\n* Use basic authentication to obtain a Bearer Token.\n\nFor further guidance, also see [Creating and Configuring Service Users](https://www.m3ter.com/docs/guides/organization-and-access-management/managing-users/creating-and-configuring-service-users).\n\n## Other Languages\nIf you want to work with the m3ter REST APIs using other languages such as:\n* Python\n* JavaScript\n* C++\n\nPlease see the [Developer Tools](https://www.m3ter.com/docs/guides/developer-tools) topic in our main documentation for information about available SDKs.\n\n\n# Authentication\n" version: '1.0' x-logo: url: https://console.m3ter.com/m3ter-logo-black.svg servers: - url: https://api.m3ter.com security: - OAuth2: [] tags: - name: LookupTableRevision description: 'Endpoints for creating/updating/deleting Lookup Table Revisions. Lookup Tables utilize a "Table and Revision" model, which lets you update data cleanly, and extend the schema without modifying existing calculations: * Create Revisions for a Lookup Table, which you can use to define data schema and lookup keys. * Populate draft Revisions with data values. You can create and edit multiple draft Revisions, but only one can be published at any given time. * Publish a Revision to activate it. When you use Lookup functions in your calculations that reference the Lookup Table, the data values defined for the published Revision are used. * When you want different, updated data values to be used, publish the draft Revision containing the required new values. The currently published Revision is archived automatically. **Beta Version!** The Lookup Table feature is currently available in Beta release version. See [Feature Release Stages](https://www.m3ter.com/docs/guides/getting-started/feature-release-stages) for Beta release definition. Lookup Table Revision endpoints will only be available if Lookup Tables have been enabled for your Organization. For more details see [Lookup Tables (Beta)](https://www.m3ter.com/docs/guides/lookup-tables) in our main User documentation.' paths: /organizations/{orgId}/lookuptables/{lookupTableId}/revisions/{id}/status: put: tags: - LookupTableRevision summary: Update LookupTableRevision Status description: Update the status of a Lookup Table Revision for the given UUID. operationId: UpdateLookupTableRevisionStatus parameters: - name: orgId in: path description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service. required: true style: simple explode: false schema: type: string deprecated: true x-stainless-deprecation-message: the org id should be set at the client level instead - name: id in: path description: The UUID of the Lookup Table Revision to update the status for. required: true style: simple explode: false schema: type: string - name: lookupTableId in: path description: UUID of the Lookup Table the Revision belongs to. required: true style: simple explode: false schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/LookupTableRevisionStatusRequest' required: true responses: '200': description: Returns the updated LookupTableRevision content: application/json: schema: $ref: '#/components/schemas/LookupTableRevisionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' /organizations/{orgId}/lookuptables/{lookupTableId}/revisions/{id}: get: tags: - LookupTableRevision summary: Retrieve LookupTableRevision description: Retrieve a Lookup Table Revision for the given UUID. operationId: GetLookupTableRevision parameters: - name: orgId in: path description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service. required: true style: simple explode: false schema: type: string deprecated: true x-stainless-deprecation-message: the org id should be set at the client level instead - name: id in: path description: The UUID of the Lookup Table Revision to retrieve. required: true style: simple explode: false schema: type: string - name: lookupTableId in: path description: The UUID of the Lookup Table the Revision belongs to. required: true style: simple explode: false schema: type: string responses: '200': description: Returns the LookupTableRevision content: application/json: schema: $ref: '#/components/schemas/LookupTableRevisionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' put: tags: - LookupTableRevision summary: Update LookupTableRevision description: 'Update a Lookup Table Revision for the given UUID. **NOTE:** If you''ve already added data to a Lookup Table Revision - see the following [Lookup Table Revision Data](https://www.m3ter.com/docs/api#tag/LookupTableRevisionData) section - then you won''t be able to change the Revision''s field schema and you''ll receive an error if you try do this. Create a new Revision instead, or delete the data items first.' operationId: UpdateLookupTableRevision parameters: - name: orgId in: path description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service. required: true style: simple explode: false schema: type: string deprecated: true x-stainless-deprecation-message: the org id should be set at the client level instead - name: id in: path description: The UUID of the Lookup Table Revision to update. required: true style: simple explode: false schema: type: string - name: lookupTableId in: path description: The UUID of the Lookup Table the Revision belongs to. required: true style: simple explode: false schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/LookupTableRevisionRequest' required: true responses: '200': description: Returns the updated LookupTableRevision content: application/json: schema: $ref: '#/components/schemas/LookupTableRevisionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' delete: tags: - LookupTableRevision summary: Delete LookupTableRevision description: Delete the Lookup Table Revision for the given UUID. operationId: DeleteLookupTableRevision parameters: - name: orgId in: path description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service. required: true style: simple explode: false schema: type: string deprecated: true x-stainless-deprecation-message: the org id should be set at the client level instead - name: id in: path description: The UUID of the Lookup Table Revision to update. required: true style: simple explode: false schema: type: string - name: lookupTableId in: path description: The UUID of the Lookup Table the Revision belongs to. required: true style: simple explode: false schema: type: string responses: '200': description: Returns the deleted LookupTableRevision content: application/json: schema: $ref: '#/components/schemas/LookupTableRevisionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' /organizations/{orgId}/lookuptables/{lookupTableId}/revisions: get: tags: - LookupTableRevision summary: List LookupTableRevision description: List LookupTableRevision entities operationId: ListLookupTableRevision parameters: - name: orgId in: path description: UUID of the Organization required: true style: simple explode: false schema: type: string deprecated: true x-stainless-deprecation-message: the org id should be set at the client level instead - name: lookupTableId in: path description: The lookup table Id required: true style: simple explode: false schema: type: string - name: pageSize in: query description: Number of LookupTable to retrieve per page required: false allowEmptyValue: true style: form explode: true schema: maximum: 200 minimum: 1 type: integer format: int32 - name: nextToken in: query description: Token to supply for multi page retrievals required: false allowEmptyValue: true style: form explode: true schema: type: string - name: ids in: query description: List of Lookup Table Revision IDs to retrieve required: false allowEmptyValue: true style: form explode: true schema: type: array items: type: string responses: '200': description: List of LookupTableRevision entities content: application/json: schema: $ref: '#/components/schemas/PaginatedLookupTableRevisionResponseData' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' post: tags: - LookupTableRevision summary: Create LookupTableRevision description: 'Create a new Revision for a Lookup Table. Fields and Keys for Revision schema: Use the `fields` parameter to define a Revision schema containing up to 10 number or string fields. Use the `keys` parameter to specify which are the key fields: * At least one field must be a non-key field and at least one a key field. * Up to 5 key fields can be defined. * Using multiple key fields: ensure that the order in which they are defined matches the order in which you want to use them in any Lookup functions that reference the Revision''s Lookup Table, because this is the order in which they will be passed into the function. The order of non-key fields is not constrained in this way. Revision status: when you first create a Lookup Table Revision it has DRAFT status. Use the [Update LookupTableRevision Status](www.m3ter.com/docs/api#tag/LookupTableRevision/operation/UpdateLookupTableRevisionStatus) call to change a Revision''s status.' operationId: CreateLookupTableRevision parameters: - name: orgId in: path description: UUID of the Organization. The Organization represents your company as a direct customer of the m3ter service. required: true style: simple explode: false schema: type: string deprecated: true x-stainless-deprecation-message: the org id should be set at the client level instead - name: lookupTableId in: path description: UUID of the Lookup Table the Revision will be created for. required: true style: simple explode: false schema: type: string requestBody: description: '' content: application/json: schema: $ref: '#/components/schemas/LookupTableRevisionRequest' required: true responses: '200': description: Returns the created Lookup Table Revision content: application/json: schema: $ref: '#/components/schemas/LookupTableRevisionResponse' 4XX: $ref: '#/components/responses/Error' 5XX: $ref: '#/components/responses/Error' components: schemas: PaginatedLookupTableRevisionResponseData: type: object properties: data: type: array description: '' items: $ref: '#/components/schemas/LookupTableRevisionResponse' nextToken: type: string description: '' description: '' LookupTableRevisionRequest: required: - fields - keys - name type: object properties: name: maxLength: 200 minLength: 1 type: string description: Descriptive name for the Lookup Table Revision. startDate: type: string description: The start date of the Lookup Table Revision. format: date-time fields: maxItems: 10 minItems: 2 type: array description: The list of fields of the Lookup Table Revision. items: $ref: '#/components/schemas/LookupTableRevisionField' keys: maxItems: 5 minItems: 1 type: array description: The ordered keys of the Lookup Table Revision. example: '["foo", "bar"]' items: type: string description: Request containing a LookupTableRevision entity allOf: - $ref: '#/components/schemas/AbstractRequestWithCustomFields' - $ref: '#/components/schemas/AbstractRequest' AbstractRequestWithCustomFields: type: object description: '' allOf: - $ref: '#/components/schemas/AbstractRequest' - properties: customFields: type: object description: 'User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number. If `customFields` can also be defined for this entity at the Organizational level, `customField` values defined at individual level override values of `customFields` with the same name defined at Organization level. See [Working with Custom Fields](https://www.m3ter.com/docs/guides/creating-and-managing-products/working-with-custom-fields) in the m3ter documentation for more information.' maxItems: 100 additionalProperties: anyOf: - title: StringCustomFieldReq type: string - title: IntegerCustomFieldReq type: integer - title: NumberCustomFieldReq type: number AbstractResponse: required: - id type: object properties: id: type: string description: 'The UUID of the entity. ' version: type: integer description: '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.' format: int64 x-stainless-terraform-configurability: computed x-stainless-terraform-always-send: true description: '' LookupTableRevisionStatus: type: string description: Status of a Lookup Table Revision enum: - DRAFT - PUBLISHED - ARCHIVED LookupTableRevisionField: required: - type type: object properties: name: maxLength: 256 pattern: ^[\p{L}_$][\p{L}_$0-9]*$ type: string description: The name of the field example: lookuptablerevisionfieldkey type: description: '' allOf: - $ref: '#/components/schemas/LookupTableRevisionFieldType' - description: The type of the field description: Field of a Lookup Table Revision LookupTableRevisionStatusRequest: type: object properties: status: description: '' allOf: - $ref: '#/components/schemas/LookupTableRevisionStatus' - description: The status of the Lookup Table Revision version: type: integer description: The version of the LookupTableRevision. format: int64 x-stainless-terraform-configurability: computed x-stainless-terraform-always-send: true description: Request containing the status details for a LookupTableRevision entity LookupTableRevisionResponse: type: object properties: name: type: string description: The name of the Lookup Table Revision. status: description: '' allOf: - $ref: '#/components/schemas/LookupTableRevisionStatus' - description: The status of the Lookup Table Revision startDate: type: string description: The start date of the Lookup Table Revision format: date-time fields: type: array description: The list of fields of the Lookup Table Revision. items: $ref: '#/components/schemas/LookupTableRevisionField' keys: type: array description: The ordered keys of the Lookup Table Revision items: type: string dtCreated: type: string description: The DateTime when the Lookup Table Revision was created. format: date-time x-stainless-skip: - terraform dtLastModified: type: string description: The DateTime when the Lookup Table Revision was last modified. format: date-time x-stainless-skip: - terraform createdBy: type: string description: The id of the user who created the Lookup Table Revision. x-stainless-skip: - terraform lastModifiedBy: type: string description: The id of the user who last modified the Lookup Table Revision. x-stainless-skip: - terraform itemCount: type: integer description: '' format: int64 description: Response containing a LookupTableRevision entity allOf: - $ref: '#/components/schemas/AbstractResponseWithCustomFields' - $ref: '#/components/schemas/AbstractResponse' AbstractRequest: type: object properties: version: type: integer description: 'The version number of the entity: - **Create entity:** Not valid for initial insertion of new entity - *do not use for Create*. On initial Create, version is set at 1 and listed in the response. - **Update Entity:** On Update, version is required and must match the existing version because a check is performed to ensure sequential versioning is preserved. Version is incremented by 1 and listed in the response.' format: int64 x-stainless-terraform-configurability: computed x-stainless-terraform-always-send: true description: '' LookupTableRevisionFieldType: type: string description: Type of a Lookup Table Revision Field enum: - STRING - NUMBER AbstractResponseWithCustomFields: type: object description: '' allOf: - $ref: '#/components/schemas/AbstractResponse' - properties: customFields: type: object description: 'User defined fields enabling you to attach custom data. The value for a custom field can be either a string or a number. If `customFields` can also be defined for this entity at the Organizational level,`customField` values defined at individual level override values of `customFields` with the same name defined at Organization level. See [Working with Custom Fields](https://www.m3ter.com/docs/guides/creating-and-managing-products/working-with-custom-fields) in the m3ter documentation for more information.' additionalProperties: anyOf: - title: StringCustomFieldRes type: string - title: IntegerCustomFieldRes type: integer - title: NumberCustomFieldRes type: number responses: Error: description: Error message content: application/json: schema: type: object properties: message: type: string securitySchemes: OAuth2: type: oauth2 description: "m3ter supports machine to machine authentication using the `clientCredentials` OAuth2 flow.\n\nThe `authorizationCode` flow controls access for human users via the m3ter Console application. \n" flows: clientCredentials: tokenUrl: /oauth/token scopes: m3ter-resources/m3ter-scope: m3ter resources measurements:upload: Upload measurements measurements:fileUpload: Upload file measurements:retrieve: Retrieve measurements authorizationCode: authorizationUrl: https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize tokenUrl: https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token scopes: m3ter-resources/m3ter-scope: m3ter resources openid: OpenID email: email measurements:upload: Upload measurements measurements:fileUpload: Upload file measurements:retrieve: Retrieve measurements