Join Community
DocsDeveloper GuideAPI DocumentationChangelog
Analytics

Get Top Intents

Returns the most common user intents detected in conversations, sorted by frequency.

Returns the most common user intents detected in conversations, sorted by frequency.

POST
/getTopIntents

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. Accepts YYYY-MM-DD, YYYY-MM-DD HH:mm:ss, or ISO format.

to?string

End date.

orderBy?string

Sort order.

Default"DESC"
Value in"ASC" | "DESC"
limit?integer

Results per page.

page?integer

Page number.

Default1

Response Body

application/json

curl -X POST "https://api.yourgpt.ai/chatbot/v1/getTopIntents" \  -H "Content-Type: application/json" \  -d '{    "project_uid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"  }'
{
  "type": "RXSUCCESS",
  "message": "Session detail",
  "data": [
    {
      "intent": "greetings",
      "count": "572"
    }
  ]
}