For the complete documentation index, see llms.txt. This page is also available as Markdown.

Analytics

List Flow Runs

get

List flow run logs matching the given filters.

Authorizations
OAuth2passwordRequired

Authorization header. Learn how to get it.

Token URL:
Path parameters
flow_idstringRequired
org_idstringRequired
Query parameters
pageintegerOptionalDefault: 0
page_sizeinteger · min: 1OptionalDefault: 25
start_datestring · date-time · nullableOptional
end_datestring · date-time · nullableOptional
user_idstring · nullableOptional
statestring · nullableOptional

Comma-separated list of statuses to filter by. Accepted values: PENDING, PAUSED, RESUMED, COMPLETED, FAILED, CANCELLED

Responses
200

Successful Response

application/json

Summary of a single workflow run.

run_idstring · uuidRequired
conversation_idstring · nullableOptional
datestring · date-timeRequired
is_flow_successfulboolean · nullableRequired
statestring · enum · nullableRequired

Enum representing the possible states of a workflow.

Possible values:
errorstring · nullableRequired
latencynumber · nullableRequired
total_tokensintegerRequired
user_idstring · nullableRequired
inputsstring · nullableRequired
outputsstring · nullableRequired
llmsstring · nullableRequired
feedbackstring · nullableRequired
run_typestring · enum · nullableOptional

How the run was initiated.

Possible values:
ran_by_typestring · enum · nullableOptional

Who authenticated the run.

Possible values:
ran_by_idstring · uuid · nullableOptional

ID of the user or API key that triggered the run.

ran_by_display_namestring · nullableOptional

Display name of the user (email) or API key (name) that triggered the run.

parent_run_idstring · uuid · nullableOptional

Run ID of the parent workflow for sub-workflow runs.

parent_project_idstring · nullableOptional

Project ID of the parent workflow for sub-workflow runs.

parent_project_namestring · nullableOptional

Name of the parent project for sub-workflow runs.

get/analytics/org/{org_id}/flows/{flow_id}

List Project Run Summary

get

Org-level analytics for all projects. List with the project run logs matching the given filters.

Authorizations
OAuth2passwordRequired

Authorization header. Learn how to get it.

Token URL:
Query parameters
pageintegerOptionalDefault: 0
page_sizeinteger · min: 1OptionalDefault: 25
start_datestring · date-time · nullableOptional
end_datestring · date-time · nullableOptional
Responses
200

Successful Response

application/json

A row with information about project run summary at the organization level.

project_idstringRequired
project_typestringRequired
project_namestringRequired
total_runsintegerRequired
total_errorsintegerRequired
total_tokensintegerRequired
total_usersintegerRequired
is_publishedbooleanRequired
public_ui_urlstring · nullableRequired
public_ui_typestring · nullableRequired
get/organizations/analytics/projects-run-summary

Last updated

Was this helpful?