ASasksyllable
sessions

Sessions List

Changed on
get/api/v1/sessions/

Request

  • Base URL
    https://api.syllable.cloud
  • URL
    https://api.syllable.cloud/api/v1/sessions/
  • Auth
    API key in header Syllable-API-Key

Query parameters

pageinteger nullable

The page number from which to start (0-based)

limitinteger

The maximum number of items to return

Example:25
search_fieldsSessionProperties[]

String names of fields to search. Correspond by index to search field values

search_field_valuesstring[]

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

order_by'timestamp' | 'session_id' | 'conversation_id' | 'channel_manager_service' | 'channel_manager_type' | 'channel_manager_sid' | 'agent_type' | 'agent_id' | 'agent_name' | 'prompt_id' | 'prompt_name' | 'experiment_id' | 'experiment_variant_id' | 'source' | 'target' | 'duration' | 'is_outbound' | 'is_legacy' | 'is_test'

Names of session fields supported for filtering/sorting on list endpoint.

The field whose value should be used to order the results

order_by_direction'asc' | 'desc'

The direction in which to order list results, either ascending or descending.

The direction in which to order the results

fieldsSessionProperties[] nullable

The fields to include in the response

start_datetimestring nullable

The start datetime for filtering results

Example:2023-01-01T00:00:00Z
end_datetimestring nullable

The end datetime for filtering results

Example:2024-01-01T00:00:00Z

Response

Successful Response

pageinteger required

The page number of the results (0-based)

page_sizeinteger required

The number of items returned per page

total_pagesinteger nullable

The total number of pages of results given the indicated page size

total_countinteger nullable

The total number of items returned from the query

Example response

{
  "items": [
    {
      "channel_manager_service": "hedy",
      "channel_manager_type": "voice_sip_v1",
      "source": "+18042221111"
    }
  ],
  "page_size": 25,
  "total_pages": 4,
  "total_count": 100
}

Changes

  • d861b61b3858Revision changes
    • info

      added the non-success response with the status

  • 72df2c39ba9dRevision changes
    • info

      added the enum value experiment_id to the property anyOf[subschema #1: SessionProperties]/ of the query request parameter order_by

    • info

      added the enum value experiment_id to the property anyOf[subschema #1]/items/ of the query request parameter fields

    • info

      added the enum value experiment_id to the property items/ of the query request parameter search_fields

    • info

      added the enum value experiment_variant_id to the property anyOf[subschema #1: SessionProperties]/ of the query request parameter order_by

    • info

      added the enum value experiment_variant_id to the property anyOf[subschema #1]/items/ of the query request parameter fields

    • info

      added the enum value experiment_variant_id to the property items/ of the query request parameter search_fields

    • 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