Skip to content
API Reference
/
ai-analytics
/
ai_analytics_orgs_users_observations_retrieve

ibl-data-manager (3.59.0-ai-plus)

API for iblai

Download OpenAPI description
ibl.json
ibl.yaml
Languages
Servers
Mock server

https://docs.ibl.ai/_mock/apis/ibl/

https://base.manager.iblai.app/

ai-account

Operations

ai-analytics

Operations

ai_analytics_orgs_users_observations_list

Request

Viewset for retrieving and listing Langfuse observations.

This viewset provides read-only access to Langfuse observations data for platform admins. Observations represent detailed tracking of AI model interactions and responses.

Permissions:

  • Restricted to platform administrators only
Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
limitinteger

Number of results to return per page.

offsetinteger

The initial index from which to return the results.

orderingstring

Which field to use when ordering the results.

searchstring

A search term.

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/observations/?limit=0&offset=0&ordering=string&search=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
countintegerrequired
Example: 123
nextstring or null(uri)
Example: "http://api.example.org/accounts/?offset=400&limit=100"
previousstring or null(uri)
Example: "http://api.example.org/accounts/?offset=200&limit=100"
resultsArray of objects(Observation)required
results[].​idstringrequired
results[].​trace_idstringrequired
results[].​typestringrequired
results[].​parent_observation_idstring or null
results[].​start_timestring(date-time)required
results[].​end_timestring or null(date-time)
results[].​namestringrequired
results[].​metadataanyrequired
results[].​levelstringrequired
results[].​status_messagestring or null
results[].​versionstring or null
results[].​inputstring or null
results[].​outputstring or null
results[].​provided_model_namestring or null
results[].​internal_model_idstring or null
results[].​model_parametersstring or null
results[].​provided_usage_detailsstringrequired
results[].​usage_detailsstringrequired
results[].​provided_cost_detailsstringrequired
results[].​cost_detailsstringrequired
results[].​total_coststring or null(decimal)^-?\d{0,6}(?:\.\d{0,12})?$
results[].​completion_start_timestring or null(date-time)
results[].​prompt_idstring or null
results[].​prompt_namestring or null
results[].​prompt_versioninteger or null[ 0 .. 65535 ]
results[].​created_atstring(date-time)read-onlyrequired
results[].​updated_atstring(date-time)
results[].​event_tsstring(date-time)required
results[].​is_deletedinteger[ 0 .. 255 ]required
Response
application/json
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    { … }
  ]
}

ai_analytics_orgs_users_observations_retrieve

Request

Viewset for retrieving and listing Langfuse observations.

This viewset provides read-only access to Langfuse observations data for platform admins. Observations represent detailed tracking of AI model interactions and responses.

Permissions:

  • Restricted to platform administrators only
Security
PlatformApiKeyAuthentication
Path
idstringrequired
orgstringrequired
user_idstringrequired
curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/observations/{id}/' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstringrequired
trace_idstringrequired
typestringrequired
parent_observation_idstring or null
start_timestring(date-time)required
end_timestring or null(date-time)
namestringrequired
metadataanyrequired
levelstringrequired
status_messagestring or null
versionstring or null
inputstring or null
outputstring or null
provided_model_namestring or null
internal_model_idstring or null
model_parametersstring or null
provided_usage_detailsstringrequired
usage_detailsstringrequired
provided_cost_detailsstringrequired
cost_detailsstringrequired
total_coststring or null(decimal)^-?\d{0,6}(?:\.\d{0,12})?$
completion_start_timestring or null(date-time)
prompt_idstring or null
prompt_namestring or null
prompt_versioninteger or null[ 0 .. 65535 ]
created_atstring(date-time)read-onlyrequired
updated_atstring(date-time)
event_tsstring(date-time)required
is_deletedinteger[ 0 .. 255 ]required
Response
application/json
{
  "id": "string",
  "trace_id": "string",
  "type": "string",
  "parent_observation_id": "string",
  "start_time": "2019-08-24T14:15:22Z",
  "end_time": "2019-08-24T14:15:22Z",
  "name": "string",
  "metadata": null,
  "level": "string",
  "status_message": "string",
  "version": "string",
  "input": "string",
  "output": "string",
  "provided_model_name": "string",
  "internal_model_id": "string",
  "model_parameters": "string",
  "provided_usage_details": "string",
  "usage_details": "string",
  "provided_cost_details": "string",
  "cost_details": "string",
  "total_cost": "string",
  "completion_start_time": "2019-08-24T14:15:22Z",
  "prompt_id": "string",
  "prompt_name": "string",
  "prompt_version": 65535,
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "event_ts": "2019-08-24T14:15:22Z",
  "is_deleted": 255
}

ai_analytics_orgs_users_overview_summary_retrieve

Request

Retrieve an overview of key analytics metrics.

This endpoint returns a comprehensive overview of key analytics metrics for an organization, including:

  • Conversation volume: Total sessions and month-over-month change
  • Users: Total unique users and month-over-month change
  • Topics: Total unique topics and month-over-month change
  • User ratings: Total ratings and month-over-month change

Results can be filtered by mentor.

Args: request: The HTTP request containing filter query parameters. org: Organization key identifier. user_id: User identifier (not used in the implementation).

Returns: Response: Overview of key analytics metrics with month-over-month changes.

Raises: NotFound: If the specified organization does not exist.

Query Parameters: mentor_id (str): Filter analytics by mentor unique ID.

Security
PlatformApiKeyAuthentication
Path
orgstringrequired
user_idstringrequired
Query
group_bystringnon-empty
Default "day"
mentor_idstring

Filter analytics by mentor unique ID

curl -i -X GET \
  'https://docs.ibl.ai/_mock/apis/ibl/api/ai-analytics/orgs/{org}/users/{user_id}/overview-summary/?group_by=day&mentor_id=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
conversation_volumeobject(MetricChange)required
conversation_volume.​totalintegerrequired
conversation_volume.​changenumber(double)required
usersobject(MetricChange)required
users.​totalintegerrequired
users.​changenumber(double)required
topicsobject(MetricChange)required
topics.​totalintegerrequired
topics.​changenumber(double)required
user_ratingobject(MetricChange)required
user_rating.​totalintegerrequired
user_rating.​changenumber(double)required
Response
application/json
{
  "conversation_volume": {
    "total": 450,
    "change": 12.5
  },
  "users": {
    "total": 120,
    "change": 8.3
  },
  "topics": {
    "total": 35,
    "change": 5.2
  },
  "user_rating": {
    "total": 280,
    "change": 15.7
  }
}

ai-bot

Operations

ai-finetuning

Operations

ai-index

Operations

ai-marketing

Operations

ai-media

Operations

ai-mentor

Operations

ai-prompt

Operations

career

Operations

catalog

Operations

core

Operations

credentials

Operations

features

Operations

media

Operations

notifications

Operations

scim

Operations

commerce

Operations

recommendations

Operations

reports

Operations

skills

Operations
Copyright © ibl.ai | support@iblai.zendesk.com