Usage

Get usage metrics

Returns usage metrics including total conversations and knowledge base entries across all replicas owned by the authenticated user.

get/v1/users/me/usage

Request

  • Base URL: https://api.sensay.io
  • URL: https://api.sensay.io/v1/users/me/usage
  • Auth: API key in header X-ORGANIZATION-SECRET and API key in header X-USER-ID and API key in header X-USER-ID-TYPE

Headers

X-API-Versionstring
Example:2025-03-25

Response

Usage metrics

successtrue required

Indicates the request was successful

Example response

{
  "conversations": {
    "currentMonthByReplica": {
      "14e42ac9-369e-432c-97ab-7e7250a779b7": 5,
      "5ee26dc3-49d2-43a8-a45b-25a1c78382cd": 12,
      "9c0cf332-387e-4067-96e5-007c1f03e0d4": 3
    }
  },
  "knowledgeBaseEntries": {
    "total": 67,
    "byReplica": {
      "14e42ac9-369e-432c-97ab-7e7250a779b7": 25,
      "5ee26dc3-49d2-43a8-a45b-25a1c78382cd": 32,
      "9c0cf332-387e-4067-96e5-007c1f03e0d4": 10
    }
  },
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.