openapi: 3.2.0
info:
  version: v2.222.1
  title: Corva App Usage API
  description: 'The Corva API is a powerful interface providing great flexibility and extensibility with Corva. Whether your needs are simple UI visualizations, data entry, replication/sync tasks, real-time stream processing, or complex machine learning CPU-intensive apps, the Corva API is the way to make it happen. Our concepts are split into three distinct silos: data apps, visualization apps, and a REST API'
  termsOfService: https://www.corva.ai/terms-and-conditions/
  contact:
    name: Corva API Team
    email: support@corva.ai
security:
- api_key: []
tags:
- name: AppUsage
paths:
  /v2/usage_analytics/app_usage:
    get:
      summary: Get Total App Usage Statistics
      tags:
      - AppUsage
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TotalAppUsageList'
      parameters:
      - in: query
        name: group_by
        description: Group results by some columns
        required: false
        schema:
          type: string
          enum:
          - app_name
          - user_id
          - well_id
          - rig_id
          - pad_id
          - fleet_id
          - drillout_unit_id
      - in: query
        name: segment
        description: Filter by segment
        required: false
        schema:
          type: string
      - in: query
        name: company_id
        description: Filter by company_id
        schema:
          type: integer
      - in: query
        name: user_email
        description: Filter by user_email (accepts only full email)
        schema:
          type: string
      - in: query
        name: program_id
        description: Filter by program_id
        schema:
          type: array
      - in: query
        name: asset_id
        description: Filter by asset_id
        schema:
          type: array
      - in: query
        name: well_id
        description: Filter by well_id
        schema:
          type: array
      - in: query
        name: pad_id
        description: Filter by pad_id
        schema:
          type: array
      - in: query
        name: fleet_id
        description: Filter by fleet_id
        schema:
          type: array
      - in: query
        name: rig_id
        description: Filter by rig_id
        schema:
          type: array
      - in: query
        name: drillout_unit_id
        description: Filter by drillout_unit_id
        schema:
          type: array
      - in: query
        name: device_family
        description: Filter by device_family
        schema:
          type: array
      - in: query
        name: os_family
        description: Filter by os_family
        schema:
          type: array
      - in: query
        name: useragent_family
        description: Filter by useragent_family
        schema:
          type: array
      - in: query
        name: corva_v3
        description: Filter by corva_v3
        schema:
          type: boolean
      - in: query
        name: corva_next
        description: Filter by corva_next (iOS app)
        schema:
          type: boolean
      - in: query
        name: user_group
        description: Filter by user_group emails
        schema:
          type: string
          enum:
          - corva
          - clients
      - in: query
        name: device_type
        description: Filter by device_type
        schema:
          type: string
          enum:
          - web
          - web3
          - corva_next
      - in: query
        name: start
        description: Search by start time as a Unix timestamp
        schema:
          type: integer
          format: timestamp
      - in: query
        name: end
        description: Search by end time as a Unix timestamp
        schema:
          type: integer
          format: timestamp
      operationId: getV2UsageAnalyticsAppUsage
      x-operation-id-source: derived
  /v2/usage_analytics/app_usage/usage_list:
    get:
      summary: Get App Usage Statistics by user
      tags:
      - AppUsage
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppUsageByUserList'
      parameters:
      - in: query
        name: app_name
        description: Filter by app name
        required: true
        schema:
          type: string
      - in: query
        name: start
        description: Search by start time as a Unix timestamp
        schema:
          type: integer
          format: timestamp
      - in: query
        name: end
        description: Search by end time as a Unix timestamp
        schema:
          type: integer
          format: timestamp
      - in: query
        name: company_id
        description: Filter by company_id
        schema:
          type: integer
      - in: query
        name: user_email
        description: Filter by user_email (accepts only full email)
        schema:
          type: string
      - in: query
        name: program_id
        description: Filter by program_id
        schema:
          type: array
      - in: query
        name: asset_id
        description: Filter by asset_id
        schema:
          type: array
      - in: query
        name: well_id
        description: Filter by well_id
        schema:
          type: array
      - in: query
        name: pad_id
        description: Filter by pad_id
        schema:
          type: array
      - in: query
        name: fleet_id
        description: Filter by fleet_id
        schema:
          type: array
      - in: query
        name: rig_id
        description: Filter by rig_id
        schema:
          type: array
      - in: query
        name: drillout_unit_id
        description: Filter by drillout_unit_id
        schema:
          type: array
      - in: query
        name: device_type
        description: Filter by device_type
        schema:
          type: string
          enum:
          - web
          - web3
          - corva_next
      - in: query
        name: sort
        description: 'One or more fields to sort by. Prefix with a - for descending order. Ex: -event_sum'
        schema:
          type: string
          enum:
          - event_sum
      - in: query
        name: order
        description: A sorting direction
        schema:
          type: string
          enum:
          - asc
          - desc
          default: desc
      - in: query
        name: page
        description: Number of page
        schema:
          type: integer
      - in: query
        name: per_page
        description: Number of items to list per page
        schema:
          type: integer
      operationId: getV2UsageAnalyticsAppUsageUsageList
      x-operation-id-source: derived
  /v2/usage_analytics/app_usage/view_date_list:
    get:
      summary: Get App Usage Statistics day by day
      tags:
      - AppUsage
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppUsageByViewDateList'
      parameters:
      - in: query
        name: app_name
        description: Filter by app name
        required: true
        schema:
          type: string
      - in: query
        name: group_by
        description: Group results by some columns
        required: false
        schema:
          type: string
          enum:
          - app_name
          - user_id
          - well_id
          - rig_id
          - pad_id
          - fleet_id
          - drillout_unit_id
      - in: query
        name: company_id
        description: Filter by company_id
        schema:
          type: integer
      - in: query
        name: user_email
        description: Filter by user_email (accepts only full email)
        schema:
          type: string
      - in: query
        name: program_id
        description: Filter by program_id
        schema:
          type: array
      - in: query
        name: asset_id
        description: Filter by asset_id
        schema:
          type: array
      - in: query
        name: well_id
        description: Filter by well_id
        schema:
          type: array
      - in: query
        name: pad_id
        description: Filter by pad_id
        schema:
          type: array
      - in: query
        name: fleet_id
        description: Filter by fleet_id
        schema:
          type: array
      - in: query
        name: rig_id
        description: Filter by rig_id
        schema:
          type: array
      - in: query
        name: drillout_unit_id
        description: Filter by drillout_unit_id
        schema:
          type: array
      - in: query
        name: device_type
        description: Filter by device_type
        schema:
          type: string
          enum:
          - web
          - web3
          - corva_next
      - in: query
        name: start
        description: Search by start time as a Unix timestamp
        schema:
          type: integer
          format: timestamp
      - in: query
        name: end
        description: Search by end time as a Unix timestamp
        schema:
          type: integer
          format: timestamp
      operationId: getV2UsageAnalyticsAppUsageViewDateList
      x-operation-id-source: derived
  /v2/usage_analytics/app_usage/top_apps:
    get:
      summary: Get Top App Usage Statistics
      tags:
      - AppUsage
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppUsageTopAppsList'
      parameters:
      - in: query
        name: segment
        description: Filter by segment
        required: false
        schema:
          type: string
      - in: query
        name: company_id
        description: Filter by company_id
        schema:
          type: integer
      - in: query
        name: program_id
        description: Filter by program_id
        schema:
          type: array
      - in: query
        name: asset_id
        description: Filter by asset_id
        schema:
          type: array
      - in: query
        name: well_id
        description: Filter by well_id
        schema:
          type: array
      - in: query
        name: pad_id
        description: Filter by pad_id
        schema:
          type: array
      - in: query
        name: fleet_id
        description: Filter by fleet_id
        schema:
          type: array
      - in: query
        name: rig_id
        description: Filter by rig_id
        schema:
          type: array
      - in: query
        name: drillout_unit_id
        description: Filter by drillout_unit_id
        schema:
          type: array
      - in: query
        name: device_type
        description: Filter by device_type
        schema:
          type: string
          enum:
          - web
          - web3
          - corva_next
      - in: query
        name: start
        description: Search by start time as a Unix timestamp
        schema:
          type: integer
          format: timestamp
      - in: query
        name: end
        description: Search by end time as a Unix timestamp
        schema:
          type: integer
          format: timestamp
      - in: query
        name: limit
        description: Number of top apps to return (10, 20, or 30)
        required: false
        schema:
          type: integer
          enum:
          - 10
          - 20
          - 30
          default: 10
      operationId: getV2UsageAnalyticsAppUsageTopApps
      x-operation-id-source: derived
  /v2/usage_analytics/app_usage/top_users:
    get:
      summary: Get Top Users Usage Statistics
      tags:
      - AppUsage
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AppUsageByUserList'
      parameters:
      - in: query
        name: segment
        description: Filter by segment
        required: false
        schema:
          type: string
      - in: query
        name: company_id
        description: Filter by company_id
        schema:
          type: integer
      - in: query
        name: program_id
        description: Filter by program_id
        schema:
          type: array
      - in: query
        name: asset_id
        description: Filter by asset_id
        schema:
          type: array
      - in: query
        name: well_id
        description: Filter by well_id
        schema:
          type: array
      - in: query
        name: pad_id
        description: Filter by pad_id
        schema:
          type: array
      - in: query
        name: fleet_id
        description: Filter by fleet_id
        schema:
          type: array
      - in: query
        name: rig_id
        description: Filter by rig_id
        schema:
          type: array
      - in: query
        name: drillout_unit_id
        description: Filter by drillout_unit_id
        schema:
          type: array
      - in: query
        name: device_type
        description: Filter by device_type
        schema:
          type: string
          enum:
          - web
          - web3
          - corva_next
      - in: query
        name: start
        description: Search by start time as a Unix timestamp
        schema:
          type: integer
          format: timestamp
      - in: query
        name: end
        description: Search by end time as a Unix timestamp
        schema:
          type: integer
          format: timestamp
      - in: query
        name: limit
        description: Number of top users to return (10, 20, or 30)
        required: false
        schema:
          type: integer
          enum:
          - 10
          - 20
          - 30
          default: 10
      operationId: getV2UsageAnalyticsAppUsageTopUsers
      x-operation-id-source: derived
  /v2/usage_analytics/app_usage/total_usage_trend:
    get:
      summary: Get Total AppUsage for each view_date
      tags:
      - AppUsage
      responses:
        '401':
          description: Authentication error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticationError'
        '403':
          description: Authorization error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationError'
        '404':
          description: Not found error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotFoundError'
        '200':
          type: object
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TotalAppUsageTrend'
      parameters:
      - in: query
        name: company_ids
        description: Filter by company_ids
        schema:
          type: array
      - in: query
        name: app_names
        description: Filter by app_names
        schema:
          type: array
      - in: query
        name: user_group
        description: Filter by user_group emails
        schema:
          type: string
          enum:
          - corva
          - clients
      - in: query
        name: device_type
        description: Filter by device_type
        schema:
          type: string
          enum:
          - web
          - web3
          - corva_next
      - in: query
        name: start
        description: Search by start time as a Unix timestamp
        schema:
          type: integer
          format: timestamp
      - in: query
        name: end
        description: Search by end time as a Unix timestamp
        schema:
          type: integer
          format: timestamp
      - in: query
        name: segment
        description: Filter by segment
        required: false
        schema:
          type: string
      - in: query
        name: program_id
        description: Filter by program_id
        schema:
          type: array
      - in: query
        name: asset_id
        description: Filter by asset_id
        schema:
          type: array
      - in: query
        name: well_id
        description: Filter by well_id
        schema:
          type: array
      - in: query
        name: pad_id
        description: Filter by pad_id
        schema:
          type: array
      - in: query
        name: fleet_id
        description: Filter by fleet_id
        schema:
          type: array
      - in: query
        name: rig_id
        description: Filter by rig_id
        schema:
          type: array
      - in: query
        name: drillout_unit_id
        description: Filter by drillout_unit_id
        schema:
          type: array
      operationId: getV2UsageAnalyticsAppUsageTotalUsageTrend
      x-operation-id-source: derived
