View upload metrics

get

https://{hostname}/datastream-config-api/v2/log/streams/metrics

Returns aggregated metrics for log file uploads, including success or failure upload counts, upload latency, and the volume of data uploaded in the stream. Set the start and end dates to get metrics from a specific time range, and aggregationInterval to group data by time intervals.

Query Params

start

date-time

required

Specifies the beginning of the time range for the metrics in the ISO 8601 format. Set this no more than seven days before the end date.

end

date-time

required

Specifies the end of the time range for the metrics in the ISO 8601 format. Set this no more than seven days after the start date.

streamId

integer

Uniquely identifies the stream. Set the streamId to get metrics for a specific stream, or groupId for all streams belonging to that group. If both are omitted, this operation returns metrics for all streams that belong to your contract.

groupId

integer

Set the groupId to get metrics for all streams belonging to that group, or streamId for a specific stream. If both are omitted, this operation returns metrics for all streams that belong to your contract.

aggregationInterval

string

enum

Defaults to HOUR

Enum Specifies the time interval for metrics aggregation, either 5 minutes, an hour, or 24 hours. If omitted, this operation returns the metrics grouped in hourly intervals.

Allowed:

includeDetails

boolean

Defaults to true

Set to true or omit to get detailed metrics. If set to false, this operation returns only the timestamp, streamId, successAttemptResponseCount, and failAttemptResponseCount values.

Response

200The response returns aggregated upload metrics.