Learnings

List learnings for an organization

Changed on

Programmatic access to an organization's CodeRabbit learnings. Returns paginated JSON or a CSV download. Enterprise plan only. Mirrors the auth, rate-limit and response-size contract of the Metrics public API.

get/v1/learnings

Request

  • Base URL
    https://api.coderabbit.ai
  • Auth
    API key in header x-coderabbitai-api-key

Query parameters

org_idstring

Workspace-scoped API tokens only. When provided, scopes learnings to that single git-provider organization within the token's workspace; when omitted, aggregates every organization in the workspace. Ignored for organization and self-hosted keys.

repository_idsstring
Example:1027529638,987654321

Comma-separated provider repository IDs (max 10).

user_idsstring
Example:87397876,12345678

Comma-separated provider user IDs (max 10).

searchstring

Case-insensitive substring search over learning text.

file_pathsstring
Example:src/api.ts,src/auth.ts

Comma-separated exact file paths (max 10).

stat_filter'total' | 'active' | 'never_used' | 'created_this_week'

Filter by recent usage, zero usage, or creation in the last seven days.

organization_idsstring
Example:184456712,103539130

Comma-separated provider organization IDs (max 10). Self-hosted instances only.

limitinteger

Maximum number of records to return.

cursorstring

Pagination cursor returned as next_cursor on the previous page.

format'json' | 'csv'

Response format. json (default) returns paginated JSON; csv returns a CSV download.

Headers

x-coderabbitai-api-keystring required

API key for authentication

Response

Successfully retrieved learnings.

next_cursorstring nullable required

Changes

    • info

      added the optional property // to the response with the status

    • info

      added the new optional query request parameter file_paths

    • info

      added the new optional query request parameter search

    • info

      added the new optional query request parameter stat_filter