Skip to main content
POST
/
api
/
admin
/
histories
Retrieve conversation histories for admin users
curl --request POST \
  --url https://pria.praxislxp.com/api/admin/histories \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "institution": "<string>",
  "usersearch": "<string>",
  "limitsearch": 123
}'
{
  "success": true,
  "data": [
    {
      "_id": "<string>",
      "credits": 123,
      "usage": 123,
      "cached": 123,
      "completion": 123,
      "latencyMs": 123,
      "input": "<string>",
      "inputs": [
        "<string>"
      ],
      "output": "<string>",
      "outputs": [
        "<string>"
      ],
      "success": true,
      "user": {
        "_id": "<string>",
        "email": "jsmith@example.com",
        "fname": "<string>",
        "lname": "<string>",
        "accountType": "<string>",
        "lxp_user_id": 123,
        "picture": "<string>",
        "status": "<string>",
        "lxp_user_type": 123,
        "lxp_partner_id": 123,
        "lxp_partner_name": "<string>",
        "lxp_role_id": 123,
        "lxp_role_name": "<string>",
        "credits": 123,
        "creditsUsed": 123,
        "plan": "<string>",
        "institution": {
          "_id": "<string>",
          "name": "<string>",
          "picture": "<string>",
          "credits": 123,
          "creditsUsed": 123,
          "creditsAwarded": 123,
          "status": "active",
          "publicId": "<string>",
          "publicAuthorizedUrls": [
            "<string>"
          ],
          "ainame": "<string>",
          "contactEmail": "<string>",
          "poolCredits": true,
          "created": "2023-11-07T05:31:56Z",
          "conversationModel": "<string>",
          "account": {
            "_id": "<string>",
            "name": "<string>"
          },
          "maxCompletionTokens": 123,
          "creditsTotal": 123,
          "creditsUsagePct": 123,
          "id": "<string>",
          "displayAgentDetails": true
        },
        "remember_history_count": 123,
        "created": "2023-11-07T05:31:56Z"
      },
      "institution": {
        "_id": "<string>",
        "name": "<string>",
        "picture": "<string>",
        "credits": 123,
        "creditsUsed": 123,
        "creditsAwarded": 123,
        "status": "active",
        "publicId": "<string>",
        "publicAuthorizedUrls": [
          "<string>"
        ],
        "ainame": "<string>",
        "contactEmail": "<string>",
        "poolCredits": true,
        "created": "2023-11-07T05:31:56Z",
        "conversationModel": "<string>",
        "account": {
          "_id": "<string>",
          "name": "<string>"
        },
        "maxCompletionTokens": 123,
        "creditsTotal": 123,
        "creditsUsagePct": 123,
        "id": "<string>",
        "displayAgentDetails": true
      },
      "status": "<string>",
      "query_duration_ms": 123,
      "course_id": 123,
      "course_name": "<string>",
      "assistant": "<string>",
      "conversation_model": "<string>",
      "tools": [
        {
          "id": "<string>",
          "name": "<string>",
          "responseLength": 123,
          "responseDurationMs": 123,
          "success": true,
          "_id": "<string>"
        }
      ],
      "created": "2023-11-07T05:31:56Z",
      "__v": 123
    }
  ]
}

Authorizations

Authorization
string
header
required

JWT token passed in x-access-token header

Body

application/json
institution
string

Institution ID to filter histories

usersearch
string

Search term to filter by user

limitsearch
number

Maximum number of results to return

Response

Successfully retrieved conversation histories

success
boolean
data
object[]