text-ai
text_sessions

List Text Sessions

Changed on

List text sessions with pagination and optional filters.

get/api/v1/text-ai/text-sessions

Request

  • Base URL: https://api.getanana.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.getanana.com/api/v1/text-ai/text-sessions
  • Auth: none declared

Query parameters

text_widget_group_idstring uuid nullable
was_transferredboolean nullable
contact_sourcestring nullable
transfer_destinationstring nullable
outcome'voicemail' | 'missed_by_system' | 'transferred' | 'handled_end_to_end' | '__null__' nullable
has_first_responseboolean nullable

Filter to sessions where the AI produced a first response (population behind the avg-first-response widget).

has_endedboolean nullable

Filter to sessions that have ended (population behind the avg-resolution-time widget).

local_hour_of_dayinteger nullable

Filter to sessions stamped at this tenant-local hour (0-23); heatmap cell drill.

local_day_of_weekinteger nullable

Filter to sessions stamped on this tenant-local weekday (0=Mon..6=Sun); heatmap cell drill.

bucketsstring[] nullable

Filter to sessions in any of these attribution buckets — the drill of a bucket-grouped cell or a bucket filter.

handling_outcomesstring[] nullable

Filter to sessions in any of these handling outcomes — the drill of a handling-outcome-grouped cell.

crm_record'yes' | 'no' nullable

Filter to conversations the AI did ('yes') or did not ('no') leave a CRM record for — the drill of a CRM-record-grouped cell.

dispositionsstring[] nullable

Filter to sessions in any of these terminal dispositions — the drill of a disposition-set measure (e.g. Missed & Abandoned).

needs_owner_reviewboolean nullable

When true, returns only sessions where a human participated but the outcome owner is not credited to a human (unattributed worklist).

use_created_atboolean nullable

Deprecated - use date_field=created_at.

limitinteger nullable
offsetinteger nullable
pageinteger nullable

Deprecated - use offset.

per_pageinteger nullable

Deprecated - use limit.

start_datestring date nullable
end_datestring date nullable
date_fieldstring nullable

Which timestamp the date range filters. Valid values differ per subject; an unknown one is a 422 listing them.

date_fromstring date-time nullable

Deprecated - use start_date.

date_tostring date-time nullable

Deprecated - use end_date.

property_ids_excludestring[] nullable
include_considered_hotelsboolean nullable

Include hotels the conversation was only considered for, not just the one it was attributed to.

string uuid
OR
'__null__'
outcome_agent_refstring nullable
outcome_agent_refsstring[] nullable
outcome_agent_refs_excludestring[] nullable
outcome_agent_kind'ai_voice' | 'ai_text' | 'human' nullable
reviewedboolean nullable
statusstring nullable
has_booking_intentboolean nullable
has_bookingboolean nullable
booking_madeboolean nullable
booking_attributedboolean nullable
tag_idsstring[] nullable
countrystring nullable
selected_languagestring nullable
language_selection_sourcestring nullable
channelstring[] nullable
countriesstring[] nullable
countries_excludestring[] nullable
is_after_hoursboolean nullable
population_filtersstring[] nullable

Named conversation-population filters: business_hours, min_call_25s, real_customer_message, exclude_spam_test, dedupe_24h.

searchstring nullable
standard_filtersstring nullable
metric_filtersstring nullable
sort_bystring nullable
sort_order'asc' | 'desc' nullable
strictboolean

Reject filters this subject cannot apply with a 422, instead of returning a wider population and reporting them in ignored_filters.

voice_agent_idstring uuid nullable

Deprecated - use agent_id.

metric_idstring uuid nullable

Deprecated - use metric_filters.

metric_state'pass' | 'fail' | 'na' | 'not_run' | 'error' nullable

Deprecated - use metric_filters.

booking_intentboolean nullable

Deprecated - use has_booking_intent.

Response

Successful Response

totalinteger required

Rows matching the filters, in total_units.

limitinteger required

Page size actually applied.

offsetinteger required

Rows skipped.

has_moreboolean required

Whether another page exists.

total_unit'logical_call' | 'row'

What total counts. row for text, email and bookings. voice returns logical_call, because a transferred call is several legs in items but one call in total — so a caller that counts items will legitimately disagree with total.

applied_filtersstring[]

Filters that were compiled into the query.

pageinteger nullable

Deprecated — derive from offset/limit.

per_pageinteger nullable

Deprecated — use limit.

Changes

  • 91d72e252b6bRevision changes
    • info

      added the new optional query request parameter crm_record

    • info

      added the new optional query request parameter handling_outcomes

  • a9cebb28e243Revision changes
    • info

      added the new optional query request parameter channel

    • info

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

    • info

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