ReadMe Developer Metrics API — Analytics

naftiko: 1.0.0-alpha2
info:
  label: ReadMe Developer Metrics API — Analytics
  description: 'ReadMe Developer Metrics API — Analytics. 3 operations. Lead operation: Retrieve page view statistics. Self-contained
    Naftiko capability covering one Readme business surface.'
  tags:
  - Readme
  - Analytics
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    README_API_KEY: README_API_KEY
capability:
  consumes:
  - type: http
    namespace: developer-metrics-analytics
    baseUri: https://metrics.readme.io/v1
    description: ReadMe Developer Metrics API — Analytics business capability. Self-contained, no shared references.
    resources:
    - name: pageviews
      path: /pageviews
      operations:
      - name: get
        method: GET
        description: Retrieve page view statistics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: quality
      path: /quality
      operations:
      - name: get
        method: GET
        description: Retrieve page quality scores
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: search
      path: /search
      operations:
      - name: get
        method: GET
        description: Retrieve search analytics
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.README_USER}}'
      password: '{{env.README_PASS}}'
  exposes:
  - type: rest
    namespace: developer-metrics-analytics-rest
    port: 8080
    description: REST adapter for ReadMe Developer Metrics API — Analytics. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/pageviews
      name: pageviews
      description: REST surface for pageviews.
      operations:
      - method: GET
        name: get
        description: Retrieve page view statistics
        call: developer-metrics-analytics.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/quality
      name: quality
      description: REST surface for quality.
      operations:
      - method: GET
        name: get
        description: Retrieve page quality scores
        call: developer-metrics-analytics.get
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/search
      name: search
      description: REST surface for search.
      operations:
      - method: GET
        name: get
        description: Retrieve search analytics
        call: developer-metrics-analytics.get
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: developer-metrics-analytics-mcp
    port: 9090
    transport: http
    description: MCP adapter for ReadMe Developer Metrics API — Analytics. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: retrieve-page-view-statistics
      description: Retrieve page view statistics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: developer-metrics-analytics.get
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-page-quality-scores
      description: Retrieve page quality scores
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: developer-metrics-analytics.get
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-search-analytics
      description: Retrieve search analytics
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: developer-metrics-analytics.get
      outputParameters:
      - type: object
        mapping: $.