> ## Documentation Index
> Fetch the complete documentation index at: https://docs.roark.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a metric policy

> Returns a specific metric policy with its conditions and metrics.



## OpenAPI

````yaml /api-reference/openapi.documented.json get /v1/metric/policies/{policyId}
openapi: 3.1.0
info:
  title: Roark Analytics API
  description: >-
    The Roark Analytics API gives you access to the same API that powers the
    award winning Roark Analytics platform.
  version: 1.0.0
servers:
  - description: Production
    url: https://api.roark.ai
security:
  - Bearer: []
tags:
  - name: Health
    x-displayName: Health
  - name: Authentication
    x-displayName: Current credential
  - name: Project API Key
    x-displayName: Project API keys
  - name: Personal API Key
    x-displayName: Personal API keys
  - name: Agent
    x-displayName: Agents
  - name: Agent Endpoint
    x-displayName: Endpoints
  - name: Tool
    x-displayName: Tools
  - name: Agent Setup
    x-displayName: Automatic test setup
  - name: Autoimprove
    x-displayName: Autoimprove
  - name: Customer Flow
    x-displayName: Customer flows
  - name: Customer Flow Folder
    x-displayName: Customer flow folders
  - name: Simulation Persona
    x-displayName: Personas
  - name: Simulation Environment
    x-displayName: Environments
  - name: Simulation Template
    x-displayName: Templates
  - name: Simulation Run Plan
    x-displayName: Plans
  - name: Simulation Run
    x-displayName: Runs
  - name: Simulation Tool Mock
    x-displayName: Tool mocks and fixtures
  - name: Metric
    x-displayName: Definitions
  - name: Metric Variant
    x-displayName: Variants
  - name: Metric Policy
    x-displayName: Policies
  - name: Metric Collection Job
    x-displayName: Collection jobs
  - name: Call
    x-displayName: Calls
  - name: Chat
    x-displayName: Chats
  - name: Customer
    x-displayName: Customers
  - name: Issue
    x-displayName: Issues
  - name: Analytics
    x-displayName: Analytics
  - name: Dashboard
    x-displayName: Dashboards
  - name: Live Report
    x-displayName: Reports
  - name: Agent Connection
    x-displayName: Agent platforms
  - name: Calendar Connection
    x-displayName: Calendars
  - name: MCP Server Connection
    x-displayName: MCP servers
  - name: Knowledge Base
    x-displayName: Knowledge bases
  - name: HTTP Request Definition
    x-displayName: HTTP request definitions
  - name: Webhook
    x-displayName: Webhooks
  - name: Config
    x-displayName: Config as code
  - name: Organization Project
    x-displayName: Projects
  - name: Organization Project Member
    x-displayName: Project members
  - name: Usage
    x-displayName: Usage
  - name: Benchmark
    x-displayName: Benchmarks
paths:
  /v1/metric/policies/{policyId}:
    get:
      tags:
        - Metric Policy
      summary: Get a metric policy
      description: Returns a specific metric policy with its conditions and metrics.
      operationId: getV1MetricPoliciesByPolicyId
      parameters:
        - name: policyId
          in: path
          required: true
          description: The ID of the metric policy to retrieve
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: The requested metric policy
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/MetricPolicyResponse'
                required:
                  - data
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Authentication error
              example:
                type: authentication
                code: unauthorized
                message: Authentication required
          description: Unauthorized
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Not found error
              example:
                type: not_found
                code: resource_not_found
                message: The requested resource could not be found
          description: Not Found
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Rate limit error
              example:
                type: rate_limit
                code: too_many_requests
                message: Rate limit exceeded
          description: Too Many Requests
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
                description: Server error
              example:
                type: internal
                code: internal_error
                message: Internal server error
          description: Internal Server Error
      x-codeSamples:
        - lang: JavaScript
          source: >-
            import Roark from '@roarkanalytics/sdk';


            const client = new Roark({
              bearerToken: process.env['ROARK_API_BEARER_TOKEN'], // This is the default and can be omitted
            });


            const response = await
            client.metricPolicy.getByID('182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e');


            console.log(response.data);
        - lang: Python
          source: |-
            import os
            from roark_analytics import Roark

            client = Roark(
                bearer_token=os.environ.get("ROARK_API_BEARER_TOKEN"),  # This is the default and can be omitted
            )
            response = client.metric_policy.get_by_id(
                "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
            )
            print(response.data)
