Share via

ReportRecordContract interface

  • Reference
Package:
@azure/arm-apimanagement

Report data.

Properties

apiId

API identifier path. /apis/{apiId}
apiRegion

API region identifier.
apiTimeAvg

Average time it took to process request.
apiTimeMax

Maximum time it took to process request.
apiTimeMin

Minimum time it took to process request.
bandwidth

Bandwidth consumed.
cacheHitCount

Number of times when content was served from cache policy.
cacheMissCount

Number of times content was fetched from backend.
callCountBlocked

Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests
callCountFailed

Number of calls failed due to gateway or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600
callCountOther

Number of other calls.
callCountSuccess

Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect
callCountTotal

Total number of calls.
country

Country to which this record data is related.
interval

Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).
name

Name depending on report endpoint specifies product, API, operation or developer name.
operationId

Operation identifier path. /apis/{apiId}/operations/{operationId}
productId

Product identifier path. /products/{productId} NOTE: This property will not be serialized. It can only be populated by the server.
region

Country region to which this record data is related.
serviceTimeAvg

Average time it took to process request on backend.
serviceTimeMax

Maximum time it took to process request on backend.
serviceTimeMin

Minimum time it took to process request on backend.
subscriptionId

Subscription identifier path. /subscriptions/{subscriptionId}
timestamp

Start of aggregation period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.
userId

User identifier path. /users/{userId} NOTE: This property will not be serialized. It can only be populated by the server.
zip

Zip code to which this record data is related.

Property Details

apiId

API identifier path. /apis/{apiId}

apiId?: string

Property Value

string

apiRegion

API region identifier.

apiRegion?: string

Property Value

string

apiTimeAvg

Average time it took to process request.

apiTimeAvg?: number

Property Value

number

apiTimeMax

Maximum time it took to process request.

apiTimeMax?: number

Property Value

number

apiTimeMin

Minimum time it took to process request.

apiTimeMin?: number

Property Value

number

bandwidth

Bandwidth consumed.

bandwidth?: number

Property Value

number

cacheHitCount

Number of times when content was served from cache policy.

cacheHitCount?: number

Property Value

number

cacheMissCount

Number of times content was fetched from backend.

cacheMissCount?: number

Property Value

number

callCountBlocked

Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests

callCountBlocked?: number

Property Value

number

callCountFailed

Number of calls failed due to gateway or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600

callCountFailed?: number

Property Value

number

callCountOther

Number of other calls.

callCountOther?: number

Property Value

number

callCountSuccess

Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect

callCountSuccess?: number

Property Value

number

callCountTotal

Total number of calls.

callCountTotal?: number

Property Value

number

country

Country to which this record data is related.

country?: string

Property Value

string

interval

Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).

interval?: string

Property Value

string

name

Name depending on report endpoint specifies product, API, operation or developer name.

name?: string

Property Value

string

operationId

Operation identifier path. /apis/{apiId}/operations/{operationId}

operationId?: string

Property Value

string

productId

Product identifier path. /products/{productId} NOTE: This property will not be serialized. It can only be populated by the server.

productId?: string

Property Value

string

region

Country region to which this record data is related.

region?: string

Property Value

string

serviceTimeAvg

Average time it took to process request on backend.

serviceTimeAvg?: number

Property Value

number

serviceTimeMax

Maximum time it took to process request on backend.

serviceTimeMax?: number

Property Value

number

serviceTimeMin

Minimum time it took to process request on backend.

serviceTimeMin?: number

Property Value

number

subscriptionId

Subscription identifier path. /subscriptions/{subscriptionId}

subscriptionId?: string

Property Value

string

timestamp

Start of aggregation period. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

timestamp?: Date

Property Value

Date

userId

User identifier path. /users/{userId} NOTE: This property will not be serialized. It can only be populated by the server.

userId?: string

Property Value

string

zip

Zip code to which this record data is related.

zip?: string

Property Value

string