Solve Widget Analytics API

Base URL

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

Params

• start_timestamp : Start of range to query in UNIX
• end_timestamp: End of range to query in UNIX
• page_size: How many entries to pull (default 50, max 250)
• 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:

• 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>

Metadata

Base URL

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

Authentication

• Bearer token, same as the other URL
  

Response Schema

Dictionary that contains the following keys:

• context variables: A list of all context variables with ID, display name, created date, and last modified date
  

  {
      "context_variables": [
          {
              "context_variable_id": "14729fe9-0b7c-4446-8ae6-57b440b5c17e",
              "display_name": "First Name",
              "created_date": "2023-11-20T17:41:38.492000",
              "modified_date": "2024-05-01T20:35:12.234000"
          },
          ...
      ]
  }
  

Frequently Asked Questions (FAQs)

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

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