Cycloid Organization Cloud Cost Management Dashboard API

openapi: 3.2.0
info:
  description: This is the Cycloid's API Reference. It provides descriptions, syntax, and usage examples for each of the actions and data types available within our console.
  title: Welcome! Organization Cloud Cost Management Dashboard API
  termsOfService: https://console.cycloid.io/terms
  contact:
    name: The Great Owl
    url: https://www.cycloid.io
    email: contact@cycloid.io
  license:
    name: Cycloid @copyrights
    url: https://cycloid.io
  version: '0'
servers:
- url: https://http-api.cycloid.io
security:
- api_key: []
- api_key_query: []
tags:
- name: Organization Cloud Cost Management Dashboard
paths:
  /organizations/{organization_canonical}/cloud_cost_management:
    parameters:
    - $ref: '#/components/parameters/organization_canonical'
    get:
      description: 'Return the dashboard of the Cloud Cost Management. It contains one histogram per

        cloud provider, five top projects, the list of projects resources

        aggregated by cloud provider and the cost of the new resource in the

        period.'
      tags:
      - Organization Cloud Cost Management Dashboard
      operationId: getCloudCostManagementDashboard
      parameters:
      - $ref: '#/components/parameters/cost_granularity_filter'
      - $ref: '#/components/parameters/timestamp_range_begin_query'
      - $ref: '#/components/parameters/timestamp_range_end_query'
      - $ref: '#/components/parameters/cost_currency_filter'
      - $ref: '#/components/parameters/cost_projects_filter'
      - $ref: '#/components/parameters/cost_linked_accounts_filter'
      - $ref: '#/components/parameters/cost_master_accounts_filter'
      - $ref: '#/components/parameters/cost_record_type_filter'
      responses:
        '200':
          description: Cloud Cost Management dashboard.
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    $ref: '#/components/schemas/CloudCostManagementDashboard'
              example:
                data:
                  filter_values:
                    currencies:
                    - USD
                    - EUR
                    projects:
                    - proj1
                    - proj2
                    providers:
                    - aws
                    - gcp
                    tags:
                      key1:
                      - value1
                      - value2
                      key2:
                      - value1
                      - value2
                      - value3
                      key3:
                      - value1
                  projects:
                    buckets:
                    - buckets:
                      - cost: 50
                        value: proj1
                      - cost: 50
                        value: proj2
                      cost: 100
                      value: 2021-03
                    - buckets:
                      - cost: 150
                        value: proj1
                      - cost: 50
                        value: proj2
                      cost: 200
                      value: 2021-04
                    cost: 300
                  providers:
                    buckets:
                    - buckets:
                      - cost: 170
                        value: 2021-03
                      - cost: 130
                        value: 2021-04
                      cost: 300
                      value: aws
                    - buckets:
                      - cost: 40
                        value: 2021-03
                      - cost: 60
                        value: 2021-04
                      cost: 100
                      value: google
                    cost: 400
                  resources:
                  - project: proj1
                    providers:
                    - new_resources: 10
                      provider: aws
                      resources: 12
                    - new_resources: 7
                      provider: google
                      resources: 23
                  - project: proj2
                    providers:
                    - new_resources: 4
                      provider: aws
                      resources: 7
        '403':
          $ref: '#/components/responses/not_enough_permissions'
        '422':
          $ref: '#/components/responses/unprocessable_entity'
        default:
          $ref: '#/components/responses/unexpected_error'
      summary: Get cloud cost management dashboard
      x-summary-source: derived
