Akamai Reports API

openapi: 3.0.0
info:
  title: 'Akamai: API Endpoint Definition Access tokens Reports API'
  version: '2'
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://{hostname}/api-definitions/v2
tags:
- name: Reports
paths:
  /reports:
    get:
      description: View a list of available reports. The data in these reports is also available in the [EdgeWorkers Management application](https://techdocs.akamai.com/edgeworkers/docs/manage-report-data).
      operationId: get-reports
      summary: Akamai List Reports
      tags:
      - Reports
      externalDocs:
        description: See documentation for this operation in Akamai's EdgeWorkers API
        url: https://techdocs.akamai.com/edgeworkers/reference/get-reports
      responses:
        '200':
          description: Describes a list of EdgeWorker reports.
          content:
            application/json:
              example:
                reports:
                - description: This report contains an overview of other reports.
                  name: Overall summary
                  reportId: 1
                - description: This report lists execution and initialization times, grouped by EdgeWorker ID and event handler.
                  name: Initialization and execution times by EdgeWorker ID and event handler
                  reportId: 2
                  unavailable: true
                - description: This report lists execution statuses, grouped by EdgeWorker ID and event handler.
                  name: Execution statuses by EdgeWorker ID and event handler
                  reportId: 3
                - description: This report lists memory usage, grouped by EdgeWorker ID and event handler.
                  name: Memory usage by EdgeWorker ID and event handler
                  reportId: 4
                  unavailable: true
                - description: This report lists execution and initialization times with percentiles, grouped by EdgeWorker ID and event handler.
                  name: Initialization and execution times with percentiles by EdgeWorker ID and event handler
                  reportId: 5
                - description: This report lists memory usage with percentiles, grouped by EdgeWorker ID and event handler.
                  name: Memory usage with percentiles by EdgeWorker ID and event handler
                  reportId: 6
                - description: This report contains the total number of sub-requests.
                  name: Sub-requests
                  reportId: 7
              schema:
                additionalProperties: false
                type: object
                required:
                - reports
                properties:
                  reports:
                    description: List of EdgeWorker reports.
                    minItems: 1
                    type: array
                    items:
                      additionalProperties: false
                      type: object
                      properties:
                        data:
                          description: Object containing data points of the EdgeWorker report.
                          oneOf:
                          - title: Single report
                            oneOf:
                            - additionalProperties: false
                              description: Specifies summary data for each EdgeWorker's usage.
                              title: Report 1
                              type: object
                              required:
                              - invocations
                              - successes
                              - errors
                              - execDuration
                              - initDuration
                              - memory
                              properties:
                                errors:
                                  additionalProperties: false
                                  description: Failed event handler executions.
                                  type: object
                                  required:
                                  - total
                                  properties:
                                    total:
                                      description: Total number of failed executions.
                                      type: integer
                                execDuration:
                                  additionalProperties: false
                                  description: Execution duration.
                                  type: object
                                  required:
                                  - avg
                                  - min
                                  - max
                                  - twentyFivePercentile
                                  - fiftyPercentile
                                  - seventyFivePercentile
                                  - ninetyFivePercentile
                                  - ninetyNinePercentile
                                  properties:
                                    avg:
                                      description: Average clock time used to execute event handlers, in milliseconds.
                                      type: number
                                    fiftyPercentile:
                                      description: 50% of the invocations took less execution time than this field's value, in milliseconds.
                                      type: number
                                    max:
                                      description: Maximum clock time used to execute event handlers, in milliseconds.
                                      type: number
                                    min:
                                      description: Minimum clock time used to execute event handlers, in milliseconds.
                                      type: number
                                    ninetyFivePercentile:
                                      description: 95% of the invocations took less execution time than this field's value, in milliseconds.
                                      type: number
                                    ninetyNinePercentile:
                                      description: 99% of the invocations took less execution time than this field's value, in milliseconds.
                                      type: number
                                    seventyFivePercentile:
                                      description: 75% of the invocations took less execution time than this field's value, in milliseconds.
                                      type: number
                                    twentyFivePercentile:
                                      description: 25% of the invocations took less execution time than this field's value, in milliseconds.
                                      type: number
                                  x-akamai:
                                    file-path: schemas/report-exec-duration.yaml
                                initDuration:
                                  additionalProperties: false
                                  description: Initialization duration.
                                  type: object
                                  required:
                                  - avg
                                  - min
                                  - max
                                  - twentyFivePercentile
                                  - fiftyPercentile
                                  - seventyFivePercentile
                                  - ninetyFivePercentile
                                  - ninetyNinePercentile
                                  properties:
                                    avg:
                                      description: Average clock time used to initialize the event handlers, in milliseconds. The average is the sum of durations divided by the number of executions.
                                      type: number
                                    fiftyPercentile:
                                      description: 50% of the invocations took less initialization time than this field's value, in milliseconds.
                                      type: number
                                    max:
                                      description: Maximum clock time used to initialize the event handlers, in milliseconds.
                                      type: number
                                    min:
                                      description: Minimum clock time used to initialize the event handlers, in milliseconds.
                                      type: number
                                    ninetyFivePercentile:
                                      description: 95% of the invocations took less initialization time than this field's value, in milliseconds.
                                      type: number
                                    ninetyNinePercentile:
                                      description: 99% of the invocations took less initialization time than this field's value, in milliseconds.
                                      type: number
                                    seventyFivePercentile:
                                      description: 75% of the invocations took less initialization time than this field's value, in milliseconds.
                                      type: number
                                    twentyFivePercentile:
                                      description: 25% of the invocations took less initialization time than this field's value, in milliseconds.
                                      type: number
                                  x-akamai:
                                    file-path: schemas/report-init-duration.yaml
                                invocations:
                                  additionalProperties: false
                                  description: Number of executions.
                                  type: object
                                  required:
                                  - total
                                  properties:
                                    total:
                                      description: Total number of executions.
                                      type: integer
                                memory:
                                  additionalProperties: false
                                  description: Memory usage.
                                  type: object
                                  required:
                                  - avg
                                  - min
                                  - max
                                  - twentyFivePercentile
                                  - fiftyPercentile
                                  - seventyFivePercentile
                                  - ninetyFivePercentile
                                  - ninetyNinePercentile
                                  properties:
                                    avg:
                                      description: Average memory used to execute event handlers.
                                      type: number
                                    fiftyPercentile:
                                      description: 50% of the invocations took less memory than this field's value.
                                      type: number
                                    max:
                                      description: Maximum memory used to execute event handlers.
                                      type: number
                                    min:
                                      description: Minimum memory used to execute event handlers.
                                      type: number
                                    ninetyFivePercentile:
                                      description: 95% of the invocations took less memory than this field's value.
                                      type: number
                                    ninetyNinePercentile:
                                      description: 99% of the invocations took less memory than this field's value.
                                      type: number
                                    seventyFivePercentile:
                                      description: 75% of the invocations took less memory than this field's value.
                                      type: number
                                    twentyFivePercentile:
                                      description: 25% of the invocations took less memory than this field's value.
                                      type: number
                                  x-akamai:
                                    file-path: schemas/report-memory-usage.yaml
                                successes:
                                  additionalProperties: false
                                  description: Successful event handler executions.
                                  type: object
                                  required:
                                  - total
                                  properties:
                                    total:
                                      description: Total number of successful executions.
                                      type: integer
                              x-akamai:
                                file-path: schemas/report-1.yaml
                            - additionalProperties: false
                              description: Specifies execution and initialization times, grouped by event handler for each EdgeWorker.
                              title: Report 2
                              type: object
                              required:
                              - edgeWorkerId
                              - data
                              properties:
                                data:
                                  description: Data points grouped by event handler and initialization mapping keys.
                                  type: object
                                  additionalProperties:
                                    description: Up to four event handler arrays and an init array for initialization data points.
                                    type: array
                                    items:
                                      additionalProperties: false
                                      description: Aggregated execution or initialization durations.
                                      type: object
                                      required:
                                      - startDateTime
                                      - edgeWorkerVersion
                                      - invocations
                                      properties:
                                        edgeWorkerVersion:
                                          description: The EdgeWorker version that was active during the execution of event handlers.
                                          type: string
                                        execDuration:
                                          additionalProperties: false
                                          description: Execution duration.
                                          type: object
                                          required:
                                          - avg
                                          - min
                                          - max
                                          - twentyFivePercentile
                                          - fiftyPercentile
                                          - seventyFivePercentile
                                          - ninetyFivePercentile
                                          - ninetyNinePercentile
                                          properties:
                                            avg:
                                              description: Average clock time used to execute event handlers, in milliseconds.
                                              type: number
                                            fiftyPercentile:
                                              description: 50% of the invocations took less execution time than this field's value, in milliseconds.
                                              type: number
                                            max:
                                              description: Maximum clock time used to execute event handlers, in milliseconds.
                                              type: number
                                            min:
                                              description: Minimum clock time used to execute event handlers, in milliseconds.
                                              type: number
                                            ninetyFivePercentile:
                                              description: 95% of the invocations took less execution time than this field's value, in milliseconds.
                                              type: number
                                            ninetyNinePercentile:
                                              description: 99% of the invocations took less execution time than this field's value, in milliseconds.
                                              type: number
                                            seventyFivePercentile:
                                              description: 75% of the invocations took less execution time than this field's value, in milliseconds.
                                              type: number
                                            twentyFivePercentile:
                                              description: 25% of the invocations took less execution time than this field's value, in milliseconds.
                                              type: number
                                          x-akamai:
                                            file-path: schemas/report-exec-duration.yaml
                                        initDuration:
                                          additionalProperties: false
                                          description: Initialization duration.
                                          type: object
                                          required:
                                          - avg
                                          - min
                                          - max
                                          - twentyFivePercentile
                                          - fiftyPercentile
                                          - seventyFivePercentile
                                          - ninetyFivePercentile
                                          - ninetyNinePercentile
                                          properties:
                                            avg:
                                              description: Average clock time used to initialize the event handlers, in milliseconds. The average is the sum of durations divided by the number of executions.
                                              type: number
                                            fiftyPercentile:
                                              description: 50% of the invocations took less initialization time than this field's value, in milliseconds.
                                              type: number
                                            max:
                                              description: Maximum clock time used to initialize the event handlers, in milliseconds.
                                              type: number
                                            min:
                                              description: Minimum clock time used to initialize the event handlers, in milliseconds.
                                              type: number
                                            ninetyFivePercentile:
                                              description: 95% of the invocations took less initialization time than this field's value, in milliseconds.
                                              type: number
                                            ninetyNinePercentile:
                                              description: 99% of the invocations took less initialization time than this field's value, in milliseconds.
                                              type: number
                                            seventyFivePercentile:
                                              description: 75% of the invocations took less initialization time than this field's value, in milliseconds.
                                              type: number
                                            twentyFivePercentile:
                                              description: 25% of the invocations took less initialization time than this field's value, in milliseconds.
                                              type: number
                                          x-akamai:
                                            file-path: schemas/report-init-duration.yaml
                                        invocations:
                                          description: Number of aggregated executions or initializations.
                                          type: integer
                                        startDateTime:
                                          description: Start date of the time period (ISO 8601).
                                          type: string
                                edgeWorkerId:
                                  description: Unique identifier for an EdgeWorker.
                                  type: integer
                              x-akamai:
                                file-path: schemas/report-2.yaml
                            - additionalProperties: false
                              description: Specifies execution success and error statuses, grouped by event handler for each EdgeWorker.
                              title: Report 3
                              type: object
                              required:
                              - edgeWorkerId
                              - data
                              properties:
                                data:
                                  description: Data points grouped by event handler mapping keys.
                                  type: object
                                  additionalProperties:
                                    description: Up to four event handler arrays.
                                    type: array
                                    items:
                                      additionalProperties: false
                                      description: Aggregated execution status.
                                      type: object
                                      required:
                                      - startDateTime
                                      - edgeWorkerVersion
                                      - status
                                      - invocations
                                      properties:
                                        edgeWorkerVersion:
                                          description: The EdgeWorker version that was active during the execution of event handlers.
                                          type: string
                                        invocations:
                                          description: Number of aggregated executions.
                                          type: integer
                                        startDateTime:
                                          description: Start date of the time period (ISO 8601).
                                          type: string
                                        status:
                                          description: Execution status.
                                          type: string
                                edgeWorkerId:
                                  description: Unique identifier for an EdgeWorker.
                                  type: integer
                              x-akamai:
                                file-path: schemas/report-3.yaml
                            - additionalProperties: false
                              description: Data array of EdgeWorker report ID 4.
                              title: Report 4
                              type: object
                              required:
                              - edgeWorkerId
                              - data
                              properties:
                                data:
                                  description: Data points grouped by event handler mapping keys.
                                  type: object
                                  additionalProperties:
                                    description: Up to four event handler arrays.
                                    type: array
                                    items:
                                      additionalProperties: false
                                      description: Aggregated memory usage.
                                      type: object
                                      required:
                                      - startDateTime
                                      - edgeWorkerVersion
                                      - memory
                                      - invocations
                                      properties:
                                        edgeWorkerVersion:
                                          description: The EdgeWorker version that was active during the execution of event handlers.
                                          type: string
                                        invocations:
                                          description: Number of aggregated executions.
                                          type: integer
                                        memory:
                                          additionalProperties: false
                                          description: Memory usage.
                                          type: object
                                          required:
                                          - avg
                                          - min
                                          - max
                                          - twentyFivePercentile
                                          - fiftyPercentile
                                          - seventyFivePercentile
                                          - ninetyFivePercentile
                                          - ninetyNinePercentile
                                          properties:
                                            avg:
                                              description: Average memory used to execute event handlers.
                                              type: number
                                            fiftyPercentile:
                                              description: 50% of the invocations took less memory than this field's value.
                                              type: number
                                            max:
                                              description: Maximum memory used to execute event handlers.
                                              type: number
                                            min:
                                              description: Minimum memory used to execute event handlers.
                                              type: number
                                            ninetyFivePercentile:
                                              description: 95% of the invocations took less memory than this field's value.
                                              type: number
                                            ninetyNinePercentile:
                                              description: 99% of the invocations took less memory than this field's value.
                                              type: number
                                            seventyFivePercentile:
                                              description: 75% of the invocations took less memory than this field's value.
                                              type: number
                                            twentyFivePercentile:
                                              description: 25% of the invocations took less memory than this field's value.
                                              type: number
                                          x-akamai:
                                            file-path: schemas/report-memory-usage.yaml
                                        startDateTime:
                                          description: Start date of the time period (ISO 8601).
                                          type: string
                                edgeWorkerId:
                                  description: Unique identifier for an EdgeWorker.
                                  type: integer
                              x-akamai:
                                file-path: schemas/report-4.yaml
                            - additionalProperties: false
                              description: Specifies execution and initialization times with percentiles, grouped by event handler for each EdgeWorker ID.
                              title: Report 5
                              type: object
                              required:
                              - edgeWorkerId
                              - data
                              - summaryStatistics
                              properties:
                                data:
                                  description: Data points grouped by event handler and initialization mapping keys.
                                  type: object
                                  additionalProperties:
                                    description: Up to four event handler arrays and an init array for initialization data points.
                                    type: array
                                    items:
                                      additionalProperties: false
                                      description: Aggregated execution or initialization durations.
                                      type: object
                                      required:
                                      - startDateTime
                                      - edgeWorkerVersion
                                      - invocations
                                      properties:
                                        edgeWorkerVersion:
                                          description: The EdgeWorker version active when the event handler executed.
                                          type: string
                                        execDuration:
                                          additionalProperties: false
                                          description: Execution duration.
                                          type: object
                                          required:
                                          - avg
                                          - min
                                          - max
                                          - twentyFivePercentile
                                          - fiftyPercentile
                                          - seventyFivePercentile
                                          - ninetyFivePercentile
                                          - ninetyNinePercentile
                                          properties:
                                            avg:
                                              description: Average clock time used to execute event handlers, in milliseconds.
                                              type: number
                                            fiftyPercentile:
                                              description: 50% of the invocations took less execution time than this field's value, in milliseconds.
                   

# --- truncated at 32 KB (258 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/akamai/refs/heads/main/openapi/akamai-reports-api-openapi.yml