Error

A valid request URL is required to generate request examples

{
  "meta": {
    "generated_at": "2023-11-07T05:31:56Z",
    "bucket_size_seconds": 123,
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z"
  },
  "overview": {
    "stats": {
      "total_requests": 123,
      "total_tokens": 123,
      "total_cost": 123,
      "average_latency": 123,
      "success_rate": 123,
      "user_facing_success_rate": 123,
      "user_facing_total_requests": 123,
      "cache_hit_rate_total_requests": 123,
      "direct_cache_hits": 123,
      "semantic_cache_hits": 123
    },
    "requests": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "count": 123,
          "success": 123,
          "error": 123
        }
      ],
      "bucket_size_seconds": 123
    },
    "tokens": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "prompt_tokens": 123,
          "completion_tokens": 123,
          "total_tokens": 123
        }
      ],
      "bucket_size_seconds": 123
    },
    "cost": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "total_cost": 123,
          "by_model": {}
        }
      ],
      "bucket_size_seconds": 123,
      "models": [
        "<string>"
      ]
    },
    "models": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "by_model": {}
        }
      ],
      "bucket_size_seconds": 123,
      "models": [
        "<string>"
      ]
    },
    "latency": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "avg_latency": 123,
          "p90_latency": 123,
          "p95_latency": 123,
          "p99_latency": 123,
          "total_requests": 123
        }
      ],
      "bucket_size_seconds": 123
    }
  },
  "provider_usage": {
    "cost": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "total_cost": 123,
          "by_provider": {}
        }
      ],
      "bucket_size_seconds": 123,
      "providers": [
        "<string>"
      ]
    },
    "tokens": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "by_provider": {}
        }
      ],
      "bucket_size_seconds": 123,
      "providers": [
        "<string>"
      ]
    },
    "latency": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "by_provider": {}
        }
      ],
      "bucket_size_seconds": 123,
      "providers": [
        "<string>"
      ]
    }
  },
  "model_rankings": {
    "rankings": {
      "rankings": [
        {
          "model": "<string>",
          "provider": "<string>",
          "total_requests": 123,
          "success_count": 123,
          "success_rate": 123,
          "total_tokens": 123,
          "total_cost": 123,
          "avg_latency": 123,
          "trend": {
            "has_previous_period": true,
            "requests_trend": 123,
            "tokens_trend": 123,
            "cost_trend": 123,
            "latency_trend": 123
          }
        }
      ]
    },
    "histogram": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "by_model": {}
        }
      ],
      "bucket_size_seconds": 123,
      "models": [
        "<string>"
      ]
    }
  },
  "dimension_rankings": {},
  "mcp": {
    "volume": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "count": 123,
          "success": 123,
          "error": 123
        }
      ],
      "bucket_size_seconds": 123
    },
    "cost": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "total_cost": 123
        }
      ],
      "bucket_size_seconds": 123
    },
    "top_tools": {
      "tools": [
        {
          "tool_name": "<string>",
          "count": 123,
          "cost": 123
        }
      ]
    }
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_vikat_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_vikat_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

Logging

Get consolidated dashboard data

Returns every metric shown on the workspace dashboard in a single response: overview totals and histograms, provider usage, model rankings, dimension rankings (team, user, virtual key, customer, business unit), and MCP usage. Intended for external integrations that want the full dashboard in one call rather than orchestrating the individual endpoints.

Accepts the same LLM filter parameters as the histogram and rankings endpoints, plus the MCP filter parameters (tool_names, server_labels) which apply to the mcp section. Filters are applied once and every section is computed against the same time window and bucket size. The request fails as a whole if any section cannot be computed, so the payload is always complete.

GET

api

logs

dashboard

Error

A valid request URL is required to generate request examples