components:
  schemas:
    CloudCostManagementHistogram:
      description: The histogram of the costs for a period composed of buckets that aggregate the costs.
      title: CloudCostManagementHistogram
      required:
      - cost
      - kwh
      - co2e
      - buckets
      properties:
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/CloudCostManagementBucket'
        co2e:
          description: The total CO2e emissions for the period, in metric tons.
          type: number
        cost:
          description: The total cost for the period.
          type: number
        kwh:
          description: The total energy consumption for the period, in kwh.
          type: number
    CloudCostManagementDashboard:
      description: "The dashboard of the Cloud Cost Management, it contains\n- a histogram of the cost in the period aggregated by provider and\n  by time granularity\n- a histogram of the cost aggregated by the top projects and providers\n  and filtered by the top projects\n- a list of resources and relative cost for each top projects\n- a map containing  properties that can be specified filtering the\n  returned results, with a set of valid values for each.\n"
      title: CloudCostManagementDashboard
      required:
      - providers
      - projects
      - project_resources
      - filter_values
      properties:
        filter_values:
          $ref: '#/components/schemas/CloudCostManagementFilterValues'
        project_resources:
          type: array
          items:
            $ref: '#/components/schemas/CloudCostManagementProjectResources'
        projects:
          $ref: '#/components/schemas/CloudCostManagementHistogram'
        providers:
          $ref: '#/components/schemas/CloudCostManagementHistogram'
        total_co2e:
          type: number
        total_cost:
          type: number
        total_kwh:
          type: number
    CloudCostManagementProjectProviderResources:
      description: 'Trend for a project

        '
      title: CloudCostManagementProjectProviderResources
      required:
      - cost
      - kwh
      - co2e
      - provider
      - resources
      - new_resources
      properties:
        co2e:
          description: CO2e emissions for the project and provider, in metric tons
          type: number
        cost:
          description: Cost of the project for the provider
          type: number
        kwh:
          description: Energy consumption for the project and provider, in kwh
          type: number
        new_resources:
          type: integer
        provider:
          type: string
        resources:
          type: integer
    ErrorPayload:
      description: 'The payload used by the server to response to the client with an Error, those errors could be any of the ones listed [here](https://github.com/cycloidio/youdeploy-http-api/blob/develop/errors/code.go#L10), only the CODE of the error is the one that is guaranteed to not change between the same major version, the MESSAGE could change.

        '
      title: Error Payload
      required:
      - errors
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ErrorDetailsItem'
        request_id:
          type: string
    ErrorDetailsItem:
      description: Represents an item of the list of details of an error.
      title: Error details item
      required:
      - message
      - code
      properties:
        code:
          type: string
        details:
          type: array
          items:
            type: string
        message:
          type: string
    CloudCostManagementFilterValues:
      description: 'A collection of the values for which the cost can be filtered, i.e. all

        the providers, services, regions, etc... for one org.

        '
      title: CloudCostManagementFilterValues
      properties:
        categories:
          type: array
          items:
            type: string
        components:
          type: array
          items:
            type: string
        currencies:
          type: array
          items:
            type: string
        environments:
          type: array
          items:
            type: string
        instance_types:
          type: array
          items:
            type: string
        linked_accounts:
          type: array
          items:
            type: string
        linked_accounts_with_cp:
          type: object
        master_accounts:
          type: array
          items:
            type: string
        master_accounts_with_cp:
          type: object
        projects:
          type: array
          items:
            type: string
        providers:
          type: array
          items:
            type: string
        regions:
          type: array
          items:
            type: string
        resources:
          type: array
          items:
            type: string
        services:
          type: array
          items:
            type: string
        tags:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
    CloudCostManagementProjectResources:
      description: 'The new resources and associated cost for a project in a period of time.

        '
      title: CloudCostManagementProjectResources
      required:
      - cost
      - project
      - providers
      properties:
        cost:
          description: Cost for the project in the period
          type: number
        project:
          type: string
        providers:
          type: array
          items:
            $ref: '#/components/schemas/CloudCostManagementProjectProviderResources'
    CloudCostManagementBucket:
      description: 'A sum of the cost generated in a period aggregated by one or more terms,

        for example if we aggregate costs by project here we have all the cost

        generated by a specific project in the period of time defined by the

        filters of the histogram.  In case the filter specifies more than one

        aggregation term this type will recursively contain the other levels of

        aggregation.

        '
      title: CloudCostManagementBucket
      required:
      - cost
      - value
      - kwh
      - co2e
      properties:
        buckets:
          type: array
          items:
            $ref: '#/components/schemas/CloudCostManagementBucket'
        co2e:
          description: The total CO2e emissions for the aggregated usage, in metric tons.
          type: number
        cost:
          type: number
        kwh:
          description: The total energy consumption for the aggregated usage, in kwh
          type: number
        value:
          description: 'The value of the aggregation term, for example if we aggregate cost

            by region aggregate_value can be us-east-2, if we aggregate by project

            this can be cool_project_number_42, by service can be S3 or EC2, etc..

            '
          type: string
  parameters:
    timestamp_range_end_query:
      description: The unix timestamp in milliseconds, which indicate the end of the time range.
      name: end
      in: query
      schema:
        type: integer
        format: uint64
    timestamp_range_begin_query:
      description: The unix timestamp in milliseconds, which indicate the start of the time range.
      name: begin
      in: query
      schema:
        type: integer
        format: uint64
    cost_master_accounts_filter:
      description: The ids of the master accounts that you can use to filter your results
      name: master_accounts
      in: query
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
    cost_granularity_filter:
      description: Sets the cost granularity, it can be month, week, day.
      name: granularity
      in: query
      required: true
      schema:
        type: string
        enum:
        - month
        - week
        - day
    cost_projects_filter:
      description: The names of the projects that you can use to filter your results
      name: projects
      in: query
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
    organization_canonical:
      description: A canonical of an organization.
      name: organization_canonical
      in: path
      required: true
      schema:
        type: string
        maxLength: 100
        minLength: 2
        pattern: ^[a-z0-9]([a-z0-9\-_]*[a-z0-9])?$
    cost_currency_filter:
      description: The currency required for the results.
      name: currency
      in: query
      required: true
      schema:
        type: string
        enum:
        - USD
        - EUR
        - CNY
        - GBP
    cost_linked_accounts_filter:
      description: The ids of the linked accounts that you can use to filter your results
      name: linked_accounts
      in: query
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
    cost_record_type_filter:
      description: The type of records that you can use to filter your results. For example usage or credit.
      name: record_types
      in: query
      style: form
      explode: true
      schema:
        type: array
        items:
          type: string
  responses:
    not_enough_permissions:
      description: The authenticated user cannot perform the operation because, it doesn't have permissions for such operation.
      headers:
        Content-Length:
          description: The length of the response body in octets (8-bit bytes).
          schema:
            type: integer
            format: uint64
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorPayload'
          example:
            errors:
            - code: Unauthorized
              message: Not enough permissions to perform the operation
    unprocessable_entity:
      description: All the custom errors that are generated from the Cycloid API
      headers:
        Content-Length:
          description: The length of the response body in octets (8-bit bytes).
          schema:
            type: integer
            format: uint64
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorPayload'
          example:
            errors:
            - code: SomeCode
              message: some error
    unexpected_error:
      description: The response sent when an unexpected error happened, as known as an internal server error.
      headers:
        Content-Length:
          description: The length of the response body in octets (8-bit bytes).
          schema:
            type: integer
            format: uint64
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorPayload'
          example:
            errors:
            - code: Unexpected
              message: Server Internal error
  securitySchemes:
    api_key:
      description: The API authorization is done with JWT tokens
      type: apiKey
      name: Authorization
      in: header
    api_key_query:
      description: The API authorization is done with JWT tokens in the query string
      type: apiKey
      name: api_key
      in: query