> ## Documentation Index > Fetch the complete documentation index at: https://docs.costory.io/llms.txt > Use this file to discover all available pages before exploring further. # Get cost alert widget data ## OpenAPI ````yaml /api-reference/openapi.json get /alerts-v2/costAlerts/{id}/widgetData openapi: 3.0.0 info: title: Costory version: '1.0' description: API Documentation servers: - url: '' description: Production server security: [] paths: /alerts-v2/costAlerts/{id}/widgetData: get: tags: - Alerts V2 summary: Get cost alert widget data operationId: getCostAlertWidgetDataV2 parameters: - schema: type: string required: true name: id in: path responses: '200': description: Cost alert with thresholds content: application/json: schema: $ref: '#/components/schemas/CostAlertWidgetData' '401': description: Unauthorized content: application/json: schema: $ref: '#/components/schemas/Unauthorized' '404': description: Alert not found in the authenticated organization content: application/json: schema: $ref: '#/components/schemas/AlertError' example: error: Alert not found security: - bearerAuth: [] components: schemas: CostAlertWidgetData: type: object properties: id: type: string organizationId: type: string createdAt: type: string nullable: true format: date-time createdById: type: string archivedAt: type: string nullable: true format: date-time scopeId: type: string nullable: true urlState: type: string name: type: string currency: type: string enum: - USD - EUR - GBP - CNY queryName: type: string queries: type: array items: oneOf: - type: object properties: type: type: string enum: - condition expression: type: string minLength: 1 name: type: string alias: type: string minLength: 1 maxLength: 50 visible: type: boolean default: true colorIndex: type: number chartType: type: string enum: - BAR - LINE - AREA - WATERFALL - TABLE required: - type - expression - name - colorIndex - chartType - type: object properties: type: type: string enum: - formula formula: type: string name: type: string alias: type: string minLength: 1 maxLength: 50 visible: type: boolean default: true colorIndex: type: number chartType: type: string enum: - BAR - LINE - AREA - WATERFALL - TABLE rollingAggregation: type: object properties: aggregator: type: string enum: - SUM - AVG - MAX - MIN window: type: object properties: preset: type: string enum: - MONTH - WEEK relativeDays: type: integer minimum: 1 required: - aggregator - window shiftAmount: type: integer shiftUnit: type: string enum: - DAY - WEEK - MONTH required: - type - formula - name - colorIndex - chartType - type: object properties: type: type: string enum: - metric metricId: type: string rawMetric: type: string groupBy: anyOf: - type: string - type: array items: type: string minLength: 1 - nullable: true type: string enum: - null unitOverride: type: string aggregator: type: string enum: - SUM - AVG - MAX - MIN reducer: type: string enum: - SUM - AVG - MAX - MIN name: type: string alias: type: string minLength: 1 maxLength: 50 visible: type: boolean default: true colorIndex: type: number chartType: type: string enum: - BAR - LINE - AREA - WATERFALL - TABLE colorPalette: type: string enum: - DEFAULT - PIYG - RDYLBU - CLASSIC default: DEFAULT rollingAggregation: type: object properties: aggregator: type: string enum: - SUM - AVG - MAX - MIN window: type: object properties: preset: type: string enum: - MONTH - WEEK relativeDays: type: integer minimum: 1 required: - aggregator - window shiftAmount: type: integer shiftUnit: type: string enum: - DAY - WEEK - MONTH required: - type - metricId - aggregator - name - colorIndex - chartType - type: object properties: type: type: string enum: - cost groupBy: anyOf: - type: string - type: array items: type: string minLength: 1 - nullable: true type: string enum: - null aggregator: type: string enum: - SUM - AVG - MAX - MIN currency: type: string enum: - USD - EUR - GBP - CNY whereClause: type: object properties: {} additionalProperties: {} metricId: type: string enum: - cost - effective_cost - list_cost - contracted_cost - unblended_cost - net_unblended_cost - amortized_cost - net_amortized_cost extendDashboardConditions: type: boolean default: true name: type: string alias: type: string minLength: 1 maxLength: 50 reducer: type: string enum: - SUM - AVG - MAX - MIN visible: type: boolean default: true colorIndex: type: number chartType: type: string enum: - BAR - LINE - AREA - WATERFALL - TABLE colorPalette: type: string enum: - DEFAULT - PIYG - RDYLBU - CLASSIC default: DEFAULT rollingAggregation: type: object properties: aggregator: type: string enum: - SUM - AVG - MAX - MIN window: type: object properties: preset: type: string enum: - MONTH - WEEK relativeDays: type: integer minimum: 1 required: - aggregator - window shiftAmount: type: integer shiftUnit: type: string enum: - DAY - WEEK - MONTH required: - type - aggregator - whereClause - name - colorIndex - chartType - type: object properties: type: type: string enum: - usage whereClause: type: object properties: {} additionalProperties: {} aggregator: type: string enum: - SUM - AVG - MAX - MIN groupBy: anyOf: - type: string - type: array items: type: string minLength: 1 - nullable: true type: string enum: - null metricId: type: string name: type: string alias: type: string minLength: 1 maxLength: 50 reducer: type: string enum: - SUM - AVG - MAX - MIN visible: type: boolean default: true colorIndex: type: number chartType: type: string enum: - BAR - LINE - AREA - WATERFALL - TABLE colorPalette: type: string enum: - DEFAULT - PIYG - RDYLBU - CLASSIC default: DEFAULT rollingAggregation: type: object properties: aggregator: type: string enum: - SUM - AVG - MAX - MIN window: type: object properties: preset: type: string enum: - MONTH - WEEK relativeDays: type: integer minimum: 1 required: - aggregator - window shiftAmount: type: integer shiftUnit: type: string enum: - DAY - WEEK - MONTH required: - type - whereClause - aggregator - metricId - name - colorIndex - chartType - type: object properties: type: type: string enum: - budget budgetId: type: string budgetLineId: type: string groupBy: anyOf: - type: string - type: array items: type: string minLength: 1 - nullable: true type: string enum: - null name: type: string alias: type: string minLength: 1 maxLength: 50 virtualDimensionValue: type: string visible: type: boolean default: true colorIndex: type: number chartType: type: string enum: - BAR - LINE - AREA - WATERFALL - TABLE colorPalette: type: string enum: - DEFAULT - PIYG - RDYLBU - CLASSIC default: DEFAULT rollingAggregation: type: object properties: aggregator: type: string enum: - SUM - AVG - MAX - MIN window: type: object properties: preset: type: string enum: - MONTH - WEEK relativeDays: type: integer minimum: 1 required: - aggregator - window aggregator: type: string enum: - SUM - AVG - MAX - MIN default: SUM required: - type - budgetId - name - colorIndex - chartType - type: object properties: type: type: string enum: - externalMetric provider: type: string enum: - tsuga - bigquery - datadog - cloudwatch integrationId: type: string minLength: 1 description: >- External metric integration ID from list_metrics(includeExternal: true). metricName: type: string minLength: 1 aggregator: type: string enum: - SUM - AVG - MAX - MIN groupByFields: type: array items: type: string minLength: 1 maxItems: 7 default: [] conditions: type: string dateColumn: type: string minLength: 1 metricColumn: type: string minLength: 1 gapFillingMethod: type: string enum: - ZERO - FORWARD_FILL - LINEAR_INTERPOLATION - SPREAD name: type: string alias: type: string minLength: 1 maxLength: 50 visible: type: boolean default: true colorIndex: type: number chartType: type: string enum: - BAR - LINE - AREA - WATERFALL - TABLE colorPalette: type: string enum: - DEFAULT - PIYG - RDYLBU - CLASSIC default: DEFAULT rollingAggregation: type: object properties: aggregator: type: string enum: - SUM - AVG - MAX - MIN window: type: object properties: preset: type: string enum: - MONTH - WEEK relativeDays: type: integer minimum: 1 required: - aggregator - window required: - type - provider - integrationId - metricName - aggregator - name - colorIndex - chartType discriminator: propertyName: type evaluationPeriod: type: string enum: - DAILY - WEEKLY - MONTHLY thresholdType: type: string enum: - ABOVE - UNDER snoozedUntil: type: string nullable: true format: date-time condition: type: string nullable: true conditionAdvancedExplorerQuery: type: object nullable: true properties: {} additionalProperties: {} dedupKind: type: string nullable: true enum: - CALENDAR - ROLLING - null dedupCalendarUnit: type: string nullable: true enum: - WEEK - MONTH - null dedupWindowDays: type: integer nullable: true notificationChannel: type: string enum: - EMAIL - SLACK - TEAMS emails: type: array items: type: string format: email slackChannelId: type: string nullable: true teamsChannelId: type: string nullable: true description: type: string thresholds: type: array items: type: object properties: id: type: string costAlertId: type: string nullable: true budgetAlertId: type: string nullable: true value: type: number severityLevel: type: string enum: - INFO - WARNING - RED metricMode: type: string nullable: true enum: - ABSOLUTE_SPEND - PERIOD_OVER_PERIOD_CHANGE - null changeBasis: type: string nullable: true enum: - ABSOLUTE_DELTA - PERCENT_CHANGE - null required: - id - costAlertId - budgetAlertId - value - severityLevel - metricMode - changeBasis required: - id - organizationId - createdAt - createdById - archivedAt - scopeId - urlState - name - currency - queryName - queries - evaluationPeriod - thresholdType - snoozedUntil - condition - conditionAdvancedExplorerQuery - dedupKind - dedupCalendarUnit - dedupWindowDays - notificationChannel - emails - slackChannelId - teamsChannelId - description - thresholds Unauthorized: type: object properties: error: type: string description: Unauthorized error message required: - error AlertError: type: object properties: error: type: string required: - error securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT or Clerk ak_* API key description: >- Send `Authorization: Bearer ` using either a Clerk session JWT or a Clerk API key (`ak_*`). API keys may identify a user (`user_*`) or organization (`org_*`) principal and are generated in the Clerk Dashboard under API keys. ````