TelemetryReportSummaryDto

TelemetryReportSummaryDto
TelemetryReportSummaryDto

One stored report, without its payload

JSON Example
{
    "dateCollected": "string",
    "status": "string",
    "additionalIncluded": false,
    "attempts": 0,
    "sentAt": "string",
    "sizeBytes": 0
}
string
dateCollected
Required  

Report day, yyyy-MM-dd (UTC)

status
Required  

Lifecycle status of a stored usage report

  • PENDING: Generated and waiting to be sent; the sender takes PENDING and FAILED reports
  • SENT: Broadcom accepted the report
  • FAILED: An upload attempt failed and the report will be retried
  • FAILED_PERMANENT: The fifth attempt failed (other than a throttle answer) and no more attempts are made
  • REJECTED: Broadcom rejected the report; it is not retried
  • INVALID_SERIAL: Broadcom does not recognise the license serial; the report is not retried
  • SKIPPED_NO_LICENSE: Generated while no license was ACTIVE; the report is not sent
  • NOT_CONFIGURED: Generated while no product credential was configured; the report is not sent
  • DISABLED: Generated while the operator kill switch was on; the report is not sent
Enumeration: PENDING, SENT, FAILED, FAILED_PERMANENT, REJECTED, INVALID_SERIAL, SKIPPED_NO_LICENSE, NOT_CONFIGURED, DISABLED
boolean
additionalIncluded
Required  

Whether the additional tier is part of this report; fixed at generation

integer As int32 As int32
attempts
Required  

Number of upload attempts made for the report

string As date-time As date-time
sentAt
Optional

Time the report was accepted by Broadcom; omitted until its status is SENT

integer As int32 As int32
sizeBytes
Required  

Size of the stored report payload in bytes