Esper device_MultiOS Remote Viewer API

openapi: 3.2.0
info:
  title: ESPER API REFERENCE device_MultiOS Remote Viewer API
  x-logo:
    url: esper-logo-white.svg
    backgroundColor: '#141418'
    altText: Logo
  description: '# Introduction

    Welcome to Esper’s API documentation. The Esper API allows users to accomplish operations outside of the console. Some common uses for our APIs include observing device information and console activity, installing and updating apps, uploading files, and sending files to devices. Our users have also used the API to automate app updates, perform bulk actions, and more. Esper API endpoints use REST-based architecture and return JSON responses. See our documentation for:


    * Getting started guides

    * Commonly used API examples

    * API command examples

    * Automated Script examples

    * And more


    # Authentication


    You need to create an API Key to interact with our APIs. Learn more about generating an API Key. You can also learn more about Esper and sign up for an account at esper.io/signup. Some endpoints also require an Enterprise ID. This ID can be found in the API Management section of the Esper console. # Lifecycle Labels


    Esper uses lifecycle labels to communicate the support status of each API endpoint. Use the following table to understand what each label means and how to respond. Badge

    What it means

    Recommended action


    Stable

    This endpoint is fully supported and safe for production use. No action needed. Beta

    This endpoint is publicly available but may change. It is not recommended for production integrations. Use with caution. Monitor the API changelog for updates before relying on this endpoint. Legacy

    This endpoint uses an older architecture and is still supported, but a newer equivalent exists. It is not recommended for new integrations. Plan migration to the recommended replacement when possible. See the endpoint description for the alternative. Deprecated

    This endpoint has stopped being supported. A removal date may be added at a later time. A replacement is available or the feature is entirely retired. Migrate before the removal date listed in the endpoint description. Do not use this endpoint in new integrations. # Pagination


    Responses may be paginated. Use the following parameters to query the data. A full list of parameters can be found on the endpoint’s documentation page. Parameter

    Data Type

    Explanation


    limit

    integer

    Limit the data returned. Default = 20. offset

    integer

    Offset to the first item returned. Default = 0. ordering

    string

    Order the results set by the field name. Varies by endpoint. next

    string

    Paginate to the next response set. previous

    string

    Paginate to the last set response. # Errors

    We use standard HTTP status codes for success or failure. A typical error response may look something like this:


    ```json

    {

    "errors": [],

    "message": "error message",

    "status": 400

    }

    ```

    * `errors` - List of error details

    * `message` - Error description

    * `status` - HTTP status code


    Some common status codes and messages are:


    Number

    Message

    Explanation


    200

    OK

    The request succeeded. 201

    Resource creation

    A resource was created. 401

    Unauthorized

    The API key is invalid. 404

    Not found

    The resource was not found. 429

    Rate limit exceeded

    Too many requests. Wait a moment and try again. 500

    Server error

    Internal error. Wait a moment and try again. If the issue persists, contact Esper. See how our systems are doing by checking our status page. # Rate Limits

    To ensure quality of service for all customers, we enforce rate limits for API requests. Most customers won’t hit this limit with normal use. In case you experience 429 or rate limit exceeded errors, we recommend the following:

    * Try sending requests in batches. * Begin with about 20 requests at a time and building up from there. * Ensure your scripts are efficient and don’t contain redundant calls. * Reach out to your account manager to discuss your options.'
  termsOfService: https://esper.io/terms-of-service
  contact:
    email: developer@esper.io
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.0.0
  x-prefix-tag: esper cloud api
servers:
- url: https://{foo}-api.esper.cloud/api
  variables:
    foo:
      default: develop
      description: Custom end point
tags:
- name: device_MultiOS Remote Viewer
  description: API to get Remote Viewer activity for the tenant. Currently supports only Android devices with DPC 8.4 and above along with RemoteViewer 3.x.
  x-displayName: MultiOS Remote Viewer
