Join Community
DocsDeveloper GuideAPI DocumentationChangelog
Analytics

Get Overview Stats

Returns a summary of key metrics for your project including conversations, messages, documents, links, visitor count, and feedback stats.

Returns a summary of key metrics for your project including conversations, messages, documents, links, visitor count, and feedback stats.

POST
/getStats

Authorization

bearerToken

AuthorizationBearer <token>

API token for YourGPT Public APIs. Create tokens in Settings > API Tokens in your YourGPT dashboard.

In: header

Request Body

application/json

project_uid*string

Project unique identifier.

from?string

Start date for filtering. Accepts YYYY-MM-DD, YYYY-MM-DD HH:mm:ss, or ISO format.

to?string

End date for filtering.

Response Body

application/json

application/json

curl -X POST "https://api.yourgpt.ai/chatbot/v1/getStats" \  -H "Content-Type: application/json" \  -d '{    "project_uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"  }'
{
  "type": "RXSUCCESS",
  "message": "Session detail",
  "data": [
    {
      "total_conversation": "2278",
      "total_messages": 2314,
      "total_documents": 29,
      "total_links": 68,
      "like": 11,
      "dislike": 27,
      "no_feedback": 6953,
      "session_count": "2278",
      "query_count": 2314,
      "visitor_count": 1164,
      "avg_message_conversation": 1
    }
  ]
}
{
  "type": "RXERROR",
  "message": "Invalid 'from' date format"
}