> ## Documentation Index > Fetch the complete documentation index at: https://docs.hihobbes.com/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve funnel metrics > Return aggregate funnel performance for a trailing day window. Requires `analytics:read`. Choose a trailing window from 1 to 365 UTC days. The response includes session, qualification, booking, high-intent, duration, qualification-rate, and top-source metrics. `qualificationRate` is already a percentage from 0 to 100, rounded to two decimal places. Do not multiply it again in the presentation layer. ## OpenAPI ````yaml api-reference/openapi.json GET /api/v1/metrics openapi: 3.1.0 info: title: Hobbes API description: > Use the Hobbes API to read your organization's analyzed demo sessions, prospects, accounts, transcripts, and funnel metrics, and to create and manage personalized Custom Links. **Authentication**: create an API key in Settings → API Keys, then send it as `Authorization: Bearer ` (or `x-api-key: `). Keys are org-scoped; responses only ever contain your organization's data. **Scopes**: keys carry scopes (`sessions:read`, `people:read`, `accounts:read`, `analytics:read`, `transcripts:read`, `custom_links:read`, `custom_links:write`). `custom_links:write` also satisfies read access. Raw transcript access is a separate opt-in scope with a daily quota. Existing API keys do not receive Custom Link scopes automatically. **Rate limits**: keys allow 120 requests per minute by default. Responses include `X-RateLimit-Limit` and `X-RateLimit-Remaining`; 429 responses include `Retry-After`. Transcript access has a separate quota of 2,000 reads per organization per UTC day. Custom Link mutations are limited to 10 requests per minute per organization. Creation and thumbnail rendering also use weighted hourly and daily organization quotas, so one request containing 500 links is one HTTP request but consumes up to 500 creation and 500 render units. **Support**: every response carries an `X-Request-ID` header. Include it when reporting an issue so we can find the exact request in our logs. **Stability**: changes within v1 are additive only. Fields may be added to responses; existing fields are never removed or renamed. version: 1.0.0 servers: - url: https://api-us.hihobbes.com description: Production security: - bearer: [] - apiKeyHeader: [] tags: - name: Sessions description: Analyzed demo sessions and their transcripts. - name: People description: Prospect profiles aggregated across sessions. - name: Accounts description: Company-level engagement rollups by email domain. - name: Metrics description: Aggregate funnel performance over a trailing window. - name: Custom Links description: Create and manage personalized links. - name: Custom Link Jobs description: Poll, cancel, and retry asynchronous Custom Link work. - name: Custom Link Campaigns description: Organize Custom Links into campaigns. paths: /api/v1/metrics: get: tags: - Metrics summary: Retrieve funnel metrics description: >- Return aggregate session, qualification, booking, intent, duration, and source metrics for a trailing 1-365 day window. operationId: v1_get_metrics parameters: - name: days in: query required: false schema: type: integer maximum: 365 minimum: 1 default: 30 title: Days description: >- Trailing number of UTC days to aggregate. Defaults to 30 and accepts 1-365. description: >- Trailing number of UTC days to aggregate. Defaults to 30 and accepts 1-365. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/MetricsResponse' headers: X-Request-ID: description: Unique request identifier to include in support requests. schema: type: string example: req_01JABCDEF23456789 X-RateLimit-Limit: description: Request limit for this key in the current 60-second window. schema: type: integer example: 120 X-RateLimit-Remaining: description: Requests remaining for this key in the current window. schema: type: integer example: 119 '401': description: API key required or invalid. headers: X-Request-ID: description: Unique request identifier to include in support requests. schema: type: string example: req_01JABCDEF23456789 content: application/json: schema: type: object required: - detail properties: detail: type: string example: API key required or invalid. '403': description: API key does not include the required scope. headers: X-Request-ID: description: Unique request identifier to include in support requests. schema: type: string example: req_01JABCDEF23456789 content: application/json: schema: type: object required: - detail properties: detail: type: string example: API key does not include the required scope. '422': description: A path, query, header, or request field failed validation. content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' headers: X-Request-ID: description: Unique request identifier to include in support requests. schema: type: string example: req_01JABCDEF23456789 '429': description: Rate limit or organization quota exceeded. headers: X-Request-ID: description: Unique request identifier to include in support requests. schema: type: string example: req_01JABCDEF23456789 X-RateLimit-Limit: description: Request limit for this key in the current 60-second window. schema: type: integer example: 120 X-RateLimit-Remaining: description: Requests remaining for this key in the current window. schema: type: integer example: 119 Retry-After: description: Seconds to wait before retrying. schema: type: integer example: 30 X-RateLimit-Reset: description: Unix timestamp when the limiting window resets. schema: type: integer content: application/json: schema: type: object required: - detail properties: detail: type: string example: Rate limit or organization quota exceeded. components: schemas: MetricsResponse: properties: days: type: integer title: Days description: Trailing UTC day window used for the aggregation. examples: - 30 totalSessions: type: integer title: Totalsessions description: Analyzed sessions in the window. examples: - 248 qualifiedCount: type: integer title: Qualifiedcount description: Currently qualified unique people active in the window. examples: - 71 bookedCount: type: integer title: Bookedcount description: Sessions that produced a booking. examples: - 29 highIntentCount: type: integer title: Highintentcount description: High-intent unique people active in the window. examples: - 64 avgDurationSeconds: anyOf: - type: number - type: 'null' title: Avgdurationseconds description: Average session duration in seconds. examples: - 512.4 qualificationRate: anyOf: - type: number - type: 'null' title: Qualificationrate description: >- Qualified unique active people divided by all unique active people, from 0 to 100. examples: - 28.6 topSources: items: $ref: '#/components/schemas/SourceCount' type: array title: Topsources description: Top acquisition sources by session count. type: object required: - days - totalSessions - qualifiedCount - bookedCount - highIntentCount title: MetricsResponse HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError SourceCount: properties: source: type: string title: Source description: Acquisition source. examples: - linkedin count: type: integer title: Count description: Sessions attributed to the source. examples: - 38 type: object required: - source - count title: SourceCount ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError securitySchemes: bearer: type: http scheme: bearer description: Hobbes API key with the `hb_live_` prefix. apiKeyHeader: type: apiKey in: header name: x-api-key description: Alternative to the Bearer authorization header. ````