paths:
  /v2/rv-activity-feed/:
    get:
      x-badges:
      - name: Stable
        color: green
      summary: Get RemoteViewer Activity Feed for the tenant
      description: 'Retrieves a paginated, filterable feed of Remote Viewer sessions across the tenant.


        Each entry represents one Remote Viewer session, including the device it targeted, its current state, video quality, duration, and who initiated it. Supports filtering by state, video quality, device name, and the user who created the session.


        **About Remote Viewer Activity Feed**


        Remote Viewer sessions move through INITIATED, ACKNOWLEDGED, ACTIVE, and a terminal TERMINATED or FAILED state. This feed gives a tenant-wide, auditable view of who has remotely viewed which devices, how long each session lasted, and whether it completed successfully, spanning the multi-OS Remote Viewer feature rather than any single platform.


        **Key Fields / Query Parameters**


        states — filters by one or more session states, comma-separated


        created_by — filters sessions by the user who initiated them


        device_name — searches sessions by device name


        ordering — orders results, defaults to -created_at (most recent first)


        **Common Use Cases**


        Auditing who accessed a given device through Remote Viewer and when


        Reviewing failed or unusually long Remote Viewer sessions across the fleet


        Investigating support activity on a specific device by filtering on device_name


        **Best Practices**


        Filter by states to separate completed sessions from ones that failed or never became active


        Use created_by when auditing an individual support agent''s Remote Viewer activity


        **Workflow**


        Call this endpoint with the filters relevant to your audit or investigation


        Review session state and duration for each result


        Use the session_id to correlate with support tickets or other internal records if needed'
      tags:
      - device_MultiOS Remote Viewer
      parameters:
      - in: query
        name: limit
        schema:
          type: integer
      - in: query
        name: offset
        schema:
          type: integer
      - in: query
        name: states
        schema:
          type: string
          enum:
          - INITIATED
          - ACKNOWLEDGED
          - ACTIVE
          - TERMINATED
          - FAILED
          description: List API supports comma separated states.
      - in: query
        name: video_qualities
        schema:
          type: string
          enum:
          - STANDARD
          - DATA_SAVER
          description: To allow filtering sessions list by comma separated video qualities
      - in: query
        name: reason
        schema:
          type: string
          description: To allow searching sessions list by reason
      - in: query
        name: created_by
        schema:
          type: string
          description: To allow filtering sessions list by created by
      - in: query
        name: device_name
        schema:
          type: string
          description: To allow searching sessions list by device name
      - in: query
        name: ordering
        schema:
          type: string
          default: -created_at
          enum:
          - created_at
          - updated_at
          - device_name
          - duration
          - state
          - reason
          - video_quality
          - created_by
          description: To allow ordering sessions list by created_at, updated_at, device_name, duration, state, reason, video_quality and created_by.
      - in: query
        name: duration_lt
        schema:
          type: string
          format: duration
          description: Duration less than filter. The time duration (in ISO 8601 duration format) of only a valid elapsed session, i.e., sessions that have moved from ACTIVE state (where session start-time can be captured) to TERMINATED or FAILED state (where the session end-time can be captured).
          example: duration_lt=PT10M30S
      - in: query
        name: duration_lte
        schema:
          type: string
          format: duration
          description: Duration less than or equal to filter. The time duration (in ISO 8601 duration format) of only a valid elapsed session, i.e., sessions that have moved from ACTIVE state (where session start-time can be captured) to TERMINATED or FAILED state (where the session end-time can be captured).
          example: duration_lte=PT10M30S
      - in: query
        name: duration_gt
        schema:
          type: string
          format: duration
          description: Duration greater than filter. The time duration (in ISO 8601 duration format) of only a valid elapsed session, i.e., sessions that have moved from ACTIVE state (where session start-time can be captured) to TERMINATED or FAILED state (where the session end-time can be captured).
          example: duration_gt=PT10M30S
      - in: query
        name: duration_gte
        schema:
          type: string
          format: duration
          description: Duration greater than or equal to filter. The time duration (in ISO 8601 duration format) of only a valid elapsed session, i.e., sessions that have moved from ACTIVE state (where session start-time can be captured) to TERMINATED or FAILED state (where the session end-time can be captured).
          example: duration_gte=PT10M30S
      - in: query
        name: created_at_lt
        schema:
          type: string
          format: date-time
          description: Created at less than filter. Datetime format must be in "YY-MM-DDTHH:mm:ss.fffffffffZ".
          example: created_at_lt=2023-10-01T12:00:00Z
      - in: query
        name: created_at_gt
        schema:
          type: string
          format: date-time
          description: Created at greater than filter. Datetime format must be in "YY-MM-DDTHH:mm:ss.fffffffffZ".
          example: created_at_gt=2023-10-01T12:00:00Z
      - in: query
        name: created_at_lte
        schema:
          type: string
          format: date-time
          description: Created at less than or equal to filter. Datetime format must be in "YY-MM-DDTHH:mm:ss.fffffffffZ".
          example: created_at_lte=2023-10-01T12:00:00Z
      - in: query
        name: created_at_gte
        schema:
          type: string
          format: date-time
          description: Created at greater than or equal to filter. Datetime format must be in "YY-MM-DDTHH:mm:ss.fffffffffZ".
          example: created_at_gte=2023-10-01T12:00:00Z
      - in: query
        name: updated_at_lt
        schema:
          type: string
          format: date-time
          description: Updated at less than filter. Datetime format must be in "YY-MM-DDTHH:mm:ss.fffffffffZ".
          example: updated_at_lt=2023-10-01T12:00:00Z
      - in: query
        name: updated_at_gt
        schema:
          type: string
          format: date-time
          description: Updated at greater than filter. Datetime format must be in "YY-MM-DDTHH:mm:ss.fffffffffZ".
          example: updated_at_gt=2023-10-01T12:00:00Z
      - in: query
        name: updated_at_lte
        schema:
          type: string
          format: date-time
          description: Updated at less than or equal to filter. Datetime format must be in "YY-MM-DDTHH:mm:ss.fffffffffZ".
          example: updated_at_lte=2023-10-01T12:00:00Z
      - in: query
        name: updated_at_gte
        schema:
          type: string
          format: date-time
          description: Updated at greater than or equal to filter. Datetime format must be in "YY-MM-DDTHH:mm:ss.fffffffffZ".
          example: updated_at_gte=2023-10-01T12:00:00Z
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  content:
                    type: object
                    properties:
                      count:
                        type: integer
                      previous:
                        type: string
                      next:
                        type: string
                      results:
                        type: array
                        items:
                          $ref: '#/components/schemas/device_RemoteViewerSessionsListForTenantResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device_Error_400_Bad_Data'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device_Error_401_Unauthorized'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device_Error_500_Internal_Server_Error'
      operationId: getV2RvActivityFeed
      x-operation-id-source: derived
