Fetch Usage Report | Rightbrain Docs | Transform AI Ideas into Production Tasks

curl https://app.rightbrain.ai/api/v1/org/123e4567-e89b-12d3-a456-426614174000/project/123e4567-e89b-12d3-a456-426614174001/task/01909843-3596-da54-4756-28af46917e74/usage_report \
     -H "Authorization: Bearer <token>"

{
  "task_id": "0190a234-8dc6-6d08-aea9-928fcecad8f1",
  "date_range": {},
  "aggregation": "day",
  "task_revisions": [
    {
      "task_revision_id": "string",
      "data": {}
    }
  ],
  "total_counts": {},
  "errors_only": false,
  "report_data": [
    {
      "date": "2024-01-15",
      "total_runs": 24,
      "successful_runs": 22,
      "failed_runs": 2,
      "error_rate": 0.083,
      "unique_users": 5
    },
    {
      "date": "2024-01-16",
      "total_runs": 31,
      "successful_runs": 30,
      "failed_runs": 1,
      "error_rate": 0.032,
      "unique_users": 7
    },
    {
      "date": "2024-01-17",
      "total_runs": 28,
      "successful_runs": 28,
      "failed_runs": 0,
      "error_rate": 0,
      "unique_users": 6
    }
  ],
  "summary": {
    "total_runs": 83,
    "total_successful": 80,
    "total_failed": 3,
    "average_error_rate": 0.036,
    "period_start": "2024-01-15",
    "period_end": "2024-01-17"
  }
}

Retrieve usage statistics for task executions.

This endpoint provides detailed usage data about task runs, including:

Number of executions over time
Success and failure rates
Usage patterns by time period
Aggregated metrics by day or week

Use this data to:

Monitor task usage patterns
Track execution success rates
Analyze usage trends
Plan capacity and scaling

Retrieve usage statistics for task executions. This endpoint provides detailed usage data about task runs, including: - Number of executions over time - Success and failure rates - Usage patterns by time period - Aggregated metrics by day or week Use this data to: 1. Monitor task usage patterns 2. Track execution success rates 3. Analyze usage trends 4. Plan capacity and scaling

Authentication

AuthorizationBearer

Bearer token authentication using JWT tokens from Ory Kratos/Hydra

Path parameters

org_idstringRequiredformat: "uuid"

The unique identifier of the organization.

project_idstringRequiredformat: "uuid"

The unique identifier of the project.

task_idstringRequiredformat: "uuid"

The specific Task to reference.

Query parameters

aggregationenumOptionalDefaults to day

The aggregation level for the report. Can be either 'day' or 'week'.

Allowed values:

errors_onlybooleanOptionalDefaults to false

If true, only include invocations with errors in the report.

Response

Usage report retrieved successfully

task_idstringformat: "uuid"

The unique identifier of the Task.

date_rangemap from strings to any

The time range for the report, with start and end timestamps.

aggregationenum

The time interval for data aggregation. 'day' shows last 24 hours in hourly blocks, 'week' shows last 7 days in daily blocks.

Allowed values:

task_revisionslist of objects

Usage data broken down by task revision, showing invocation counts for each active revision.

total_countsmap from strings to integers

Total number of task invocations for each time interval across all revisions.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

500

Internal Server Error