Skip to main content
GET
/
api
/
v2
/
reporting
/
chat-sessions
/
Get company chat sessions report
curl --request GET \
  --url https://paradigm.lighton.ai/api/v2/reporting/chat-sessions/ \
  --header 'Authorization: Bearer <token>'
{
  "metadata": {
    "sessions_count": {
      "description": "<string>",
      "unit": "<string>"
    },
    "model_responses_with_docs_count": {
      "description": "<string>",
      "unit": "<string>"
    },
    "unique_models_count": {
      "description": "<string>",
      "unit": "<string>"
    },
    "average_session_length": {
      "description": "<string>",
      "unit": "<string>"
    },
    "user_queries_count": {
      "description": "<string>",
      "unit": "<string>"
    },
    "model_responses_count": {
      "description": "<string>",
      "unit": "<string>"
    },
    "last_model_response_date": {
      "description": "<string>",
      "unit": "<string>"
    }
  },
  "reporting": [
    {
      "company": {
        "name": "<string>",
        "id": 123
      },
      "dates": [
        {
          "date": "2023-12-25",
          "sessions": {
            "sessions_count": 123,
            "unique_models_count": 123,
            "average_session_length": 123
          },
          "chats": {
            "user_queries_count": 123,
            "model_responses_with_docs_count": 123,
            "model_responses_count": 123,
            "last_model_response_date": "2023-11-07T05:31:56Z"
          }
        }
      ]
    }
  ],
  "metadata_agent": {
    "threads_count": {
      "description": "<string>",
      "unit": "<string>"
    },
    "unique_models_count": {
      "description": "<string>",
      "unit": "<string>"
    },
    "average_thread_length": {
      "description": "<string>",
      "unit": "<string>"
    },
    "user_queries_count": {
      "description": "<string>",
      "unit": "<string>"
    },
    "model_responses_with_docs_count": {
      "description": "<string>",
      "unit": "<string>"
    },
    "model_responses_count": {
      "description": "<string>",
      "unit": "<string>"
    },
    "last_model_response_date": {
      "description": "<string>",
      "unit": "<string>"
    }
  },
  "reporting_agents": [
    {
      "company": {
        "name": "<string>",
        "id": 123
      },
      "dates": [
        {
          "date": "2023-12-25",
          "threads": {
            "threads_count": 123,
            "unique_models_count": 123,
            "average_thread_length": 123
          },
          "agents": {
            "user_queries_count": 123,
            "model_responses_with_docs_count": 123,
            "model_responses_count": 123,
            "last_model_response_date": "2023-11-07T05:31:56Z"
          }
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer token authentication

Query Parameters

company_id
integer

The unique identifier of the company (optional for admin users).

end_date
string<date>

The end date for the report (optional, defaults to today).

start_date
string<date>
required

The start date for the report.

Response

Successful response

metadata
object
required
reporting
object[]
required
metadata_agent
object
required
reporting_agents
object[]
required
I