AGagnost
Dashboard

Get user stories (conversations)

Changed on
post/dashboard/api/user-stories

Request

  • Base URL
    https://api.agnost.ai
  • URL
    https://api.agnost.ai/dashboard/api/user-stories
  • Auth
    • HTTP bearer and API key in header x-org-id
    • or API key in header x-api-key

Request body

time_range'1min' | '1h' | '1d' | '1w' | '1m' | 'all'
pageinteger
page_sizeinteger

Conversations, groups, or users per page. The dashboard requests 15 distinct group values at a time.

searchstring

Case-insensitive identifier search used to load matching search options.

search_field'user_id' | 'conversation_id' | 'original_conversation_id' | 'user_email' | 'group_value'

Structured identifier selected from User Stories search. Grouped requests accept only group_value.

search_valuestring

Exact value for the selected search field.

sort'newest' | 'oldest'
exclude_ioboolean

Omits event input/output payloads when true.

allow_limited_previewboolean

Dashboard-only flag for a small access-limited preview; programmatic clients should leave false.

sentiment_idsstring[]

Restricts conversations to events matching any selected intent id.

sop_idsstring[]

Restricts conversations to events matching any selected violation id.

group_level'groups' | 'users' | 'conversations'

When group_by is present, returns metadata groups by default, users within group_value, or conversations for group_user_key.

group_valuestring

Required when group_level is users or conversations.

group_user_keystring

Opaque user key returned by grouped users; required for group_level: conversations.

Response

Recent conversations, metadata groups, or users within a metadata group

conversationsobject[]
group_valuestring
overlappingboolean

Metadata arrays may place a conversation in more than one group.

pageinteger
page_sizeinteger
total_pagesinteger
has_moreboolean

True when one lookahead row proves that another page is available.

partial_databoolean

True when optional hydration or enrichment failed and the returned page is incomplete.

Changes