sessions

List Sessions Route

Changed on
get/api/v1/sessions

Request

  • Base URL
    https://cp.xenovia.io (the document declares no server; this is the origin it was published from)
  • URL
    https://cp.xenovia.io/api/v1/sessions
  • Auth
    none declared

Query parameters

limitinteger
offsetinteger
agent_idstring uuid nullable
status'allowed' | 'blocked' | 'escalated' | 'error' | 'running' | 'incomplete'
state'running' | 'waiting' | 'ended'

Where a session is, for the sessions list: still going, holding on a person's approval (an open escalation), or done.

searchstring nullable
sub_agentstring nullable
fromstring date-time nullable
tostring date-time nullable

Headers

Authorizationstring nullable

Response

Successful Response

totalinteger required
limitinteger required
offsetinteger required

Changes

  • 3e25bef24f8fRevision changes
    • info

      added the new optional query request parameter state

    • info

      added the new optional query request parameter sub_agent

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • b20a3bdd6219Revision changes
    • breaking

      removed the required property // from the response with the status

    • warning

      deleted the query request parameter proxy_id

    • info

      added the new optional query request parameter agent_id

    • info

      added the required property // to the response with the status