Zinnia

Zinnia Metrics API

Get policy metrics

Documentation GitHub OpenAPI

Operations 1

POST /policy/v1/policies/{planCode}/{policyNumber}/metrics Policy Metrics #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/zinnia:zinnia-metrics-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Policy Service Metrics API
  description: Enterprise level policy service
  version: 0.0.21
  contact: {}
servers:
- url: https://api.zinnia.io
tags:
- name: Metrics
  description: Get policy metrics
paths:
  /policy/v1/policies/{planCode}/{policyNumber}/metrics:
    post:
      operationId: Metrics
      summary: Policy Metrics
      parameters:
      - name: planCode
        required: true
        in: path
        schema:
          type: string
      - name: policyNumber
        required: true
        in: path
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PolicyMetricsRequest'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PolicyMetricsResponse'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsErrorResponse'
        '500':
          description: Unexpected error occured, please check server logs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MetricsErrorResponse'
      security:
      - Auth0: []
      tags:
      - Metrics
components:
  schemas:
    PolicyMetricsRequest:
      type: object
      properties:
        startDate:
          type: string
          description: Start Date
          example: '2024-02-02'
        endDate:
          type: string
          description: End Date
          example: '2024-02-02'
        metrics:
          type: array
          items:
            $ref: '#/components/schemas/MetricsType'
    MetricsErrorResponse:
      type: object
      properties:
        timestamp:
          type: string
          format: date-time
          example: '2024-03-29T16:40:17.935761Z'
        message:
          type: string
          example: Invalid date range provided
    PolicyMetricsResponse:
      type: object
      properties:
        metric:
          type: string
          example: LAPSEPROTECTIONPAYMENTAMOUNT
          description: Requested metric
        begin:
          type: number
          format: double
          example: 28.44
          description: TBD
        minimum:
          type: number
          format: double
          example: 28.44
          description: TBD
        maximum:
          type: number
          format: double
          example: 28.44
          description: TBD
        average:
          type: number
          format: double
          example: 28.44
          description: TBD
        sum:
          type: number
          format: double
          example: 8389.8
          description: TBD
        count:
          type: integer
          format: int64
          example: 295
          description: TBD
        end:
          type: number
          format: double
          example: 28.44
          description: TBD
    MetricsType:
      type: string
      enum:
      - LAPSEPROTECTIONPAYMENTAMOUNT
      - ACCOUNTSURRENDERVALUE
      - ACCOUNTVALUE
      - COSTOFINSURANCE
      - NETDEATHBENEFIT
      - EXPENSECHARGE
      - UNITEXPENSECHARGE
      - INTERESTCREDITRATE
      - LOANREPAYMENTONETIMEAMOUNT
      - SYSTEMATICLOANREPAYMENTAMOUNT
      - INTERESTCREDITAMOUNT
      - INTERESTLOANAMOUNT
      - PARTIALWITHDRAWALONETIMEAMOUNT
      - INITIALPREMIUMAMOUNT
      - SUBSEQUENTPREMIUMAMOUNT
      - ONETIMEPREMIUMAMOUNT
      - NEWLOANAMOUNT
      - TOTALLOANBALANCE
      - TOTALCOVERAGEAMOUNT
      - CUMULATIVEGROSSDEATHBENEFITAMOUNT
      - CUMULATIVEPREMIUMSINCEISSUE
      - COVERAGECHARGE
      - COVERAGECREDIT
      - INITIALPREMIUMCALCULATEDAMOUNT
      - SUBSEQUENTPREMIUMCALCULATEDAMOUNT
      - ONETIMEPREMIUMCALCULATEDAMOUNT
      - SYSTEMATICWITHDRAWALAMOUNT
      - FULLSURRENDERCHARGE
      - PARTIALWITHDRAWALONETIMESURRENDERCHARGE
      - SYSTEMATICWITHDRAWALSURRENDERCHARGE
      - REQUIREDMINIMUMDISTRIBUTIONONETIMESURRENDERCHARGE
      - ANNUITIZATIONPREMIUMTAXCHARGE
      - DEATHPREMIUMTAXCHARGE
      - FULLSURRENDERPREMIUMTAXCHARGE
      - FULLSURRENDERMARKETVALUEADJUSTMENTCHARGE
      - PARTIALWITHDRAWALONETIMEMARKETVALUEADJUSTMENTCHARGE
      - SYSTEMATICWITHDRAWALMARKETVALUEADJUSTMENTCHARGE
      - REQUIREDMINIMUMDISTRIBUTIONONETIMEMARKETVALUEADJUSTMENTCHARGE
      - SYSTEMATICREQUIREDMINIMUMDISTRIBUTIONMARKETVALUEADJUSTMENTCHARGE
      - RIDERCHARGE
      - FIXEDINTERESTCREDITAMOUNT
      - INDEXCREDITAMOUNT
      - INITIALPREMIUMPAYMENTCHARGE
      - SUBSEQUENTPREMIUMPAYMENTCHARGE
      - ONETIMEPREMIUMPAYMENTCHARGE
      - PREMIUMTAXAMOUNT
      - FULLSURRENDERAMOUNT
      - REQUIREDMINIMUMDISTRIBUTIONONETIMEAMOUNT
      - SYSTEMATICREQUIREDMINIMUMDISTRIBUTIONAMOUNT
      - SYSTEMATICREQUIREDMINIMUMDISTRIBUTIONSURRENDERCHARGE
      - CURRENTBASE
      - HYPOTHETICALANNUALLIMIT
      - RATCHETBASE
      - GROWTHBASE
      - DEFERRALBONUS
      - DEFERRALBONUSBASE
      - SIMPLEINTERESTBASE
      - REMAININGBENEFIT
      - NETDECREASEINFACEAMOUNT
      - NETINCREASEINFACEAMOUNT
  securitySchemes:
    Auth0:
      type: openIdConnect
      openIdConnectUrl: https://login.zinnia.com/.well-known/openid-configuration
      x-kong-security-openid-connect:
        config:
          issuer: https://login.zinnia.com/.well-known/openid-configuration
          extra_jwks_uris:
          - https://login.mypolicyview.com/.well-known/jwks.json
          issuers_allowed:
          - https://login.zinnia.com/
          - https://login.mypolicyview.com/
          run_on_preflight: true
          scopes_claim:
          - https://api.zinnia.io/permissions
          audience_claim:
          - aud
          audience_required:
          - https://api.zinnia.io
          auth_methods:
          - bearer
          scopes: []
        enabled: true
        protocols:
        - grpc
        - grpcs
        - http
        - https