openapi: 3.0.1
info:
title: m3ter Account ExportAdHoc 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<!-- ReDoc-Inject: <security-definitions> -->"
version: '1.0'
x-logo:
url: https://console.m3ter.com/m3ter-logo-black.svg
servers:
- url: https://api.m3ter.com
security:
- OAuth2: []
tags:
- name: ExportAdHoc
description: 'Endpoints for triggering one-off, ad-hoc Data Exports. You can set up and run ad-hoc Exports to export two kinds of data from your m3ter Organization:
* Usage data.
* Operational data for entities.
**Ad-Hoc Export Destinations** When setting up and running an ad-hoc Export:
* You can define one or more Export Destinations - see the [ExportDestination](https://www.m3ter.com/docs/api#tag/ExportDestination) section of this API Reference. When the export runs, the data is sent through to the sepecified Destination. However, the export file is also made available for you to download it locally.
* You can set up and run Data Exports without defining a Destination. The data is not exported but the compiled export file is made available for downloading locally.
* For details on downloading an export file, see the [Get Data Export File Download URL](https://www.m3ter.com/docs/api#tag/ExportDestination/operation/GenerateDataExportFileDownloadUrl) endpoint in this API Reference.
**Preview Version!** The Data Export feature is currently available only in Preview release version. See [Feature Release Stages](https://www.m3ter.com/docs/guides/getting-started/feature-release-stages) for Preview release definition. ExportAdHoc endpoints will only be available if Data Export has been enabled for your Organization. For more details see [Data Export(Preview)](https://www.m3ter.com/docs/guides/data-exports) in our main User documentation. If you''re interested in previewing the Data Export feature, please get in touch with m3ter Support or your m3ter contact.
'
paths:
/organizations/{orgId}/dataexports/adhoc:
post:
tags:
- ExportAdHoc
summary: Trigger data export.
description: 'Trigger an ad-hoc Data Export. Each ad-hoc Export can be configured for exporting *only one of* either Usage or Operational data:
**Operational Data Exports**.
* **Entity Types**. Use the `operationalDataTypes` parameter to specify the entities whose operational data you want to include in the ad-hoc export.
* **Export Files**. For each of the entity types you select, when the ad-hoc export runs a separate file is compiled containing the operational data for all entities of that type that exist in your Organization
**Usage Data Exports**.
* Select the Meters and Accounts whose usage data you want to include in the ad-hoc export.
* You can use the `dimensionFilters` parameter to filter the usage data returned for export by adding specific values of non-numeric Dimension data fields on included Meters. Only the data collected for the values you''ve added for the selected Dimension fields will be included in the export.
* You can use the `aggregations` to apply aggregation methods the usage data returned for export. This restricts the range of usage data returned for export to only the data collected by aggregated fields on selected Meters. Nothing is returned for any non-aggregated fields on Meters. The usage data for Meter fields is returned as the values resulting from applying the selected aggregation method. See the [Aggregations for Queries - Options and Consequences](https://www.m3ter.com/docs/guides/data-explorer/usage-data-explorer-v2#aggregations-for-queries---understanding-options-and-consequences) for more details.
* If you''ve applied `aggregations` to the usage returned for export, you can then use the `groups` parameter to group the data by *Account*, *Dimension*, or *Time*.
**Date Range for Operational Data Exports**. To restrict the operational data included in the ad-hoc export by a date/time range, use the `startDate` date/time request parameter to specify the start of the time period. The export will include all operational data from the specified `startDate` up until the date/time the export job runs.
**Date Range for Usage Data Exports**. To restrict the usage data included in the ad-hoc export by date/time range, use the `startDate` and `endDate` date/time parameters:
* Both `startDate` and `endDate` are required.
* `endDate` must be after `startDate`.
* `endDate` cannot be after tomorrow at midnight UTC. For example if today is May 20th 2025, you can only choose `endDate` to be equal or before 2025-05-21T00:00:00.000Z.
**NOTE:** You can use the ExportJob `id` returned to check the status of the triggered ad-hoc export. See the [ExportJob](https://www.m3ter.com/docs/api#tag/ExportJob) section of this API Reference.'
operationId: TriggerDataExport
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
requestBody:
description: ''
content:
application/json:
schema:
discriminator:
propertyName: sourceType
mapping:
USAGE: '#/components/schemas/AdHocUsageDataExportConfigurationRequestV2'
OPERATIONAL: '#/components/schemas/AdHocOperationalDataExportConfigurationRequest'
anyOf:
- $ref: '#/components/schemas/AdHocOperationalDataExportConfigurationRequest'
- $ref: '#/components/schemas/AdHocUsageDataExportConfigurationRequestV2'
required: true
responses:
'200':
description: Returns the job id for the ah-hoc data export.
content:
application/json:
schema:
$ref: '#/components/schemas/AdHocResponse'
4XX:
$ref: '#/components/responses/Error'
5XX:
$ref: '#/components/responses/Error'
components:
schemas:
DataExplorerGroup:
type: object
properties:
groupType:
description: ''
$ref: '#/components/schemas/DataExplorerGroupType'
description: Group by a field
discriminator:
propertyName: groupType
mapping:
ACCOUNT: '#/components/schemas/DataExplorerAccountGroup'
DIMENSION: '#/components/schemas/DataExplorerDimensionGroup'
TIME: '#/components/schemas/DataExplorerTimeGroup'
OperationalDataType:
type: string
description: ''
enum:
- BILLS
- COMMITMENTS
- ACCOUNTS
- BALANCES
- CONTRACTS
- ACCOUNT_PLANS
- AGGREGATIONS
- PLANS
- PRICING
- PRICING_BANDS
- BILL_LINE_ITEMS
- METERS
- PRODUCTS
- COMPOUND_AGGREGATIONS
- PLAN_GROUPS
- PLAN_GROUP_LINKS
- PLAN_TEMPLATES
- BALANCE_TRANSACTIONS
- TRANSACTION_TYPES
- CHARGES
DataExplorerFieldType:
type: string
description: Type of field
enum:
- DIMENSION
- MEASURE
AdHocDataExportConfigurationRequest:
required:
- sourceType
type: object
properties:
sourceType:
description: ''
allOf:
- $ref: '#/components/schemas/SourceType'
- description: 'The type of data to export. Possible values are: OPERATIONAL, USAGE.'
destinationIds:
type: array
description: 'The destination ids.
**Note:** If you omit a Destination, this means that when the Export job runs and has succeeded, you can download the data export file locally. For details, see the [Get Data Export File Download URL](https://www.m3ter.com/docs/api#tag/ExportDestination/operation/GenerateDataExportFileDownloadUrl) endpoint in this API Reference.'
items:
type: string
exportFileFormat:
description: ''
allOf:
- $ref: '#/components/schemas/ExportFileFormat'
- description: The export file format.
startDate:
type: string
description: The inclusive start date for the data export.
format: date-time
description: Base mode request containing ad-hoc data export configuration
allOf:
- $ref: '#/components/schemas/AbstractRequest'
DataExplorerDimensionFilter:
required:
- values
type: object
properties:
values:
minItems: 1
type: array
description: Values to filter by
items:
type: string
description: Filter by dimension
allOf:
- $ref: '#/components/schemas/DataExplorerMeterField'
DataExplorerGroupType:
type: string
description: Type of group
enum:
- ACCOUNT
- DIMENSION
- TIME
AdHocResponse:
type: object
properties:
jobId:
type: string
description: The id of the job
description: Response containing data export ad-hoc jobId
AdHocUsageDataExportConfigurationRequestV2:
required:
- sourceType
type: object
properties:
sourceType:
allOf:
- type: string
enum:
- USAGE
- description: 'The type of data to export. Possible values are: USAGE'
endDate:
type: string
description: The exclusive end date for the data export.
format: date-time
meterIds:
type: array
description: List of meter IDs for which the usage data will be exported.
items:
type: string
accountIds:
type: array
description: List of account IDs for which the usage data will be exported.
items:
type: string
dimensionFilters:
type: array
description: List of dimension filters to apply
items:
$ref: '#/components/schemas/DataExplorerDimensionFilter'
aggregations:
type: array
description: List of aggregations to apply
items:
$ref: '#/components/schemas/DataExplorerAggregation'
groups:
type: array
description: List of groups to apply
items:
$ref: '#/components/schemas/DataExplorerGroup'
description: Request representing a usage data export configuration.
allOf:
- $ref: '#/components/schemas/AdHocDataExportConfigurationRequest'
- $ref: '#/components/schemas/AbstractRequest'
AdHocOperationalDataExportConfigurationRequest:
required:
- operationalDataTypes
- sourceType
type: object
properties:
sourceType:
allOf:
- type: string
enum:
- OPERATIONAL
- description: 'The type of data to export. Possible values are: OPERATIONAL'
operationalDataTypes:
minItems: 1
type: array
description: The list of the operational data types should be exported for.
items:
$ref: '#/components/schemas/OperationalDataType'
description: Request representing an operational data export configuration.
allOf:
- $ref: '#/components/schemas/AdHocDataExportConfigurationRequest'
- $ref: '#/components/schemas/AbstractRequest'
DataExplorerAggregationFunction:
type: string
description: Aggregation function
enum:
- SUM
- MIN
- MAX
- COUNT
- LATEST
- MEAN
- UNIQUE
SourceType:
type: string
description: ''
enum:
- USAGE
- OPERATIONAL
ExportFileFormat:
type: string
description: ''
enum:
- CSV
- JSONL
DataExplorerMeterField:
required:
- fieldCode
- meterId
type: object
properties:
meterId:
minLength: 1
type: string
description: Meter ID
fieldCode:
minLength: 1
type: string
description: Field code
description: Meter field
DataExplorerAggregation:
required:
- fieldType
- function
type: object
properties:
fieldType:
description: ''
allOf:
- $ref: '#/components/schemas/DataExplorerFieldType'
- description: Type of field
function:
description: ''
allOf:
- $ref: '#/components/schemas/DataExplorerAggregationFunction'
- description: Aggregation function to apply
description: Aggregation to be applied to a field
allOf:
- $ref: '#/components/schemas/DataExplorerMeterField'
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: ''
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