{
  "meta": {
    "generated_at": "2023-11-07T05:31:56Z",
    "bucket_size_seconds": 123,
    "start_time": "2023-11-07T05:31:56Z",
    "end_time": "2023-11-07T05:31:56Z"
  },
  "overview": {
    "stats": {
      "total_requests": 123,
      "total_tokens": 123,
      "total_cost": 123,
      "average_latency": 123,
      "success_rate": 123,
      "user_facing_success_rate": 123,
      "user_facing_total_requests": 123,
      "cache_hit_rate_total_requests": 123,
      "direct_cache_hits": 123,
      "semantic_cache_hits": 123
    },
    "requests": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "count": 123,
          "success": 123,
          "error": 123
        }
      ],
      "bucket_size_seconds": 123
    },
    "tokens": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "prompt_tokens": 123,
          "completion_tokens": 123,
          "total_tokens": 123
        }
      ],
      "bucket_size_seconds": 123
    },
    "cost": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "total_cost": 123,
          "by_model": {}
        }
      ],
      "bucket_size_seconds": 123,
      "models": [
        "<string>"
      ]
    },
    "models": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "by_model": {}
        }
      ],
      "bucket_size_seconds": 123,
      "models": [
        "<string>"
      ]
    },
    "latency": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "avg_latency": 123,
          "p90_latency": 123,
          "p95_latency": 123,
          "p99_latency": 123,
          "total_requests": 123
        }
      ],
      "bucket_size_seconds": 123
    }
  },
  "provider_usage": {
    "cost": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "total_cost": 123,
          "by_provider": {}
        }
      ],
      "bucket_size_seconds": 123,
      "providers": [
        "<string>"
      ]
    },
    "tokens": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "by_provider": {}
        }
      ],
      "bucket_size_seconds": 123,
      "providers": [
        "<string>"
      ]
    },
    "latency": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "by_provider": {}
        }
      ],
      "bucket_size_seconds": 123,
      "providers": [
        "<string>"
      ]
    }
  },
  "model_rankings": {
    "rankings": {
      "rankings": [
        {
          "model": "<string>",
          "provider": "<string>",
          "total_requests": 123,
          "success_count": 123,
          "success_rate": 123,
          "total_tokens": 123,
          "total_cost": 123,
          "avg_latency": 123,
          "trend": {
            "has_previous_period": true,
            "requests_trend": 123,
            "tokens_trend": 123,
            "cost_trend": 123,
            "latency_trend": 123
          }
        }
      ]
    },
    "histogram": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "by_model": {}
        }
      ],
      "bucket_size_seconds": 123,
      "models": [
        "<string>"
      ]
    }
  },
  "dimension_rankings": {},
  "mcp": {
    "volume": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "count": 123,
          "success": 123,
          "error": 123
        }
      ],
      "bucket_size_seconds": 123
    },
    "cost": {
      "buckets": [
        {
          "timestamp": "2023-11-07T05:31:56Z",
          "total_cost": 123
        }
      ],
      "bucket_size_seconds": 123
    },
    "top_tools": {
      "tools": [
        {
          "tool_name": "<string>",
          "count": 123,
          "cost": 123
        }
      ]
    }
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_vikat_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_vikat_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "<string>",
    "request_type": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Query Parameters

providers

string

Comma-separated list of providers to filter by

models

string

Comma-separated list of models to filter by

aliases

string

Comma-separated list of model aliases to filter by

status

string

Comma-separated list of statuses to filter by

objects

string

Comma-separated list of object types to filter by

selected_key_ids

string

Comma-separated list of selected key IDs to filter by

virtual_key_ids

string

Comma-separated list of virtual key IDs to filter by

team_ids

string

Comma-separated list of team IDs to filter by

customer_ids

string

Comma-separated list of customer IDs to filter by

user_ids

string

Comma-separated list of user IDs to filter by

business_unit_ids

string

Comma-separated list of business unit IDs to filter by

routing_rule_ids

string

Comma-separated list of routing rule IDs to filter by

routing_engine_used

string

Comma-separated list of routing engines to filter by

start_time

string<date-time>

Start time filter (RFC3339 format)

end_time

string<date-time>

End time filter (RFC3339 format)

period

string

Relative time period filter

min_latency

number

Minimum latency filter

max_latency

number

Maximum latency filter

min_tokens

integer

Minimum tokens filter

max_tokens

integer

Maximum tokens filter

min_cost

number

Minimum cost filter

max_cost

number

Maximum cost filter

missing_cost_only

boolean

Only show logs with missing cost

stop_reasons

string

Comma-separated list of stop reasons to filter by

cache_hit_types

string

Comma-separated list of cache hit types to filter by

parent_request_id

string

Parent request ID to filter by

metadata_<key>

string

Metadata filter where is the metadata key to match

content_search

string

Search in request/response content

tool_names

string

Comma-separated list of MCP tool names to filter the MCP section by

server_labels

string

Comma-separated list of MCP server labels to filter the MCP section by

Response

Dashboard data retrieved successfully

Consolidated payload containing every metric shown on the workspace dashboard. Each section mirrors the response of its dedicated endpoint, so consumers can integrate a single call instead of orchestrating many.