components:
  schemas:
    device_Error_400_Bad_Data:
      type: object
      properties:
        code:
          type: integer
          format: int32
          default: 400
        message:
          type: string
        content:
          type: object
      required:
      - code
      - message
    device_Error_500_Internal_Server_Error:
      type: object
      properties:
        code:
          type: integer
          format: int32
          default: 500
        message:
          type: string
        content:
          type: object
      required:
      - code
      - message
    device_DeviceStateEnumAndroid:
      type: integer
      format: int32
      description: 'The following are the device states and their descriptions:

        ```

        * 0 = Device State is Unspecified

        * 1 = Online

        * 20 = Disabled (device has been factory reset or removed from the Esper Dashboard)

        * 30 = Beginning Provisioning

        * 40 = Configuring Google Play (still provisioning)

        * 50 = Applying Policies and Installing Applications (still provisioning)

        * 60 = Offline

        * 70 = Device is undergoing a Factory Reset (reset started from Dashboard)

        * 80 = Device Onboarding in Progress

        * 90 = Device Onboarding Failed

        * 100 = Device Onboarded in Esper

        * 110 = Android For Work Account added

        * 120 = Apps installed

        * 130 = Branding Processed

        * 140 = Permission Policy Processed

        * 150 = Device Policy Processed

        * 160 = Device Settings Processed

        * 170 = Security Policy Processed

        * 180 = Phone Policy Processed

        * 190 = Custom Settings Processed

        * 200 = Device is Registered

        ```

        '
      enum:
      - 0
      - 1
      - 20
      - 30
      - 40
      - 50
      - 60
      - 70
      - 80
      - 90
      - 100
      - 110
      - 120
      - 130
      - 140
      - 150
      - 160
      - 170
      - 180
      - 190
      - 200
    device_RemoteViewerSessionsListForTenantResponse:
      type: object
      properties:
        session_id:
          type: string
          format: uuid
        device_id:
          type: string
          format: uuid
        state:
          type: string
          enum:
          - INITIATED
          - ACKNOWLEDGED
          - ACTIVE
          - TERMINATED
          - FAILED
        reason:
          type: string
        video_quality:
          type: string
          enum:
          - STANDARD
          - DATA_SAVER
        duration:
          type: string
          format: duration
          description: Depicts the time duration (in ISO 8601 duration format) of only a valid elapsed session, i.e., sessions that have moved from ACTIVE state (where session start-time can be captured) to TERMINATED or FAILED state (where the session end-time can be captured).
          example: PT10M30S
        created_by:
          type: string
        updated_by:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        device_name:
          type: string
          description: Name of the device.
        device_alias:
          type: string
          description: Alias of the device (if any).
        device_state:
          $ref: '#/components/schemas/device_DeviceStateEnumAndroid'
    device_Error_401_Unauthorized:
      type: object
      properties:
        code:
          type: integer
          format: int32
          default: 401
        message:
          type: string
        content:
          type: object
      required:
      - code
      - message
  securitySchemes:
    esper_cloud_api_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    pipelines_SCAPIAuthToken:
      type: http
      scheme: bearer
    device_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    apps_management_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    commands_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    drift_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    device_onboarding_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    tenant_apiKey:
      type: http
      scheme: bearer
      description: "#### API KEY - Access Token\nAccess token for API is passed as authorization header in calls. You need to generate this from your Esper Console at `<domain>-api.esper.cloud` where foo is the sub-domain name you gave for your Esper Dev environment when you signed up for your Esper account. Please follow the instructions [in this Help article](https://help.esper.io/hc/en-us/articles/12656959508497) to generate an access token.\nOnce you have the access token, you need to send an authorization header as below\n\n```bash\n\n    curl -X GET \\\n      https://<domain>-api.esper.cloud/api/enterprise/<enterprise_id>/device/ \\\n      -H 'Authorization: Bearer <ACCESS_TOKEN>' \\\n      -H 'Content-Type: application/json' \\\n```\n\n> Please note the use of keyword **Bearer** before the token value.\n\n\nYou can read more about api key authentication [here](https://help.esper.io/hc/en-us/articles/12656959508497).\n"
    foundation_AuthToken:
      type: apiKey
      in: header
      name: Authorization
    reports_bearerAuth:
      type: http
      scheme: bearer
    geofence_bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
