EvoHub Docs Sign in

API reference

EvoTrail API

Use with AI
View as MarkdownThis page as plain text, for pasting into an AI tool Open in ClaudeAsk Claude questions about this page Open in ChatGPTAsk ChatGPT questions about this page
Connect to Cursor / VS Code / ClaudeSearch and read these docs from your AI tool (MCP server)

MCP server URL

https://docs-dev.evohub.io/mcp

Add to CursorAdd to VS Code

Claude Code

claude mcp add --transport http evohub-docs-docs https://docs-dev.evohub.io/mcp

Claude (claude.ai and Claude Desktop): Settings → Connectors → Add custom connector, and paste the URL above.

Claude Desktop — claude_desktop_config.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://docs-dev.evohub.io/mcp"
      ]
    }
  }
}

Cursor — ~/.cursor/mcp.json

{
  "mcpServers": {
    "evohub-docs-docs": {
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

VS Code — .vscode/mcp.json

{
  "servers": {
    "evohub-docs-docs": {
      "type": "http",
      "url": "https://docs-dev.evohub.io/mcp"
    }
  }
}

llms.txtllms-full.txt

Version 1.0 OpenAPI 3.1.0

EvoTrail is the organization's audit trail, usage and metrics across every EvoHub product, in one place. This API reads it: search and export the audit trail, see how much each product is used, and read each product's metrics through one prefix. Everything here is read-only and free.

Authentication. Send an API key as Authorization: Bearer evohub_… or X-API-Key: evohub_…. A key works in one organization. See API keys and scopes and Errors in these docs.

Permissions, two layers. Each operation names the EvoTrail permission it needs (x-evohub-permission): evotrail:audit:read for the audit trail, evotrail:metrics:read for usage, overview and metrics. On top of that, each product's rows or numbers need that product's own permission: an audit row needs the product's *:audit:read (for example oncall:audit:read), a product's usage and metrics need one of its read permissions (for example uptime:monitor:read). Products the key cannot read are left out of the answer; asking only for those is 403 FORBIDDEN. A refusal is never 401.

A key is always held to its scopes, even one made by an administrator. API keys never count as owners or administrators, so the per-person views below are not available to a key.

Retention is fixed for every organization: audit events 365 days, activity events 90 days, IP addresses and user agents 90 days.

Ranges. from and to are a UTC date (YYYY-MM-DD, to inclusive) or an RFC 3339 timestamp. By default the last 30 days; at most 366 days.

Responses. Success is {"data": …, "success": true}. Errors are {"error": {"code", "message", "request_id"}, "success": false}; request_id is sent on 403 and 500 answers. Times are RFC 3339 in UTC.

Servers

  • https://evohub.io

Authentication

  • bearerAuth HTTP Bearer
    An EvoHub API key (evohub_…) as a bearer token.
  • apiKeyHeader API key in the header X-API-Key
    An EvoHub API key (evohub_…).

Audit trail

Every product's audit and activity events, searched, counted and exported.

GET/api/v1/evotrail/auditSearch the audit trail
GET/api/v1/evotrail/audit/facetsCount the audit trail by dimension
GET/api/v1/evotrail/audit/export.csvExport the audit trail as CSV
GET/api/v1/evotrail/audit/{id}Get one audit event

Usage

How much each product is used, by whom and by which team.

GET/api/v1/evotrail/usageGet usage by product
GET/api/v1/evotrail/usage/peopleGet the most active people
GET/api/v1/evotrail/overviewGet the overview

Product metrics

Each product's own analytics, read through EvoTrail.

GET/api/v1/evotrail/metrics/oncall/alertsOn-Call alert analytics
GET/api/v1/evotrail/metrics/oncall/incidentsOn-Call incident analytics
GET/api/v1/evotrail/metrics/uptimeUptime analytics
GET/api/v1/evotrail/metrics/statusStatus analytics across pages
GET/api/v1/evotrail/metrics/status/pages/{id}One status page's visitor analytics
GET/api/v1/evotrail/metrics/status/pages/{id}/hourlyOne status page's views by the hour
GET/api/v1/evotrail/metrics/docsDocs analytics across sites
GET/api/v1/evotrail/metrics/docs/sites/{id}One docs site's analytics
GET/api/v1/evotrail/metrics/docs/sites/{id}/searchOne docs site's search analytics
GET/api/v1/evotrail/metrics/docs/sites/{id}/aiOne docs site's AI analytics
GET/api/v1/evotrail/metrics/docs/sites/{id}/gapsOne docs site's gap analytics
GET/api/v1/evotrail/metrics/changelogChangelog analytics across sites
GET/api/v1/evotrail/metrics/changelog/sites/{id}One changelog's analytics
GET/api/v1/evotrail/metrics/boardBoard analytics
GET/api/v1/evotrail/metrics/retroRetro analytics
GET/api/v1/evotrail/metrics/retro/statsRetro statistics
GET/api/v1/evotrail/metrics/billingBilling summary
GET/api/v1/evotrail/metrics/billing/usageBilling usage
GET/api/v1/evotrail/metrics/billing/creditBilling credit
GET/api/v1/evotrail/metrics/billing/statementsBilling statements

Settings

EvoTrail's fixed retention.

GET/api/v1/evotrail/settingsGet the retention periods

Last updated