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

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.

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

Response body

object

fileUploadMetrics

array of objects

Provides detailed log file upload metrics for streams.

fileUploadMetrics

object

aggregationTime

date-time

required

The start date and time of the metrics aggregation time interval in the ISO 8601 format. For example, for an aggregationInterval set to FIVE_MINUTE, aggregationTime returns 2022-05-10T10:05:00 for metrics between 2022-05-10T10:05:00 and 2022-05-10T10:09:59.

failedUploadAttempts

array of objects

required

Lists the upload errorCount per specific errorCode.

failedUploadAttempts*

object

errorCode

string

required

The upload error code returned by the stream.

errorCount

integer

required

The number of occurences of the error code.

latencyBuckets

array of objects

Delivery buckets that specify the number of records the logging server delivered to the Akamai upload server within a latencyInSeconds range.

latencyBuckets

object

latencyInSeconds

integer

required

The latency for record delivery in seconds, either 0, 30, 60, 120, or 300 for five minutes. The number is the minimum value in a latency range, for example, 60 indicates latency between 60 and 120 seconds.

30 60 120 300

recordsCount

integer

required

The number of records delivered within the specified latency range.

recordsAttemptedUpload

integer

≥ 0

The total number of log records attempted to upload.

recordsFailedUpload

integer

≥ 0

The number of log records that failed to upload.

streamId

integer

required

Uniquely identifies the stream you want to view metrics for.

successUploadsCount

integer

required

≥ 0

The number of successful log uploads in the aggregation time interval.

uploadBuckets

array of objects

Upload buckets specyfing the number of records delivered from the Akamai upload server to the client-defined sink with an upload time.

uploadBuckets

object

recordsCount

integer

required

≥ 0

The number of records uploaded during the uploadTimeInMilliseconds. This is the minimum value in a range, for example, 60 indicates between 60 and 120 records.

uploadTimeInMilliseconds

integer

required

The upload time for record delivery in milliseconds, either 0, 30000, 60000, 120000, 300000, 600000, or 1800000 for 30 minutes. The number is the minimum value in a time range, for example, 120000 indicates latency between 120000 and 300000 milliseconds.

30000 60000 120000 300000 600000 1800000

uploadedBytes

integer

≥ 0

The volume of uploaded data in bytes.

totalErrorCount

integer

≥ 0

The total number log upload failures between the start and end date.

totalSuccessCount

integer

≥ 0

The total number of successful log uploads between the start and end date.

totalUploadCount

integer

≥ 0

The total number of log uploads between the start and end date.

200The response returns aggregated upload metrics.