x-tagGroups:
- name: ESPER CLOUD API
  tags:
  - esper_cloud_api_Company Settings
  - esper_cloud_api_Application
  - esper_cloud_api_Application V1
  - esper_cloud_api_AndroidDevice
  - esper_cloud_api_Device Group
  - esper_cloud_api_Token (Deprecated)
  - esper_cloud_api_Commands V2
  - esper_cloud_api_Enterprise Policy
  - esper_cloud_api_Geofence
  - esper_cloud_api_Content
  - esper_cloud_api_User (Deprecated)
  - esper_cloud_api_User
  - esper_cloud_api_Blueprint (Deprecated)
  - esper_cloud_api_Directory Record
  - esper_cloud_api_Tile Icon
  - esper_cloud_api_Alerts
  - esper_cloud_api_Alarms
  - esper_cloud_api_Wallpapers
  - esper_cloud_api_Device Telemetry
  - esper_cloud_api_Daily and Custom Reports
  - esper_cloud_api_SSO Connections
  - esper_cloud_api_Roles
  - esper_cloud_api_Personal Access Token
- name: BLUEPRINTS
  tags:
  - blueprints_Blueprints API
  - blueprints_Custom Actions API
  - blueprints_Background Scripts API
- name: PIPELINES
  tags:
  - pipelines_System Status Code
  - pipelines_System
  - pipelines_Pipelines
  - pipelines_Stages
  - pipelines_Target Lists
  - pipelines_Targets
  - pipelines_Device Groups
  - pipelines_Operation Lists
  - pipelines_Operations
  - pipelines_Pipeline Runs
  - pipelines_Stage Runs
  - pipelines_Target Runs
- name: DEVICE
  tags:
  - device_Device
  - device_Device Heartbeat
  - device_Device Apps
  - device_Device Enrollment in EMM
  - device_Operations
  - device_DeviceOperations
  - device_MultiOS Remote Viewer
- name: APPS MANAGEMENT
  tags:
  - apps_management_VPP License Management
  - apps_management_VPP App Management
  - apps_management_Tenant Apps
  - apps_management_Apple App Store
  - apps_management_App List
  - apps_management_Webclips
  - apps_management_Provisioning Profiles
  - apps_management_Preferred Regions
  - apps_management_OEM Config Schema
  - apps_management_Esper Apps
  - apps_management_Tenant Esper Apps
- name: COMMANDS
  tags:
  - commands_Command Request
  - commands_Command Status
- name: DRIFT
  tags:
  - drift_Converge
  - drift_Converge Command
  - drift_Blueprint Drift
- name: DEVICE ONBOARDING
  tags:
  - device_onboarding_DEP Sync Request
  - device_onboarding_ABM Provisioning
- name: TENANT
  tags:
  - tenant_APNs certificate
  - tenant_DEP Profile
  - tenant_DEP Tokens
  - tenant_VPP Token Management
  - tenant_Google Enterprise
  - tenant_MDM Service Config
- name: FOUNDATION
  tags:
  - foundation_FoundryBuilds
  - foundation_FoundryDeviceModels
  - foundation_FoundryEvents
- name: REPORTS
  tags:
  - reports_Reports API
- name: GEOFENCE
  tags:
  - geofence_Geofences
  - geofence_Device State
x-provenance:
  method: harvested
  publisher: Esper
  source: https://api.esper.io/_bundle/openapi.json?download
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)