Toolzz AI
- Introduction
- Planos
- ChatService
- Toolzz Analytics
- Introduction
- DatasetItems
- DatasetRunItems
- Datasets
- Health
- Traces
- Session
- Projects
- Prompt
- Metrics
- Media
- Score
- ScoreConfig
- Models
- Observations
- Comments
- Kratos
Get a list of observations
Endpoint to Get a list of observations on toolzz analytics
{
"data": [
{
"id": "<string>",
"traceId": "<string>",
"type": "<string>",
"name": "<string>",
"startTime": {},
"endTime": {},
"completionStartTime": {},
"model": "<string>",
"modelParameters": {
"property1": "<string>",
"property2": "<string>"
},
"input": null,
"version": "<string>",
"metadata": null,
"output": null,
"usage": {
"input": 123,
"output": 123,
"total": 123,
"unit": "<string>",
"inputCost": 123,
"outputCost": 123,
"totalCost": 123
},
"level": "<string>",
"statusMessage": "<string>",
"parentObservationId": "<string>",
"promptId": "<string>",
"usageDetails": {
"property1": 123,
"property2": 123
},
"costDetails": {
"property1": 123,
"property2": 123
},
"promptName": "<string>",
"promptVersion": 123,
"modelId": "<string>",
"inputPrice": 123,
"outputPrice": 123,
"totalPrice": 123,
"calculatedInputCost": 123,
"calculatedOutputCost": 123,
"calculatedTotalCost": 123,
"latency": 123,
"timeToFirstToken": 123
}
],
"meta": {
"page": 123,
"limit": 123,
"totalItems": 123,
"totalPages": 123
}
}Page number, starts at 1 (nullable).
Limit of items per page. Reduce the size if API issues occur (nullable).
Optional filter for a specific name (nullable).
Optional filter for a specific user ID (nullable).
Optional filter for a specific type (nullable).
Optional filter for a specific trace ID (nullable).
Optional filter for a specific parent observation ID (nullable).
Retrieve only observations with a start_time on or after this datetime (ISO 8601).
Retrieve only observations with a start_time before this datetime (ISO 8601).
Optional filter to include only observations with a certain version (nullable).
Response Description
Below you will see the description of the Get a list of observations response
List of observation data.
Unique identifier of the observation.
Identifier of the trace associated with the observation.
Type of the observation.
Name of the observation.
Start time of the observation.
End time of the observation.
Time when the completion started.
Model used in the observation.
Input data for the observation (nullable).
Version of the observation.
Metadata associated with the observation (nullable).
Output data from the observation (nullable).
Usage metrics.
Input usage count.
Output usage count.
Total usage count.
Unit of measurement (e.g., CHARACTERS).
Cost for input usage.
Cost for output usage.
Total cost of the usage.
Log level of the observation (e.g., DEBUG).
Status message of the observation.
Parent observation ID, if applicable.
Prompt ID used in the observation.
Name of the prompt used.
Version of the prompt used.
Identifier of the model used.
Price for input usage.
Price for output usage.
Total price for the observation.
Calculated cost for input.
Calculated cost for output.
Calculated total cost.
Latency of the observation.
Time taken to generate the first token.
Code Response
Exemples of Response Code
Request Successful Response
Request Failure
{
"data": [
{
"id": "<string>",
"traceId": "<string>",
"type": "<string>",
"name": "<string>",
"startTime": {},
"endTime": {},
"completionStartTime": {},
"model": "<string>",
"modelParameters": {
"property1": "<string>",
"property2": "<string>"
},
"input": null,
"version": "<string>",
"metadata": null,
"output": null,
"usage": {
"input": 123,
"output": 123,
"total": 123,
"unit": "<string>",
"inputCost": 123,
"outputCost": 123,
"totalCost": 123
},
"level": "<string>",
"statusMessage": "<string>",
"parentObservationId": "<string>",
"promptId": "<string>",
"usageDetails": {
"property1": 123,
"property2": 123
},
"costDetails": {
"property1": 123,
"property2": 123
},
"promptName": "<string>",
"promptVersion": 123,
"modelId": "<string>",
"inputPrice": 123,
"outputPrice": 123,
"totalPrice": 123,
"calculatedInputCost": 123,
"calculatedOutputCost": 123,
"calculatedTotalCost": 123,
"latency": 123,
"timeToFirstToken": 123
}
],
"meta": {
"page": 123,
"limit": 123,
"totalItems": 123,
"totalPages": 123
}
}