Circana Liquid Data API — Consumer Panel

naftiko: 1.0.0-alpha2
info:
  label: Circana Liquid Data API — Consumer Panel
  description: 'Circana Liquid Data API — Consumer Panel. 2 operations. Lead operation: Circana Get Consumer Purchase Data.
    Self-contained Naftiko capability covering one Circana business surface.'
  tags:
  - Circana
  - Consumer Panel
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    CIRCANA_API_KEY: CIRCANA_API_KEY
capability:
  consumes:
  - type: http
    namespace: liquid-data-consumer-panel
    baseUri: https://api.circana.com/liquid-data/v1
    description: Circana Liquid Data API — Consumer Panel business capability. Self-contained, no shared references.
    resources:
    - name: consumer-panel-purchases
      path: /consumer-panel/purchases
      operations:
      - name: getconsumerpurchases
        method: GET
        description: Circana Get Consumer Purchase Data
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: category_id
          in: query
          type: string
          description: Product category identifier
          required: true
        - name: start_date
          in: query
          type: string
          description: Start date for the data range
          required: true
        - name: end_date
          in: query
          type: string
          description: End date for the data range
          required: true
        - name: demographic
          in: query
          type: string
          description: Demographic segment filter
        - name: channel
          in: query
          type: string
          description: Purchase channel filter
        - name: offset
          in: query
          type: integer
          description: Pagination offset
        - name: limit
          in: query
          type: integer
          description: Maximum number of records to return
    - name: consumer-panel-segments
      path: /consumer-panel/segments
      operations:
      - name: getconsumersegments
        method: GET
        description: Circana Get Consumer Segments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: category_id
          in: query
          type: string
          description: Product category identifier
          required: true
        - name: segmentation_type
          in: query
          type: string
          description: Type of segmentation analysis
    authentication:
      type: bearer
      token: '{{env.CIRCANA_API_KEY}}'
  exposes:
  - type: rest
    namespace: liquid-data-consumer-panel-rest
    port: 8080
    description: REST adapter for Circana Liquid Data API — Consumer Panel. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/consumer-panel/purchases
      name: consumer-panel-purchases
      description: REST surface for consumer-panel-purchases.
      operations:
      - method: GET
        name: getconsumerpurchases
        description: Circana Get Consumer Purchase Data
        call: liquid-data-consumer-panel.getconsumerpurchases
        with:
          category_id: rest.category_id
          start_date: rest.start_date
          end_date: rest.end_date
          demographic: rest.demographic
          channel: rest.channel
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/consumer-panel/segments
      name: consumer-panel-segments
      description: REST surface for consumer-panel-segments.
      operations:
      - method: GET
        name: getconsumersegments
        description: Circana Get Consumer Segments
        call: liquid-data-consumer-panel.getconsumersegments
        with:
          category_id: rest.category_id
          segmentation_type: rest.segmentation_type
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: liquid-data-consumer-panel-mcp
    port: 9090
    transport: http
    description: MCP adapter for Circana Liquid Data API — Consumer Panel. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: circana-get-consumer-purchase-data
      description: Circana Get Consumer Purchase Data
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: liquid-data-consumer-panel.getconsumerpurchases
      with:
        category_id: tools.category_id
        start_date: tools.start_date
        end_date: tools.end_date
        demographic: tools.demographic
        channel: tools.channel
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: circana-get-consumer-segments
      description: Circana Get Consumer Segments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: liquid-data-consumer-panel.getconsumersegments
      with:
        category_id: tools.category_id
        segmentation_type: tools.segmentation_type
      outputParameters:
      - type: object
        mapping: $.