Relevance AI

Relevance AI Analytics API

The analytics API from Relevance AI — 23 operation(s) for analytics.

GitHub OpenAPI

Operations 23

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /analytics/get_metrics Get a metric as a time series with summary stats · GetMetrics #
Ask an LLM
“How do I chart a single metric over time with summary statistics?”
“Can I group a metric's time series by a dimension?”
Tell an agent
Get metric {metric} from {start_date} to {end_date}.
Show metric {metric} grouped by {group_by} between {start_date} and {end_date}.
POST /analytics/get_agent_breakdown Break down agents by tasks, errors and top actions · GetAgentBreakdown #
Ask an LLM
“Which agents had the highest error rates last week?”
“Can I see each agent's task count along with its most-used actions?”
Tell an agent
Show the agent breakdown with task counts, error rates and top actions from {start_date} to {end_date}.
Give me error rates and top actions for agents {agent_ids} since {start_date} until {end_date}.
POST /analytics/get_action_breakdown Break down actions by executions and credits · GetActionBreakdown #
Ask an LLM
“Which actions ran the most and burned the most credits?”
“Can I see which agents use a given action most often?”
Tell an agent
Show the action breakdown with execution counts and credits from {start_date} to {end_date}.
Break down actions {action_ids} by executions and top agents between {start_date} and {end_date}.
POST /analytics/get_workforce_breakdown Break down workforces by tasks, errors and credits · GetWorkforceBreakdown #
Ask an LLM
“Which workforces are failing the most tasks?”
“Can I see top agents inside each workforce with its credit spend?”
Tell an agent
Show the workforce breakdown with task counts, error rates and top agents from {start_date} to {end_date}.
Give me error rates and top agents for workforces {workforce_ids} from {start_date} to {end_date}.
POST /analytics/get_agent_llm_usage_by_model Break down agent usage by LLM model · GetAgentModelBreakdown #
Ask an LLM
“Which LLM models are my agents using, and how many tokens?”
“Can I compare input and output token counts per model for my agents?”
Tell an agent
Break down agent LLM usage by model, with credits and tokens, from {start_date} to {end_date}.
Show tokens per model for agents {agent_ids} between {start_date} and {end_date}.
POST /analytics/get_agent_errors List error messages from agents and tool runs · GetAgentErrors #
Ask an LLM
“What error messages did my agents hit yesterday?”
“Can I page through agent and tool run error messages with a cursor?”
Tell an agent
List agent and tool error messages from {start_date} to {end_date}.
Show error messages for agents {agent_ids} between {start_date} and {end_date}.
GET /analytics/get_error_time_series Get detailed error records with execution context · GetErrorTimeSeries #
Ask an LLM
“Where can I find full execution context for each error, not just the message?”
“Can I filter detailed error records by workforce and source?”
Tell an agent
Get detailed error records with execution context for workforces {workforce_ids}.
Show the error time series from {start_date} to {end_date} filtered by source {source_filter}.
GET /analytics/get_task_timeline Chart daily approval, escalated or errored tasks · GetTaskTimeline #
Ask an LLM
“How many tasks were waiting for approval each day this month?”
“Can I chart escalated tasks per day for a set of agents?”
Tell an agent
Chart daily task counts for the {view} tab.
Show daily {view} task counts for agents {agent_ids} from {start_date} to {end_date}.
GET /organizations/{organization_id}/analytics/concurrency_time_series Chart concurrency usage for an organization · GetConcurrencyTimeSeriesByOrgId #
Ask an LLM
“How close is my organization to its concurrency limit over time?”
“Can I break organization concurrency down by project?”
Tell an agent
Chart concurrency usage for organization {organization_id}.
Show concurrency for organization {organization_id} at {granularity} granularity, grouped by {group_by}.
GET /organizations/{organization_id}/analytics/live_jobs List running and queued jobs for an organization · GetLiveJobsByOrgId #
Ask an LLM
“What jobs are running or queued right now across my organization?”
“Can I list only the queued jobs in a given priority tier?”
Tell an agent
List live jobs for organization {organization_id}.
Show {state} jobs in priority tier {priority_tier} for organization {organization_id}.
GET /task_ops/tab_counts Get task counts for approvals, escalations and errors · GetTaskOpsTabCounts #
Ask an LLM
“How many tasks are pending approval, escalated or errored right now?”
“Is there a single call for all the task tab counts?”
Tell an agent
Get the task tab counts for approvals, escalated, errors and all tasks.
Tell me how many tasks need approval right now.
GET /analytics/get_usage Get usage from agents and tool runs · GetUsage #
Ask an LLM
“How much usage did my agents and tools generate over a time range?”
“Can I group usage data by a field and pick the metric?”
Tell an agent
Get usage for metric {metric} from {from} to {to}.
Show agent and tool run usage grouped by {group}.
POST /analytics/tool/breakdown Get per-tool usage totals · GetToolUsageBreakdown #
Ask an LLM
“Which tools ran the most and what did each cost in credits?”
“Can I see error rate and credits per run for each tool?”
Tell an agent
Show per-tool runs, credits and error rates from {start_date} to {end_date}.
Give totals for tools {tool_ids} between {start_date} and {end_date}.
POST /analytics/tool/breakdown/timeseries Chart daily usage per tool · GetToolUsageBreakdownTimeseries #
Ask an LLM
“Can I chart each tool's runs day by day as separate series?”
“How many tools are included in the per-tool daily chart data?”
Tell an agent
Chart daily usage for each tool separately from {start_date} to {end_date}.
Get per-tool per-day series for tools {tool_ids} from {start_date} to {end_date}.
POST /analytics/tool/timeseries Chart combined daily tool usage · GetToolUsageTimeseries #
Ask an LLM
“What was my total tool usage per day, combined across tools?”
“Can I get one daily line of runs and credits for selected tools?”
Tell an agent
Chart combined daily tool runs and credits from {start_date} to {end_date}.
Show one combined daily total for tools {tool_ids} between {start_date} and {end_date}.
POST /analytics/agent/breakdown Get per-agent usage totals · GetAgentUsageBreakdown #
Ask an LLM
“Which agents ran the most tasks and spent the most credits over a period?”
“Can each agent's usage row include a rollup of the tools it called?”
Tell an agent
Show per-agent tasks, credits and error rates from {start_date} to {end_date}.
Give usage totals for agents {agent_ids} with per-tool children {children}, from {start_date} to {end_date}.
POST /analytics/agent/breakdown/timeseries Chart daily usage per agent · GetAgentUsageBreakdownTimeseries #
Ask an LLM
“Can I chart every agent's tasks per day as its own series?”
“Is there a cap on how many agents appear in the per-agent daily series?”
Tell an agent
Chart daily usage for each agent separately from {start_date} to {end_date}.
Get per-agent per-day series for agents {agent_ids} from {start_date} to {end_date}.
POST /analytics/agent/timeseries Chart combined daily agent usage · GetAgentUsageTimeseries #
Ask an LLM
“What was my total agent activity per day, all agents combined?”
“Can I get daily agent tasks with model and tool credits split out?”
Tell an agent
Chart combined daily agent tasks and credits from {start_date} to {end_date}.
Show one combined daily total for agents {agent_ids} between {start_date} and {end_date}.
POST /analytics/workforce/breakdown Get per-workforce usage totals · GetWorkforceUsageBreakdown #
Ask an LLM
“Which workforces ran the most tasks and what did each cost?”
“How is error rate counted for workforce usage totals?”
Tell an agent
Show per-workforce tasks, credits and error rates from {start_date} to {end_date}.
Give usage totals for workforces {workforce_ids} with children {children}, from {start_date} to {end_date}.
POST /analytics/workforce/breakdown/timeseries Chart daily usage per workforce · GetWorkforceUsageBreakdownTimeseries #
Ask an LLM
“Can I chart each workforce's tasks per day as separate lines?”
“How are per-workforce daily series limited by task volume?”
Tell an agent
Chart daily usage for each workforce separately from {start_date} to {end_date}.
Get per-workforce per-day series for workforces {workforce_ids} from {start_date} to {end_date}.
POST /analytics/workforce/timeseries Chart combined daily workforce usage · GetWorkforceUsageTimeseries #
Ask an LLM
“What was total workforce activity each day, all workforces combined?”
“Can I get daily workforce tasks with tool and model credits?”
Tell an agent
Chart combined daily workforce tasks and credits from {start_date} to {end_date}.
Show one combined daily total for workforces {workforce_ids} between {start_date} and {end_date}.
POST /analytics/project/timeseries Chart project-wide daily usage · GetProjectUsageTimeseries #
Ask an LLM
“How much did my whole project use each day across agents, workforces and tools?”
“Can I see project credits split between tool execution and agent model calls?”
Tell an agent
Chart project-wide daily usage from {start_date} to {end_date}.
Show my project's daily agent tasks, workforce tasks and tool runs since {start_date} through {end_date}.
POST /analytics/model/breakdown Break down AI model usage by where it was called · GetModelUsageBreakdown #
Ask an LLM
“Which AI models were called, and was it inside tools, agents or workforces?”
“Can I filter model usage to specific models and call contexts?”
Tell an agent
Break down AI model usage by model and context from {start_date} to {end_date}.
Show usage of models {model_ids} in contexts {contexts} between {start_date} and {end_date}.

Documentation

📖
Documentation
https://relevanceai.com/docs
📖
APIReference
https://api-f1db6c.stack.tryrelevance.com/latest/documentation
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/authentication/relevance-ai-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/openapi/relevance-ai-analytics-api-openapi.yml

Other Resources

🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/errors/relevance-ai-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/data-model/relevance-ai-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/relevance-ai:relevance-ai-analytics-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

relevance-ai-analytics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: Relevance AI Endpoints
  title: Relevance AI Endpoints Analytics API
  version: latest
  contact:
    email: dev@tryrelevance.com
servers:
- url: /latest
security:
- AuthorizationHeader:
  - Authorization
tags:


# --- truncated at 32 KB (138 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/relevance-ai/refs/heads/main/openapi/relevance-ai-analytics-api-openapi.yml