How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

M3ter ExportSchedule API

Endpoints for creating, updating, retrieving, or deleting Data Export schedules. You can set up an Export Schedule to export one of two types of data from your m3ter Organization - either *Usage data* or *Operational data* for entities.**NOTE:** You cannot create a single Export Schedule for exporting *both types of data under a single Schedule*.**Export Destinations** When creating an Export Schedule:* 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. ExportSchedule 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.

M3ter ExportSchedule API is one of 58 APIs that M3ter publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include ExportSchedule. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, and a getting-started guide.

This API exposes 5 operations across 2 paths, and defines 21 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against a single base URL, https://api.m3ter.com.

5 operations 2 paths 21 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.m3ter.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

M3ter ExportSchedule API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the clientCredentials and authorizationCode flows, exposing 6 scopes. By default, every request must be authenticated.

  • OAuth2 — m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow. The authorizationCode flow controls access for human users via the m3…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

ExportSchedule 5

Endpoints for creating, updating, retrieving, or deleting Data Export schedules. You can set up an Export Schedule to export one of two types of data from your m3ter Organization…

GET
/organizations/{orgId}/dataexports/schedules/{id}
Retrieve Schedule
GetSchedule 2 params → 2004XX5XX
PUT
/organizations/{orgId}/dataexports/schedules/{id}
Update Schedule
UpdateSchedule 2 params body → 2004XX5XX
DELETE
/organizations/{orgId}/dataexports/schedules/{id}
Delete Schedule
DeleteSchedule 2 params → 2004XX5XX
GET
/organizations/{orgId}/dataexports/schedules
List Schedules
listSchedules 4 params → 2004XX5XX
POST
/organizations/{orgId}/dataexports/schedules
Create Schedule
CreateSchedule 1 param body → 2004XX5XX

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are DataExportConfigurationResponseBase (14 properties), DataExportConfigurationRequestBase (9 properties), UsageDataExportConfigurationResponseV2 (7 properties), UsageDataExportConfigurationRequestV2 (7 properties). Each schema is shown below with its type and property counts.

OperationalDataType
string
PaginatedDataExportConfigurationResponseBaseData
object
2 properties
OperationalDataExportConfigurationResponse
object
Response representing an operational data export configuration.
2 properties
DataExplorerGroupType
string
Type of group
ScheduleType
string
TimePeriod
string
Define a time period to control the range of usage data you want the data export to contain when it runs: TODAY. Data collected for the current day up until th…
AbstractRequest
object
1 property
DataExportConfigurationResponseBase
object
Base Response containing data export configuration
14 properties
DataExplorerGroup
object
Group by a field
1 property
UsageDataExportConfigurationRequestV2
object
Request representing an usage schedule configuration.
7 properties 2 required
DataExplorerDimensionFilter
object
Filter by dimension
1 property 1 required
DataExportConfigurationRequestBase
object
Base mode request containing data export configuration
9 properties 3 required
DataExplorerFieldType
string
Type of field
OperationalDataExportConfigurationRequest
object
Request representing an operational schedule configuration.
2 properties 2 required
ExportFileFormat
string
DataExplorerMeterField
object
Meter field
2 properties 2 required
DataExplorerAggregationFunction
string
Aggregation function
UsageDataExportConfigurationResponseV2
object
Response representing an usage schedule configuration.
7 properties
AbstractResponse
object
2 properties 1 required
SourceType
string
DataExplorerAggregation
object
Aggregation to be applied to a field
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

m3ter-exportschedule-api-openapi.yml Raw ↑

Other APIs M3ter publishes across the network.

M3ter Account API
M3ter AccountPlan API
M3ter Aggregation API
M3ter Auth API
M3ter BalanceChargeSchedule API
M3ter Balances API
M3ter BalanceTransactionSchedule API
M3ter Bill API
M3ter BillConfig API
M3ter BillGroupingKey API
M3ter BillJob API
M3ter Charge API
Where this information came from

This is an independent, third-party profile of M3ter ExportSchedule API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.