Solve Widget Analytics API

Base URL

https://dashboard-api.forethought.ai/analytics/solve/v0/conversations

Params

• start_timestamp : Start of range to query in UTC
• end_timestamp: End of range to query in UTC
• page_size: How many entries to pull (default 50, max 100)
• cursor: Passed in to continue a previous request

Authentication

• Bearer token, ask Forethought to generate a token.

Response Schema

Dictionary that contains the following keys:

• meta: Any metadata corresponding to this request. Currently this will contain a single key context_variable_mapping mapping to a dictionary from cv_id -> cv info .
• Example:

  "meta": {
     "context_variable_mapping": {
       "e831f70d_52dc_4fcf_8c3e_7d6e9d1d022c": {
         "context_variable_id": "e831f70d_52dc_4fcf_8c3e_7d6e9d1d022c",
  	 "display_name": "First Name",
  	   "created_date": "2023-11-20T17:41:38.492000" ,
             "modified_date": "2024-05-01T20:35:12.234000"
         },
        ...
     }
  }

• conversations: A list of conversations. Each conversation is a dictionary with the following fields. Conversations will be returned in increasing order of chat_start_time. At most page_size conversations will be returned.

      conversation_id: str
      channel: str | None = None
      chat_start_time: datetime
      last_executed_intent: str | None = None
      last_non_handoff_intent: str | None = None
      last_executed_intent_user_query: str | None = None
      deflected: bool | None = None
      generative_ai_used: bool | None = None
      chat_duration: int | None = None
      chat_handoff: bool | None = None
      helpdesk_ticket_id: str | None = None
      context_variables_used: dict[str, Any] | None = None
      chat_transcript: list[str] | None = None
      csat_score: float | None = None
      csat_feedback: list[str] | None = None
      csat_resolve: bool | None = None

• cursor: If not null, can be used to continue the request. If it is null, there are no more results in this time range.
  Example, to continue a request, call this endpoint:

  https://dashboard-api.forethought.ai/analytics/solve/v0/conversations?cursor=<cursor>

Frequently Asked Questions (FAQs)

Q: Is there a limit to the number of API calls I can make?
A: Yes. We allow up to 10 API calls per minute. 

Q: How often does the database refresh?
A: The underlying database that the API accesses refreshes every 60 minutes.