components:
  schemas:
    MetricPolicyResponse:
      type: object
      properties:
        id:
          type: string
          format: uuid
          description: Unique identifier of the metric policy
        name:
          type: string
          description: Name of the metric policy
        type:
          type: string
          enum:
            - SYSTEM
            - USER
          description: Type of the metric policy (SYSTEM or USER)
        status:
          type: string
          enum:
            - ACTIVE
            - INACTIVE
          description: Status of the metric policy (ACTIVE or INACTIVE)
        conditions:
          type:
            - array
            - 'null'
          items:
            type: object
            properties:
              conditions:
                type: array
                items:
                  type: object
                  properties:
                    conditionType:
                      type: string
                      enum:
                        - AGENT
                        - CALL_SOURCE
                        - CALL_PROPERTY
                        - INTEGRATION
                      description: >-
                        Type of condition: AGENT (match by agent ID),
                        CALL_SOURCE (match by source e.g. VAPI, RETELL),
                        CALL_PROPERTY (match by call property key/value)
                    conditionKey:
                      type: string
                      description: >-
                        Key to match against. For AGENT: the agent ID. For
                        CALL_SOURCE: the source name. For CALL_PROPERTY: the
                        property key.
                    conditionOperator:
                      type:
                        - string
                        - 'null'
                      enum:
                        - EQUALS
                        - NOT_EQUALS
                        - CONTAINS
                        - STARTS_WITH
                        - GREATER_THAN
                        - LESS_THAN
                        - GREATER_THAN_OR_EQUALS
                        - LESS_THAN_OR_EQUALS
                      description: >-
                        Comparison operator. Required for CALL_PROPERTY
                        conditions.
                    conditionValue:
                      type:
                        - string
                        - 'null'
                      description: >-
                        Value to compare against. Required for CALL_PROPERTY
                        conditions.
                  required:
                    - conditionType
                    - conditionKey
                    - conditionOperator
                    - conditionValue
            required:
              - conditions
          description: >-
            Condition groups for this policy. Null means the policy matches all
            calls.
        metrics:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              settings:
                oneOf:
                  - $ref: '#/components/schemas/PolicyMetricSettings'
                  - type: 'null'
                description: >-
                  The metric's per-collector setting, or null when it runs with
                  its default
            required:
              - id
              - settings
          description: Metric definitions associated with this policy
        createdAt:
          type: string
          description: When the policy was created
        updatedAt:
          type: string
          description: When the policy was last updated
      required:
        - id
        - name
        - type
        - status
        - conditions
        - metrics
        - createdAt
        - updatedAt
      description: A metric policy defining when metrics should be collected
    ErrorResponse:
      type: object
      properties:
        type:
          type: string
          enum:
            - validation
            - authentication
            - forbidden
            - not_found
            - conflict
            - payment_required
            - rate_limit
            - internal
          description: The error type category
          examples:
            - validation
            - authentication
        code:
          type: string
          description: Machine-readable error code identifier
          examples:
            - invalid_parameter
            - missing_required_field
            - unauthorized
        message:
          type: string
          description: Human-readable error message
          examples:
            - The request was invalid
            - Authentication required
        param:
          type: string
          description: The parameter that caused the error (if applicable)
          examples:
            - email
            - user_id
        details:
          description: Additional error context information
      required:
        - type
        - code
        - message
    PolicyMetricSettings:
      type: object
      properties:
        verifiedProperties:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 200
          maxItems: 50
          description: >-
            Property Verification metrics: the conversation properties to check
            against the transcript. Empty or omitted checks every custom
            property.
        excludedPhrases:
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 200
          maxItems: 50
          description: >-
            Voice consistency metrics: phrases whose agent lines are not judged,
            such as a recorded prompt in a different voice.
        voicemailScript:
          type: string
          minLength: 1
          maxLength: 4000
          description: >-
            Voicemail metrics: the message the agent is expected to leave on
            voicemail.
        screeningBrief:
          type: string
          minLength: 1
          maxLength: 4000
          description: >-
            Call screening metrics: what the agent should say when a screener
            asks who is calling and why.
        toolDefinitionIds:
          type: array
          items:
            type: string
            format: uuid
          description: >-
            Tool invocation metrics: the tool definitions to score. Empty or
            omitted scores every tool the agent has.
        knowledgeBaseDocumentIds:
          type: array
          items:
            type: string
            format: uuid
          description: >-
            Knowledge grounding metrics: the knowledge base documents to ground
            against, in priority order. Empty or omitted uses every knowledge
            base in the project.
      additionalProperties: false
      description: >-
        The metric's per-collector setting. A metric takes at most one field,
        and which one depends on the metric: verifiedProperties for Property
        Verification, excludedPhrases for voice consistency, voicemailScript for
        voicemail, screeningBrief for call screening, toolDefinitionIds for tool
        invocation, knowledgeBaseDocumentIds for knowledge grounding. A field
        the metric doesn't take is rejected with a 400.
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.