> ## Documentation Index > Fetch the complete documentation index at: https://docs.watchdog.no/llms.txt > Use this file to discover all available pages before exploring further. # Get claim and refund totals > Totals for the claims matching the list filters: claim counts, attached alerts by status and their impact, and refund_summary, the money recovered through refunds. Impact is what the alerts flag, not money refunded. To total what was recovered in a period, such as this year, set refunded_from and refunded_through: refund_summary then counts only refunds recorded in that window, and the counts and alert totals cover only the claims with such a refund. ## OpenAPI ````yaml /openapi.json get /v1/claims/metrics openapi: 3.1.0 info: title: Watchdog API version: 1.0.0 description: >- The Watchdog API is served from https://api.watchdog.no. Request bodies are limited to 2 MiB unless an endpoint says otherwise. Files are uploaded directly to storage, not through the API. servers: - url: https://api.watchdog.no description: Watchdog API security: [] paths: /v1/claims/metrics: get: tags: - Claims summary: Get claim and refund totals description: >- Totals for the claims matching the list filters: claim counts, attached alerts by status and their impact, and refund_summary, the money recovered through refunds. Impact is what the alerts flag, not money refunded. To total what was recovered in a period, such as this year, set refunded_from and refunded_through: refund_summary then counts only refunds recorded in that window, and the counts and alert totals cover only the claims with such a refund. operationId: getClaimMetrics parameters: - name: X-Organization-Id in: header required: false schema: type: string description: >- The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations. - name: fields in: query required: false schema: type: string description: >- Return only these fields, comma-separated; use dots for nested fields, such as counts.pending. Fields: total_count, counts, refund_summary, summary. - schema: type: string enum: - 'true' - 'false' description: >- Only records matched by the filters of teams you belong to. Teams combine with OR; other filters combine with AND. Cannot be combined with team_ids. required: false description: >- Only records matched by the filters of teams you belong to. Teams combine with OR; other filters combine with AND. Cannot be combined with team_ids. name: mine in: query - schema: type: string description: >- Only records matched by the filters of these teams: at most 50, comma-separated in a query string or an array in a JSON body. Teams combine with OR. Unknown teams return 404. required: false description: >- Only records matched by the filters of these teams: at most 50, comma-separated in a query string or an array in a JSON body. Teams combine with OR. Unknown teams return 404. name: team_ids in: query - schema: type: string description: Comma-separated, at most 50 values. required: false description: Comma-separated, at most 50 values. name: supplier_ids in: query - schema: type: string description: Comma-separated, at most 50 values. required: false description: Comma-separated, at most 50 values. name: agreement_ids in: query - schema: type: string description: 'Comma-separated: pending, in_progress, completed, cancelled.' required: false description: 'Comma-separated: pending, in_progress, completed, cancelled.' name: statuses in: query - schema: type: string description: Comma-separated, at most 50 values. required: false description: Comma-separated, at most 50 values. name: creator_user_ids in: query - schema: type: string minLength: 1 maxLength: 200 description: Text in the claim title or supplier name. required: false description: Text in the claim title or supplier name. name: search in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- Claims created on or after this calendar date in the organization's timezone. required: false description: >- Claims created on or after this calendar date in the organization's timezone. name: created_from in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- Claims created on or before this calendar date in the organization's timezone. required: false description: >- Claims created on or before this calendar date in the organization's timezone. name: created_through in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- Refunds recorded on or after this calendar date in the organization's timezone. Keeps only claims with such a refund, and refund_summary counts only those refunds. required: false description: >- Refunds recorded on or after this calendar date in the organization's timezone. Keeps only claims with such a refund, and refund_summary counts only those refunds. name: refunded_from in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- Refunds recorded on or before this calendar date in the organization's timezone. Keeps only claims with such a refund, and refund_summary counts only those refunds. required: false description: >- Refunds recorded on or before this calendar date in the organization's timezone. Keeps only claims with such a refund, and refund_summary counts only those refunds. name: refunded_through in: query responses: '200': description: Claim counts and amounts per currency. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: '#/components/schemas/ClaimMetrics' '400': description: >- The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: '#/components/schemas/Error_validation_error' example: error: code: validation_error message: >- The request is invalid. details lists up to 20 field errors. Request bodies are limited to 2 MiB. request_id: req_example '401': description: The bearer token is missing or invalid. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. WWW-Authenticate: schema: type: string required: false description: Bearer authentication challenge, when supplied. content: application/json: schema: $ref: '#/components/schemas/Error_invalid_token' example: error: code: invalid_token message: The bearer token is missing or invalid. request_id: req_example '403': description: >- Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: >- #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required example: error: code: forbidden message: >- Access denied. The error code says why: forbidden, token_disabled, organization_required, insufficient_role or mfa_required. request_id: req_example '404': description: The resource does not exist in the current organization. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: '#/components/schemas/Error_not_found' example: error: code: not_found message: The resource does not exist in the current organization. request_id: req_example '409': description: >- One or more selected teams have invalid saved filter rules. Update the team filters before retrying. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: '#/components/schemas/Error_conflict' example: error: code: conflict message: >- One or more selected teams have invalid saved filter rules. Update the team filters before retrying. request_id: req_example '429': description: Too many requests. Wait for the Retry-After delay before retrying. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. Retry-After: schema: type: string example: '60' required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/Error_rate_limit_exceeded' example: error: code: rate_limit_exceeded message: >- Too many requests. Wait for the Retry-After delay before retrying. request_id: req_example '500': description: >- Unexpected server failure. Include the request ID when contacting support. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. content: application/json: schema: $ref: '#/components/schemas/Error_internal_error' example: error: code: internal_error message: >- Unexpected server failure. Include the request ID when contacting support. request_id: req_example '503': description: >- Temporarily unavailable. Retry after the Retry-After delay, when provided. headers: X-Request-Id: schema: type: string required: true description: >- Request ID, also included in error bodies. Include it when contacting support. Cache-Control: schema: type: string enum: - private, no-store - private, no-store, no-transform required: false description: API responses are private and must not be cached. X-RateLimit-Limit: schema: type: string example: '500' required: false description: >- Requests allowed per minute for this credential, or failed API key attempts allowed per minute from this IP address. Retry-After: schema: type: string example: '60' required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/Error_service_unavailable' example: error: code: service_unavailable message: >- Temporarily unavailable. Retry after the Retry-After delay, when provided. request_id: req_example security: - ApiKeyBearer: [] components: schemas: ClaimMetrics: type: object properties: total_count: type: integer counts: type: object properties: pending: type: integer in_progress: type: integer completed: type: integer cancelled: type: integer required: - pending - in_progress - completed - cancelled refund_summary: type: object properties: refund_count: type: integer amount_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount required: - refund_count - amount_by_currency description: >- Refunds recorded on the claims: the money recovered, per refund currency. When a list or totals read sets refunded_from or refunded_through, only refunds recorded in that window. summary: type: object properties: total: type: object properties: alert_count: type: integer impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: Alert impact per original currency. required: - alert_count - impact_by_currency description: All alerts in the claim. by_verdict: type: object properties: pending: type: object properties: credited: type: object properties: alert_count: type: integer impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: Alert impact per original currency. required: - alert_count - impact_by_currency uncredited: type: object properties: alert_count: type: integer impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: Alert impact per original currency. required: - alert_count - impact_by_currency required: - credited - uncredited accepted: type: object properties: credited: type: object properties: alert_count: type: integer impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: Alert impact per original currency. required: - alert_count - impact_by_currency uncredited: type: object properties: alert_count: type: integer impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: Alert impact per original currency. required: - alert_count - impact_by_currency required: - credited - uncredited dismissed: type: object properties: credited: type: object properties: alert_count: type: integer impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: Alert impact per original currency. required: - alert_count - impact_by_currency uncredited: type: object properties: alert_count: type: integer impact_by_currency: type: array items: type: object properties: currency_code: type: string amount: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: Alert impact per original currency. required: - alert_count - impact_by_currency required: - credited - uncredited required: - pending - accepted - dismissed description: >- Alerts by verdict, each split into credited and uncredited alerts. Credited amounts are alert impact, not recorded refunds. required: - total - by_verdict required: - total_count - counts - refund_summary - summary Error_validation_error: type: object properties: error: type: object properties: code: type: string enum: - validation_error message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_invalid_token: type: object properties: error: type: object properties: code: type: string enum: - invalid_token message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required: type: object properties: error: type: object properties: code: type: string enum: - forbidden - token_disabled - organization_required - insufficient_role - mfa_required message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_not_found: type: object properties: error: type: object properties: code: type: string enum: - not_found message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_conflict: type: object properties: error: type: object properties: code: type: string enum: - conflict message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_rate_limit_exceeded: type: object properties: error: type: object properties: code: type: string enum: - rate_limit_exceeded message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_internal_error: type: object properties: error: type: object properties: code: type: string enum: - internal_error message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_service_unavailable: type: object properties: error: type: object properties: code: type: string enum: - service_unavailable message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error securitySchemes: ApiKeyBearer: type: http scheme: bearer description: >- Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.