Analytics API

The Analytics API provides access to the data and metrics available in the Dashboard, Usage Dashboard, User tab in Adoption Dashboard, and the Platform tab in Adoption Dashboard.

Check the generic variables needed to use the API.

Endpoints

Authentication

All endpoints require authentication using one of the following:

• Authorization: Bearer $GEAI_APITOKEN
• Authorization: Bearer $OAuth_accesstoken

For $OAuth_accesstoken, you must also include the header: ProjectId: $PROJECT_ID (otherwise, this and OrganizationId:$ORGANIZATION_ID headers are optional) Some endpoints may require additional headers such as:

• Content-Type: application/json

GET /analytics/lab/agents-created-and-modified

Returns the total number of Agents created or modified, supporting Agent lifecycle and development activity tracking.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/lab/agents-created-and-modified
• Body: Empty

Response

{
  "createdAgents":  integer, // number of Agents created.
  "modifiedAgents": integer// number of Agents modified.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/lab/agents-created-and-modified?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/lab/agents-created-and-modified-per-day

Returns the number of created and modified Agents per day.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/lab/agents-created-and-modified-per-day
• Body: Empty

Response

{
  "agents": [
       {
      "date": "string", // date in YYYY-MM-DD.
      "created": integer, // Agents created on the date.
      "Modified": integer // Agents modified on the date.
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/lab/agents-created-and-modified-per-day?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/lab/flows-created-and-modified

Returns the total number of flows created or modified, supporting flow lifecycle and adoption tracking.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/lab/flows-created-and-modified
• Body: Empty

Response

{
  "createdFlows": integer, // number of Flows created.
  "modifiedFlows": integer // number of flows modified.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/lab/flows-created-and-modified?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/lab/flows-created-and-modified-per-day

Returns the number of created and modified flows per day.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/lab/flows-created-and-modified-per-day
• Body: Empty

Response

{
  "data": [
    {
      "date": "string",                                     // Date in YYYY-MM-DD.
      "created": integer,                       // Flows created on the date.
      "modified": integer                      // Flows modified on the date.
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/lab/flows-created-and-modified-per-day?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/lab/processes-created-and-modified

Provides the total number of Agentic Processes created or modified, supporting process management and workflow analysis.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/lab/processes-created-and-modified
• Body: Empty

Response

{
  "createdProcesses": integer,                              // Number of Agentic Processes created.
  "modifiedProcesses": integer                             // Number of Agentic Processes modified.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/lab/processes-created-and-modified?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/lab/processes-created-and-modified-per-day

Returns the number of created and modified Agentic Processes per day in the selected period.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/lab/processes-created-and-modified-per-day
• Body: Empty

Response

{
  "processes": [
    {
      "created": integer,                             // Agentic Processes created on the date.
      "date": "string",                               // Date in YYYY-MM-DD.
      "modified": integer                           // Agentic Processes modified on the date.
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/lab/processes-created-and-modified-per-day?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/lab/projects-created

Returns the total number of projects created, supporting platform adoption and growth analysis.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/lab/projects-created
• Body: Empty

Response

{
  "createdProjects": integer                                     // number of projects created in the period.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/lab/projects-created?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/lab/projects-created-per-day

Returns the number of created projects per day.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/lab/projects-created-per-day
• Body: Empty

Response

{
  "projects": [
    {
      "date": "string",                                  // Date in YYYY-MM-DD.
      "created": integer                      // Number of projects created on the specific date.
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/lab/projects-created-per-day?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/activity-per-agent

Returns the cost and number of requests and API Tokens grouped by Agent and model, supporting Agent-level usage and cost analysis.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/activity-per-agent
• Body: Empty

Response

{
  "activity": [
    {
      "agentName": "string", // Agent name.
      "model": "string",     // Model name.
      "totalCost": number,  // Total cost for the Agent/model
      "totalRequests": integer // Number of requests for the Agent/model.
"totalTokens": integer    // Number of tokens consumed by the Agent.
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/activity-per-agent?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/activity-per-user

Returns the cost, number of requests, and API Tokens grouped by user, Agent, and model, enabling detailed user activity and resource usage analysis.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/activity-per-user
• Body: Empty

Response

{
  "activity": [
    {
      "agentName": "string",                                     // Name (if not available, returns N/D).
      "modelName": "string",                                   // If not available, returns N/D.
      "totalCost": number,                                       // Expressed in USD.
      "totalRequests": integer,                                 // Total number of requests for this user.
      "totalTokens": integer,                                    // Tokens consumed by the user.
      "user": "string"                                             // Typically user email.
    },
    {
      "agentName": "string",
      "modelName": "string",
      "totalCost": number,
      "totalRequests": integer,
      "totalTokens": integer,
      "user": "string"
    },
    {
      "agentName": "string",
      "modelName": "string",
      "totalCost": number,
      "totalRequests": integer,
      "totalTokens": integer,
      "user": "string"
    },
    {
      "agentName": "string",
      "modelName": "string",
      "totalCost": number,
      "totalRequests": integer,
      "totalTokens": integer,
      "user": "string"
    },
    {
      "agentName": "string",
      "modelName": "string",
      "totalCost": number,
      "totalRequests": integer,
      "totalTokens": integer,
      "user": "string"
    },
    {
      "agentName": "string",
      "modelName": "string",
      "totalCost": number,
      "totalRequests": integer,
      "totalTokens": integer,
      "user": "string"
    },
    {
      "agentName": "string",
      "modelName": "string",
      "totalCost": number,
      "totalRequests": integer,
      "totalTokens": integer,
      "user": "string"
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/activity-per-user?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/agent-usage-per-organization-and-project

Returns the cost, number of requests, and token usage grouped by organization, project, Agent, user, API Token, and model, enabling multi-level usage analysis.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/agent-usage-per-organization-and-project
• Body: Empty

Response

{
  "agentUsage": [
    {
      "agent": "string",                                       // Agent name, if not found, will return N/D.
      "apiToken": "string",                                    // API Token name.
      "inputTokens": integer,                               // Total number of in Input Tokens.
      "model": "string",                                     // Model used by Agent.
      "organization": "string",                              // Organization name. 
      "outputTokens": integer,                                // Total number of Output Tokens.
      "project": "string",                                   // Project name.
      "totalCost": number,                                   // Expressed in USD.
      "totalRequests": integer,                           // Total number of requests.
      "totalTokens": integer,                              // Total number of Tokens.
      "user": "string"                                      // User name.
    },
    {
      "agent": "string",
      "apiToken": "string",
      "inputTokens": integer,
      "model": "string",
      "organization": "string",
      "outputTokens": integer,
      "project": "string",
      "totalCost": number,
      "totalRequests": integer,
      "totalTokens": integer,
      "user": "string"
    },
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/agent-usage-per-organization-and-project?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/agent-usage-per-project

Returns the cost, number of requests, and token usage grouped by project, Agent, API Token, user, and model, supporting project-level resource tracking.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/agent-usage-per-project
• Body: Empty

Response

{
  "agentUsage": [
    {
      "agent": "string", // Agent name, If not found, returns N/D.
      "apiToken": "string",// API Token name.
      "inputTokens": integer,// Total number of Input Tokens.
      "model": "string", // Model name.
      "outputTokens": integer,           // Total number of Output Tokens.
      "project": "string",// Expressed in USD.
      "totalCost": number,// Expressed in USD.
      "totalRequests": integer,// Total requests for this Agent.
      "totalTokens": integer,// Total tokens consumed by this Agent.
      "user": "string"// Typically identified by email address.
    },
    {
      "agent": "string",
      "apiToken": "string",
      "inputTokens": integer,
      "model": "string",
      "outputTokens": integer,
      "project": "string",
      "totalCost": number,
      "totalRequests": integer,
      "totalTokens": integer,
      "user": "string"
    },
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/agent-usage-per-project?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/agent-usage-per-user

Returns the cost, number of requests, and token usage grouped by user, supporting detailed user-level resource and billing analysis.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/agent-usage-per-user
• Body: Empty

Response

{
  "agentUsage": [
    {
      "totalCost": number,                                 // Expressed in USD.
      "totalRequests": integer,                          // Total requests made by users for this Agent.
      "totalTokens": integer,                             // Total tokens consumed by this Agent.
      "user": "string"                                      // User’s ID, typically email (repeats one entry per user)
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/agent-usage-per-user?startDate=2024-01-01&endDate=2024-01-31&agentName=" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/average-cost-per-request

Returns the average cost incurred per request during the selected period. Expressed in USD.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/average-cost-per-request
• Body: Empty

Response

{
"averageCostPerRequest": number                               // Expressed in USD
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/average-cost-per-request?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/average-cost-per-user

Returns the average cost attributed to each user, supporting identification of high-cost users and optimization of user-level resource allocation.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/average-cost-per-user
• Body: Empty

Response

{
  "averageCost": number                                                   // average cost per user (USD).
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/average-cost-per-user?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/average-cost-per-user-per-date

Provides the average cost per user for each date, supporting temporal analysis of user spending patterns.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/average-cost-per-user-per-date
• Body: Empty

Response

{
  "averageCostPerUser": [
    {
      "averageCost": number,                                // Expressed in USD.
      "date": "string"                                             // Date requested in format YYYY-MM-DD.
    },
    {
      "averageCost": number,
      "date": "string"
    },
    {
      "averageCost": number,
      "date": "string"
    },
    {
      "averageCost": number,
      "date": "string"
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/average-cost-per-user-per-date?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/average-request-time

Provides the average processing time for each request, enabling performance monitoring and optimization analysis.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/average-request-time
• Body: Empty

Response

{
  "averageRequestTime": number                                                        // average request time in milliseconds.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/average-request-time?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/average-requests-per-day

Returns the average number of requests made per day, supporting overall platform usage analysis.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/average-requests-per-day
• Body: Empty

Response

{
  "averageRequests": number                                                                       // Average number of daily requests in the selected period.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/average-requests-per-day?startDate=2024-01-01&endDate=2024-01-31&agentName=" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/average-requests-per-user

Returns the average number of requests made per user, supporting user engagement and adoption analysis.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/average-requests-per-user
• Body: Empty

Response

{
  "averageRequests": number                                              // average number of requests per user.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/average-requests-per-user?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/average-requests-per-user-per-date

Returns the average number of requests per user for each day, supporting analysis of user activity trends over time.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/average-requests-per-user-per-date
• Body: Empty

Response

{
  "averageRequestsPerUser": [
    {
      "averageRequests": number,                                // Number of average requests.
      "date": "string"                                                // Date expressed in YYYY-MM-DD format.
    },
    {
      "averageRequests": integer,
      "date": "string"
    },
    {
      "averageRequests": integer,
      "date": "string"
    },
    {
      "averageRequests": integer,
      "date": "string"
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/average-requests-per-user-per-date?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/average-tokens-per-request

Returns the average number of input, output, and total tokens per request, supporting analysis of typical request size and complexity.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/average-tokens-per-request
• Body: Empty

Response

{
  "input": number,                         // Average input tokens per request.
  "output": number,                        // Average output tokens per request.
  "total": number                         // Average total tokens per request.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/average-tokens-per-request?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/average-users-per-agent

Returns the average number per Agent of users who made requests.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/average-users-per-agent
• Body: Empty

Response

{
  "averageUsers": number // Number of average users of the selected Agent in the selected period.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/average-users-per-agent?startDate=2024-01-01&endDate=2024-01-31&agentName=" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/average-users-per-project

Returns the average number of requests from users per project, supporting analysis of project collaboration and adoption.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/average-users-per-project
• Body: Empty

Response

{
  "averageUsers": number                             // Number of average users in the requested period.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/average-users-per-project?startDate=2024-01-01&endDate=2024-01-31&agentName=" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/number-of-tokens

Returns the total number of input, output, and total API Tokens for all requests, supporting usage and billing analysis.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/number-of-tokens
• Body: Empty

Response

{
  "input": integer,                         // Total input tokens.
  "output": integer,                      // Total output tokens.
  "total": integer                          // Sum of input and output tokens.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/number-of-tokens?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/number-of-tokens-per-agent

Returns the number of input, output, and total tokens grouped by Agent and model, supporting agent-level token usage analysis.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/number-of-tokens-per-agent
• Body: Empty

Response

{
  "numberOfTokens": [
    {
      "agent": "string",                           // If not available, returns N/D..
      "input": integer,                               // Total number of input tokens.
      "model": "string",                             // If not available, returns N/D.
      "output": integer,                            // Total number of input tokens.
      "total": integer                              // Total number of tokens.
   },
    {
      "agent": "string",
      "input": integer,
      "model": "string",
      "output": integer,
      "total": integer
    },
    ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/number-of-tokens-per-agent?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/number-of-tokens-per-day

Returns the number of input, output, and total tokens used each day, enabling daily token consumption tracking.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/number-of-tokens-per-day
• Body: Empty

Response

{
  "numberOfTokens": [
    {
      "date": "string",                           // Expressed in YYYY-MM-DD.
      "input": integer,                          // Number of input tokens.
      "output": integer,                      // Number of output tokens.
      "total": integer                         // Total number of tokens.
    },
    {
      "date": "string",
      "input": integer,
      "output": integer,
      "total": integer
    },
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/number-of-tokens-per-day?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/overall-error-rate

Calculates the percentage of requests that failed, supporting analysis of overall error rate and system stability.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/overall-error-rate
• Body: Empty

Response

{
  "overallErrorRate": number // error rate as expressed from 0 to 1

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/overall-error-rate?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/top-10-agents-by-requests

Lists the top 10 Agents ranked by the number of requests, supporting identification of the most utilized Agents.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/top-10-agents-by-requests
• Body: Empty

Response

{
  "top10Agents": [
    {
      "agent": "string",                                           // Agent’s name.
      "totalRequests": integer                               // Total number of requests for the Agent above (repeats one entry for each Top 10 Agent).
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/top-10-agents-by-requests?startDate=2024-01-01&endDate=2024-01-31&agentName=" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/top-10-agents-by-tokens

Lists the top 10 Agents ranked by the number of tokens processed, supporting workload and resource consumption analysis per Agent.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/top-10-agents-by-tokens
• Body: Empty

Response

{
  "top10Agents": [
    {
      "agent": "string",                          // Agent’s name.
      "totalTokens": integer                   // Total number of tokens consumed by the Agent above (repeats one entry for each Top 10 Agent).
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/top-10-agents-by-tokens?startDate=2024-01-01&endDate=2024-01-31&agentName=" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/top-10-users-by-cost

Lists the top 10 users ranked by total cost incurred, enabling identification of the most resource-intensive users.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/top-10-users-by-cost
• Body: Empty

Response

{
  "top10Users": [
    {
      "totalCost": number,                          // Expressed in USD.
      "user": "string"                                 // User’s email.
    },
     ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/top-10-users-by-cost?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/top-10-users-by-requests

Lists the top 10 users ranked by the number of requests made, supporting identification of the most engaged users.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/top-10-users-by-requests
• Body: Empty

Response

{
  "top10Users": [
    {
      "totalRequests": integer,                 // Number of requests for this specific Top 10 users.
      "user": "string"                              // Typically email address.
    },
    {
      "totalRequests": integer,
      "user": "string"
    },
    {
      "totalRequests": integer,
      "user": "string"
    },
    {
      "totalRequests": integer,
      "user": "string"
    },
    {
      "totalRequests": integer,
      "user": "string"
    },
    {
      "totalRequests": integer,
      "user": "string"
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/top-10-users-by-requests?startDate=2024-01-01&endDate=2024-01-31&agentName=" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/total-active-agents

Provides the total number of Agents that have received requests and been active, supporting analysis of Agent utilization.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/total-active-agents
• Body: Empty

Response

{
  "totalActiveAgents": integer                                // Total number of Agents which are active in the requested period.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/total-active-agents?startDate=2024-01-01&endDate=2024-01-31&agentName=" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/total-active-projects

Returns the total number of projects with requests and activity in the selected period, enabling project engagement and adoption tracking.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/total-active-projects
• Body: Empty

Response

{
  "totalActiveProjects": integer                                // Total number of active projects in requested period.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/total-active-projects?startDate=2024-01-01&endDate=2024-01-31&agentName=" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/total-active-users

Returns the total number of users who have been active within the selected period, supporting user engagement analysis.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/total-active-users
• Body: Empty

Response

json
{
  "totalActiveUsers": integer                                       // Number of total active users.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/total-active-users?startDate=2024-01-01&endDate=2024-01-31&agentName=" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/total-cost

Returns the total accumulated cost of all requests made within the selected period, expressed in USD, supporting analysis of overall platform usage expenses.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/total-cost
• Body: Empty

Response

{
  "totalCost": number                                                    // the total cost for the requested period. Expressed in USD.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/total-cost?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/total-cost-per-day

Provides a breakdown of total costs incurred per day, allowing for daily cost monitoring and trend analysis.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/total-cost-per-day
• Body: Empty

Response

{
  "totalCostPerDay": [
    {
      "date": "string",                                    // Date in YYYY-MM-DD.
      "totalCost": number                                // Total cost for the day (USD).
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/total-cost-per-day?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/total-request-time

Returns the total processing time (expressed in hours) for all requests, providing insight into aggregate system workload and performance.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/total-request-time
• Body: Empty

Response

{
  "time": number                                    // Total processing time in hours.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/total-request-time?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/total-requests

Returns the total number of requests made, offering a high-level overview of activity and adoption.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/total-requests
• Body: Empty

Response

{
  "totalRequests": integer                                // Total number of requests in the period.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/total-requests?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/total-requests-per-day

Returns the number of requests made per day.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/total-requests-per-day
• Body: Empty

Response

{
  "totalRequestsPerDay": [
    {
      "date": "string",                                             // Format YYYY-MM-DD (one response for each day of the requested period).
      "totalRequests": integer,                           // Total requests during the date specified above
      "totalRequestsWithError": integer              // Total requests with error during the date specified above.
    }
  ]
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/total-requests-per-day?startDate=2024-01-01&endDate=2024-01-31&agentName=" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/total-requests-with-error

Returns the total number of requests that resulted in errors, supporting error tracking and reliability assessment.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/total-requests-with-error
• Body: Empty

Response

{
  "totalRequestsWithError": integer                             // number of requests with error in the period.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/total-requests-with-error?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"

GET /analytics/requests/total-tokens

Returns the total number of tokens processed across all requests, supporting overall usage and billing calculations.

Parameters

Request

• Method: GET
• Path: $BASE_URL/v1/analytics/requests/total-tokens
• Body: Empty

Response

{
  "total": integer                                  // Total tokens in the period selected.
}

cURL Sample

curl -X GET "$BASE_URL/v1/analytics/requests/total-tokens?startDate=2024-01-01&endDate=2024-01-31" \
  -H "Authorization: Bearer $GEAI_APITOKEN" \
  -H "Content-Type: application/json" \
  -H "OrganizationId: $ORGANIZATION_ID" \
  -H "ProjectId: $PROJECT_ID"