openapi: 3.2.0
info:
  description: Marketo Engage Rest API
  version: '1.0'
  title: Marketo Engage Rest Usage API
  termsOfService: https://www.adobe.com/legal.html
  contact:
    name: Adobe Developer Relations
    url: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home
    email: ''
  license:
    name: API License Agreement
    url: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/api-license
servers:
- url: https://localhost:8080/
tags:
- name: Usage
  description: Stats Controller
paths:
  /rest/v1/stats/errors.json:
    get:
      tags:
      - Usage
      summary: Get Daily Errors
      description: 'Retrieves a count of each error type they have encountered in the current day. Required Permissions: None'
      operationId: getDailyErrorsUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfErrorsData'
  /rest/v1/stats/errors/last7days.json:
    get:
      tags:
      - Usage
      summary: Get Weekly Errors
      description: 'Returns a count of each error type they have encountered in the past 7 days. Required Permissions: None'
      operationId: getLast7DaysErrorsUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfErrorsData'
  /rest/v1/stats/usage.json:
    get:
      tags:
      - Usage
      summary: Get Daily Usage
      description: 'Returns the number of calls consumed for the day. Required Permissions: None'
      operationId: getDailyUsageUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfUsageData'
  /rest/v1/stats/usage/last7days.json:
    get:
      tags:
      - Usage
      summary: Get Weekly Usage
      description: 'Returns the number of calls consumed in the past 7 days. Required Permissions: None'
      operationId: getLast7DaysUsageUsingGET
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfUsageData'
components:
  schemas:
    ErrorCount:
      type: object
      required:
      - count
      - errorCode
      properties:
        count:
          type: integer
          format: int32
          description: Number of occurences of the error
        errorCode:
          type: string
          description: Integer error code of the error
    ErrorsData:
      type: object
      required:
      - date
      properties:
        date:
          type: string
          format: date-time
          description: Date of the collected calls
        errors:
          type: array
          description: Counts for individual error codes
          items:
            $ref: '#/components/schemas/ErrorCount'
        total:
          type: integer
          format: int32
          description: Total number of errors in the time period
    Error:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Error code of the error. See full list of error codes <a href="https://developers.marketo.com/rest-api/error-codes/">here</a>
        message:
          type: string
          description: Message describing the cause of the error
    UserCount:
      type: object
      required:
      - count
      - userId
      properties:
        count:
          type: integer
          format: int32
          description: Number of calls made in the time period
        userId:
          type: string
          description: Id of the user
    ResponseOfErrorsData:
      type: object
      required:
      - errors
      - requestId
      - result
      - success
      - warnings
      properties:
        errors:
          type: array
          description: Array of errors that occurred if the request was unsuccessful
          items:
            $ref: '#/components/schemas/Error'
        moreResult:
          type: boolean
          example: false
          description: Boolean indicating if there are more results in subsequent pages
        nextPageToken:
          type: string
          description: Paging token given if the result set exceeded the allowed batch size
        requestId:
          type: string
          description: Id of the request made
        result:
          type: array
          description: Array of results for individual records in the operation, may be empty
          items:
            $ref: '#/components/schemas/ErrorsData'
        success:
          type: boolean
          example: false
          description: Whether the request succeeded
        warnings:
          type: array
          description: Array of warnings given for the operation
          items:
            $ref: '#/components/schemas/Warning'
    Warning:
      type: object
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
          description: Integer code of the warning
        message:
          type: string
          description: Message describing the warning
    UsageData:
      type: object
      required:
      - date
      properties:
        date:
          type: string
          format: date-time
          description: Date of the collected calls
        total:
          type: integer
          format: int32
          description: Total number of calls in the time period
        users:
          type: array
          description: Counts for individual users
          items:
            $ref: '#/components/schemas/UserCount'
    ResponseOfUsageData:
      type: object
      required:
      - errors
      - requestId
      - result
      - success
      - warnings
      properties:
        errors:
          type: array
          description: Array of errors that occurred if the request was unsuccessful
          items:
            $ref: '#/components/schemas/Error'
        moreResult:
          type: boolean
          example: false
          description: Boolean indicating if there are more results in subsequent pages
        nextPageToken:
          type: string
          description: Paging token given if the result set exceeded the allowed batch size
        requestId:
          type: string
          description: Id of the request made
        result:
          type: array
          description: Array of results for individual records in the operation, may be empty
          items:
            $ref: '#/components/schemas/UsageData'
        success:
          type: boolean
          example: false
          description: Whether the request succeeded
        warnings:
          type: array
          description: Array of warnings given for the operation
          items:
            $ref: '#/components/schemas/Warning'