NEnexla
Metrics

Get Daily Data Processing Metrics for a User

Retrieves daily data processing metrics of all sources or all destinations owned by a user.

get/users/{user_id}/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.

resource_type'SOURCE' | 'SINK' required

The type of resource that metrics should be fetched for. Select SOURCE for the total data ingested by all sources owned by the user. Select SINK for the total data written out by all sinks owned by the user.

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

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

tostring date-time
Example:2023-01-17

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

aggregateinteger required

This should be set to 1 for fetching daily aggregated metrics over the specified time range.

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.