ROroarkhq
Metric Policy

Create a metric policy

Changed on

Creates a new metric policy. Policies define which metrics to collect and under what conditions.

post/v1/metric/policies

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/metric/policies
  • Auth
    HTTP bearer

Request body

namestring required

Name of the metric policy

status'ACTIVE' | 'INACTIVE'

Status of the policy (default: ACTIVE)

modality'call' | 'chat' required

Modality this policy targets. A policy fires for exactly one modality and can only reference metrics that support that modality.

Example request

{
  "name": "Evaluate all inbound calls",
  "status": "ACTIVE",
  "modality": "call"
}

Response

The created metric policy

Changes

  • c967f955e67aRevision changes
    • info

      added the new optional request property //

    • info

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

  • 887b091b3d81Revision changes
    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new conflict enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status

    • warning

      added the new payment_required enum value to the response property for the response status