Query Conversations

/**
 * Response body for QueryConversations query endpoint
 */
export interface Response {
  /**
   * Status of the response
   */
  status: "ok";
  data: QueryConversationsResponseData;
}
/**
 * Data object containing QueryConversations query results and pagination information
 */
export interface QueryConversationsResponseData {
  result: ConversationsResultItem[];
  /**
   * Total number of results matching the query
   */
  total: number;
  /**
   * Number of results per page
   */
  pageSize: number;
  /**
   * Number of results in the current response
   */
  count: number;
}
export interface ConversationsResultItem {
  id?: string;
  userMessageCount?: number;
  organizationId?: string | null;
  projectId?: string | null;
  integrationId?: string | null;
  firstMessageTime?: string;
  type?: ("openai" | "support_ticket" | "support_copilot") | null;
  /**
   * A customizable collection of custom properties or attributes.
   */
  properties?: {
    [k: string]: unknown;
  } | null;
  /**
   * A customizable collection of custom properties or attributes. Some properties have first class support for the Inkeep Portal or Widget and are noted in the description.
   */
  userProperties?: {
    /**
     * The unique identifier for the user. This value is sent by the inkeep widget.
     */
    id?: string | number | null;
    /**
     * The type of identification for the user. This value is sent by the inkeep widget.
     */
    identificationType?: string | null;
    /**
     * The unique identifier for the user. This value is sent by the Inkeep Support Agent Copilot. This value is used to create the graphs on the Inkeep Portal.
     */
    userId?: string | number | null;
    /**
     * The name of the support agent assigned to the user. This value is sent by the Inkeep Support Agent Copilot. This value is used to create the graphs on the Inkeep Portal.
     */
    supportAgentName?: string | null;
    [k: string]: unknown;
  } | null;
  sum?: number;
  count?: number;
  avg?: number;
  min?: number;
  max?: number;
  id_hour?: string;
  id_day?: string;
  id_week?: string;
  id_month?: string;
  userMessageCount_hour?: string;
  userMessageCount_day?: string;
  userMessageCount_week?: string;
  userMessageCount_month?: string;
  organizationId_hour?: string;
  organizationId_day?: string;
  organizationId_week?: string;
  organizationId_month?: string;
  projectId_hour?: string;
  projectId_day?: string;
  projectId_week?: string;
  projectId_month?: string;
  integrationId_hour?: string;
  integrationId_day?: string;
  integrationId_week?: string;
  integrationId_month?: string;
  firstMessageTime_hour?: string;
  firstMessageTime_day?: string;
  firstMessageTime_week?: string;
  firstMessageTime_month?: string;
  type_hour?: string;
  type_day?: string;
  type_week?: string;
  type_month?: string;
  properties_hour?: string;
  properties_day?: string;
  properties_week?: string;
  properties_month?: string;
  userProperties_hour?: string;
  userProperties_day?: string;
  userProperties_week?: string;
  userProperties_month?: string;
  sum_id?: number;
  sum_userMessageCount?: number;
  sum_organizationId?: number;
  sum_projectId?: number;
  sum_integrationId?: number;
  sum_firstMessageTime?: number;
  sum_type?: number;
  sum_properties?: number;
  sum_userProperties?: number;
  count_id?: number;
  count_userMessageCount?: number;
  count_organizationId?: number;
  count_projectId?: number;
  count_integrationId?: number;
  count_firstMessageTime?: number;
  count_type?: number;
  count_properties?: number;
  count_userProperties?: number;
  avg_id?: number;
  avg_userMessageCount?: number;
  avg_organizationId?: number;
  avg_projectId?: number;
  avg_integrationId?: number;
  avg_firstMessageTime?: number;
  avg_type?: number;
  avg_properties?: number;
  avg_userProperties?: number;
  min_id?: number;
  min_userMessageCount?: number;
  min_organizationId?: number;
  min_projectId?: number;
  min_integrationId?: number;
  min_firstMessageTime?: number;
  min_type?: number;
  min_properties?: number;
  min_userProperties?: number;
  max_id?: number;
  max_userMessageCount?: number;
  max_organizationId?: number;
  max_projectId?: number;
  max_integrationId?: number;
  max_firstMessageTime?: number;
  max_type?: number;
  max_properties?: number;
  max_userProperties?: number;
  "sum_properties.userId"?: number;
  "sum_properties.supportAgentName"?: number;
  "sum_userProperties.userId"?: number;
  "sum_userProperties.supportAgentName"?: number;
  "count_properties.userId"?: number;
  "count_properties.supportAgentName"?: number;
  "count_userProperties.userId"?: number;
  "count_userProperties.supportAgentName"?: number;
  "countDistinct_properties.userId"?: number;
  "countDistinct_properties.supportAgentName"?: number;
  "countDistinct_userProperties.userId"?: number;
  "countDistinct_userProperties.supportAgentName"?: number;
  "avg_properties.userId"?: number;
  "avg_properties.supportAgentName"?: number;
  "avg_userProperties.userId"?: number;
  "avg_userProperties.supportAgentName"?: number;
  "min_properties.userId"?: number;
  "min_properties.supportAgentName"?: number;
  "min_userProperties.userId"?: number;
  "min_userProperties.supportAgentName"?: number;
  "max_properties.userId"?: number;
  "max_properties.supportAgentName"?: number;
  "max_userProperties.userId"?: number;
  "max_userProperties.supportAgentName"?: number;
  "properties.userId"?: string | null;
  "properties.supportAgentName"?: string | null;
  "userProperties.userId"?: string | null;
  "userProperties.supportAgentName"?: string | null;
}