Get Workflow Summary Statistics

GET

/api/v2/analytics/workflows/summary

Ranks the organization's workflows by the queries they answered during the date window, with their votes and the agents their responses used.

Covers the caller's organization and is open to every member of it. A call made with an APIM subscription key covers the key's organization instead.

Returns:

The top workflows under data.summary, or one entry per bucket with time_series=true.

Current Version:

2.0.0

Changelog:

2.0.0: Initial version.

Request

Query Params

Header Params

Responses

🟢200

application/json

Top workflows first. Deleted workflows and deleted responses are left out.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠405

🔴500

🔴503

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff 'https:///api/v2/analytics/workflows/summary?bucket_type=&days=&end_date=&limit=&start_date=&time_series=&type=&workflow_id=' \
--header 'Organization-Id;' \
--header 'Ocp-Apim-Subscription-Key: ' \
--header 'Authorization: Bearer '

Response Example

200 - Standard Response

{
    "success": true,
    "message": "Workflow summary statistics retrieved successfully",
    "data": {
        "summary": [
            {
                "workflow_id": 10,
                "workflow_name": "Research Assistant",
                "query_count": 85,
                "upvote_count": 30,
                "downvote_count": 3,
                "agents_used": {
                    "total_responses_with_agents": 80,
                    "total_responses_without_agents": 5,
                    "agents": [
                        {
                            "agent_id": 200,
                            "agent_name": "Research Bot",
                            "usage_count": 80
                        }
                    ]
                }
            }
        ]
    }
}

Get Vote Count Data

Get Query Count Data