NEnexla
Metrics

Get Total Account Metrics for a User

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

get/users/{user_id}/flows/account_metrics

Request

Path parameters

user_idinteger required

The unique ID of the user. The result will be an aggregate of metrics for all resources owned by this user.

Query parameters

org_idinteger

The ID of the organization this user belongs to. This parameter is relevant for users who belong to multiple organizations. In the absence of this parameter, the API returns an aggregate of metrics for all resources owned by the user in the user's default organization. Set this query parameter to fetch metrics for a different organization.

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-17

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 1 revision of this API.