Opkey Performance API

openapi: 3.2.0
info:
  title: pCloudy Device Cloud Performance API
  version: v2
  summary: Public REST API for the pCloudy real-device cloud, an Opkey product.
  description: 'The pCloudy REST API is the machine-readable surface of the pCloudy real-device testing cloud operated by Opkey (Smart Software Testing Solutions Inc.). It covers authentication, device booking and session lifecycle, app upload/install/control, device interaction, performance capture, session media and logs, network simulation, APK instrumentation, app resigning, App Center integration, and Appium/XCTest automation orchestration. All methods default to POST except authentication, and requests set Content-Type: application/json.


    PROVENANCE: this document was generated by API Evangelist from the operations, parameters and examples published in Opkey''s own public pCloudy API Reference at https://content.pcloudy.com/apidocs/ . Opkey does not publish an OpenAPI document; every path, method, parameter and description here is transcribed from that published reference and nothing has been invented. It is a third-party transcription, not a provider artifact.'
  contact:
    name: Opkey
    url: https://www.opkey.com/
  x-generated-by: API Evangelist enrichment pipeline
  x-source: https://content.pcloudy.com/apidocs/
servers:
- url: https://{cloud}.pcloudy.com
  description: pCloudy cloud instance
  variables:
    cloud:
      default: device
      enum:
      - device
      - demo
      - aus
      description: pCloudy cloud host prefix; the docs refer to this as <Cloud URL>.
security:
- accessToken: []
tags:
- name: Performance
paths:
  /api/v2/start-transaction:
    post:
      operationId: startTransaction
      summary: Start Transaction
      tags:
      - Performance
      description: Starts a named performance transaction on the device to measure a discrete user flow, optionally enabling HAR network capture for the transaction window. Used to mark the beginning of a segment for which performance metrics (and network traffic) should be collected; close it with the stop-transaction call.
      parameters:
      - name: token
        in: header
        required: true
        description: API access token (from /api/access).
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - rid
              - packageName
              - transactionName
              - start
              - enableHARLogging
              - launchApp
              - isAutomation
              properties:
                rid:
                  type: integer
                  description: Device reservation ID (returned when the device is booked).
                packageName:
                  type: string
                  description: Android application package name.
                transactionName:
                  type: string
                  description: Performance transaction name.
                start:
                  type: boolean
                  description: true to start, false to stop the transaction.
                enableHARLogging:
                  type: boolean
                  description: true to capture HAR network logs.
                launchApp:
                  type: boolean
                  description: true to launch the app.
                isAutomation:
                  type: boolean
                  description: true if run under automation.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                type: object
              example:
                traceId: QkNmNIxnUgbxjsCbOfU
                requestId: Ft3PQBMIZFcwlCextEqd8
                statusCode: 200
                status: success
                message: Transaction Operation successful
        '401':
          description: Unauthorized - missing or invalid access token
      security:
      - accessToken: []
components:
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic with your pCloudy email as the username and your API access key as the password. Used only by GET /api/access to mint an access token.
    accessToken:
      type: apiKey
      in: header
      name: token
      description: Access token returned by GET /api/access. Newer /api/v2/* operations send it as a `token` header; several legacy /api/* operations send the same token as a `token` field in the JSON request body.
externalDocs:
  description: pCloudy API Reference
  url: https://content.pcloudy.com/apidocs/