feat(api): add endpoint for usage analytics breakdown with detailed r…#19
feat(api): add endpoint for usage analytics breakdown with detailed r…#19piyushryn wants to merge 5 commits into
Conversation
…esponse structure
| "429": *a3 | ||
| /v1/accounts/usage-analytics: | ||
| get: | ||
| operationId: getUsageAnalytics |
There was a problem hiding this comment.
operationId: get-usage-analytics
| Returns CDN, video processing, and extension usage | ||
| breakdowns over the given date range. | ||
| tags: | ||
| - Usage Analytics |
There was a problem hiding this comment.
Add - Account Management API as well. See other apis nearby, these are important for our docs website side navbar rendering.
There was a problem hiding this comment.
@piyushryn actually remove Usage Analytics so that it can render directly inside Account Management API.
…sing query parameters
| name: startDate | ||
| required: true | ||
| description: > | ||
| Start of the date range, inclusive. Must be strictly before |
There was a problem hiding this comment.
See the description of get-usage API. We need to at least mention the date format.
There was a problem hiding this comment.
updated as the description of get-usage API
| operationId: get-usage-analytics | ||
| summary: Get usage analytics breakdown | ||
| description: > | ||
| Returns CDN, video processing, and extension usage |
There was a problem hiding this comment.
Need verbose description. It becomes part of documentation. See other APIs
| type: string | ||
| format: date-time | ||
| description: > | ||
| ISO 8601 UTC timestamp indicating when the data was actually computed for consumers to gauge freshness of the computed data. |
There was a problem hiding this comment.
Timestamp and ISO8601 string format doesnt come in one sentence, makes little sense. See other descriptions.
| requestCount: | ||
| type: number | ||
| bandwidthBytes: | ||
| type: number |
There was a problem hiding this comment.
This is how its rendering. No description in name for any nested object. Bhai batao na ki kya aayega isme.
There was a problem hiding this comment.
updated the descriptions and structure of yaml
| type: number | ||
| required: [hitCount, missCount, errorCount] | ||
|
|
||
| VideoProcessingEntry: |
There was a problem hiding this comment.
removed these NameRequestCount, NameOperationCount, CacheBreakdown, VideoProcessingEntry
| extensions: | ||
| type: array | ||
| items: | ||
| $ref: "#/components/schemas/NameOperationCount" |
There was a problem hiding this comment.
Maybe NameRequestCount, NameOperationCount, CacheBreakdown, VideoProcessingEntry can be inline, as such not much re-use, at least for latter 2.
…earer date range specifications
…s schema for clarity
2 participants
…esponse structure