components:
  schemas:
    TotalAppUsageTrend:
      properties:
        data:
          type: array
          items:
            properties:
              id:
                type: integer
                format: int64
              type:
                type: string
              attributes:
                type: object
                properties:
                  id:
                    type: string
                  event_sum:
                    type: integer
                  view_date:
                    type: string
      example:
        data:
        - id: null
          type: app_usage
          attributes:
            id: null
            event_sum: 12345
            view_date: '2023-08-24'
    AppUsageByViewDateList:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AppUsageByViewDate'
      example:
        data:
        - id: 12345
          type: app_usage
          attributes:
            id: f89c
            app_name: Corva Real-Time Traces
            event_sum: 12345
            view_date: '2023-08-24'
            user_id: 123
            user_name: John Doe
            user_email: example@example.com
            user_profile_photo: https://s3-path-to-photo
            user_title: Engineer
            user_mobile: '+11234567890'
    AppUsageByViewDate:
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        attributes:
          type: object
          properties:
            id:
              type: string
            app_name:
              type: string
            event_sum:
              type: integer
            user_email:
              type: string
            user_id:
              type: integer
            user_mobile:
              type: string
            user_name:
              type: string
            user_profile_photo:
              type: string
            user_title:
              type: string
            view_date:
              type: string
    TotalAppUsage:
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        attributes:
          type: object
          properties:
            id:
              type: string
            app_name:
              type: string
            device_family:
              type: string
            os_family:
              type: string
            useragent_family:
              type: string
            corva_next:
              type: boolean
            event_sum:
              type: integer
            user_email:
              type: string
            user_id:
              type: integer
            user_mobile:
              type: string
            user_name:
              type: string
            user_profile_photo:
              type: string
            user_group:
              type: string
            user_title:
              type: string
    AuthorizationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 403
        message: Access denied
    AppUsageByUserList:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AppUsageByUser'
      example:
        data:
        - id: 12345
          type: app_usage
          attributes:
            id: f89c
            app_name: Corva Real-Time Traces
            event_sum: 12345
            user_id: 12345
            user_name: John Doe
            user_email: example@email.com
            company_name: Nova Poshta
    AppUsageTopApps:
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        attributes:
          type: object
          properties:
            id:
              type: string
            app_name:
              type: string
            event_sum:
              type: integer
            view_date:
              type: string
      example:
        id: 12345
        type: app_usage
        attributes:
          id: '12_345'
          app_name: Corva Real-Time Traces
          event_sum: 12345
          view_date: '2023-08-24'
    AppUsageTopAppsList:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/AppUsageTopApps'
      example:
        data:
        - id: 12345
          type: app_usage
          attributes:
            id: f89c
            app_name: Corva Real-Time Traces
            event_sum: 12345
            view_date: '2023-08-24'
    AuthenticationError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 401
        message: Missing authentication. Please try again.
    TotalAppUsageList:
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/TotalAppUsage'
      example:
        data:
        - id: 12345
          type: app_usage
          attributes:
            id: f89c
            app_name: Corva Real-Time Traces
            device_family: Mac
            os_family: Mac OS X
            useragent_family: Chrome
            event_sum: 12345
            user_email: example@example.com
            user_id: 123
            user_mobile: '+11234567890'
            user_name: John Doe
            user_profile_photo: https://s3-path-to-photo
            user_title: Engineer
            user_group: RTOC
    AppUsageByUser:
      properties:
        id:
          type: integer
          format: int64
        type:
          type: string
        attributes:
          type: object
          properties:
            id:
              type: string
            app_name:
              type: string
            event_sum:
              type: integer
            user_id:
              type: integer
            user_name:
              type: string
            user_email:
              type: string
            company_name:
              type: string
      example:
        id: 12345
        type: app_usage
        attributes:
          id: f89c
          app_name: Corva Real-Time Traces
          event_sum: 12345
          user_id: 12345
          user_name: John Doe
          user_email: example@email.com
          company_name: Nova Poshta
    NotFoundError:
      required:
      - code
      - message
      properties:
        code:
          type: integer
          format: int32
        message:
          type: string
      example:
        code: 404
        message: Not found
  securitySchemes:
    api_key:
      type: apiKey
      name: authorization
      in: header