NEnexla
Metrics

Get Total Account Metrics for An Organization

Retrieves total account utilization metrics for an organization. The result consists of aggregated information about records processed within the specified date range by all resources owned by users in the organization.

get/orgs/{org_id}/flows/account_metrics

Request

Path parameters

org_idinteger required

The unique ID of the organization. The result will be an aggregate of metrics for all resources owned by users in the organization.

Query parameters

fromstring date-time required
Example:2023-01-10

The date that should be considered as the start of the metrics aggregation period.

tostring date-time
Example:2023-01-17T20:24:35Z

The date that should be considered as the end of the metrics aggregation period. In the absence of this parameter, the API returns metrics aggregated up to the current date.

Headers

Accept'application/vnd.nexla.api.v1+json' | 'application/json'

Setting to application/vnd.nexla.api.v1+json is recommended.

Response

Success

statusinteger

Status of the report request. This must be 200 or Ok for the metrics object in the response to be considered valid.

Changes

No recorded changes to this operation across all 3 revisions of this API.