> ## 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 alert totals ## OpenAPI ````yaml /openapi-preview.json get /v1/alerts/metrics openapi: 3.1.0 info: title: Watchdog API (preview) version: 1.0.0 description: >- Development preview for agreements, price items, document relationships, canonical invoices, alerts and alert topics, claims and attached alerts, shared entity activity and comments, Document uploads, invoice imports, explicit invoice-agreement matching, and workflow runs. This contract is under development and is not served by api.watchdog.no. Request bodies are limited to 2 MiB (2,097,152 bytes), including all JSON fields and line data, except POST /v1/support/contact which permits 32 MiB for base64 attachments. File bytes are uploaded directly to storage. The existing public REST service retains its separate contract. servers: - url: http://localhost:3500 description: Local development Worker security: [] paths: /v1/alerts/metrics: get: tags: - Alerts summary: Get alert totals operationId: getAlertMetrics parameters: - name: X-Organization-Id in: header required: false schema: type: string description: >- Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization. - schema: type: string enum: - 'true' - 'false' description: >- Match the shared teams the authenticated user belongs to in this organization. Teams combine with OR; other filters combine with AND. No memberships or saved rules means no matches. Cannot be combined with team_ids when true. required: false description: >- Match the shared teams the authenticated user belongs to in this organization. Teams combine with OR; other filters combine with AND. No memberships or saved rules means no matches. Cannot be combined with team_ids when true. name: mine in: query - schema: type: string description: >- Shared team IDs (maximum 50; comma-separated in a query string, a JSON array in a command body). Teams combine with OR. Missing, foreign, or personal teams return 404; invalid saved rules return 409. required: false description: >- Shared team IDs (maximum 50; comma-separated in a query string, a JSON array in a command body). Teams combine with OR. Missing, foreign, or personal teams return 404; invalid saved rules return 409. name: team_ids in: query - schema: type: string description: >- Match alerts currently attached to any selected claim; null matches alerts in no claim. Removed or transferred attachments are excluded. Claim status does not restrict matches; use claim_statuses. required: false description: >- Match alerts currently attached to any selected claim; null matches alerts in no claim. Removed or transferred attachments are excluded. Claim status does not restrict matches; use claim_statuses. name: claim_ids in: query - schema: type: string enum: - 'true' - 'false' description: >- Use false to select alerts that are not currently attached to any claim. required: false description: >- Use false to select alerts that are not currently attached to any claim. name: has_claim in: query - schema: type: string description: Match alerts whose current claim has any of these statuses. required: false description: Match alerts whose current claim has any of these statuses. name: claim_statuses in: query - schema: type: string required: false name: invoice_ids in: query - schema: type: string description: Leave out alerts on any of these invoices. required: false description: Leave out alerts on any of these invoices. name: excluded_invoice_ids in: query - schema: type: string required: false name: agreement_ids in: query - schema: type: string description: Leave out alerts for any of these agreements. required: false description: Leave out alerts for any of these agreements. name: excluded_agreement_ids in: query - schema: type: string required: false name: supplier_ids in: query - schema: type: string description: Leave out alerts for any of these suppliers. required: false description: Leave out alerts for any of these suppliers. name: excluded_supplier_ids in: query - schema: type: string required: false name: recipient_ids in: query - schema: type: string description: >- Leave out alerts on invoices for any of these recipients. Alerts on invoices without a recipient still match. required: false description: >- Leave out alerts on invoices for any of these recipients. Alerts on invoices without a recipient still match. name: excluded_recipient_ids in: query - schema: type: string required: false name: tag_ids in: query - schema: type: string description: >- Match alerts in any selected topic; null matches uncategorized alerts. required: false description: >- Match alerts in any selected topic; null matches uncategorized alerts. name: topic_ids in: query - schema: type: string description: >- Leave out alerts in any of these topics. Uncategorized alerts still match. required: false description: >- Leave out alerts in any of these topics. Uncategorized alerts still match. name: excluded_topic_ids in: query - schema: type: string enum: - 'true' - 'false' description: Use false to select uncategorized alerts. required: false description: Use false to select uncategorized alerts. name: has_topic in: query - schema: type: string required: false name: statuses in: query - schema: type: string description: >- Match any listed confidence level; null matches alerts without one. required: false description: Match any listed confidence level; null matches alerts without one. name: confidence_levels in: query - schema: type: string required: false name: currency_codes in: query - schema: type: string required: false name: correction_types in: query - schema: type: string enum: - current - outdated - unknown required: false name: freshness in: query - schema: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ description: >- Minimum impact in the organization currency, inclusive. Alerts without an impact never match. required: false description: >- Minimum impact in the organization currency, inclusive. Alerts without an impact never match. name: impact_min in: query - schema: type: string maxLength: 100 pattern: ^-?\d+(?:\.\d+)?$ description: >- Maximum impact in the organization currency, inclusive. Alerts without an impact never match. required: false description: >- Maximum impact in the organization currency, inclusive. Alerts without an impact never match. name: impact_max in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Invoice issued on or after this date. required: false description: Invoice issued on or after this date. name: issued_from in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: Invoice issued on or before this date. required: false description: Invoice issued on or before this date. name: issued_through in: query - schema: type: string pattern: ^\d{4}-\d{2}-\d{2}$ description: >- Created on or after this calendar date in the organization's timezone. required: false description: >- 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: >- Created on or before this calendar date in the organization's timezone. required: false description: >- Created on or before this calendar date in the organization's timezone. name: created_through in: query - schema: type: string minLength: 1 maxLength: 200 description: >- Matches, ignoring case, the alert title, explanation and expected line; the supplier; the invoice number, title and line; the agreement title; or the topic title and description. A UUID also matches the alert, invoice, supplier or agreement ID. required: false description: >- Matches, ignoring case, the alert title, explanation and expected line; the supplier; the invoice number, title and line; the agreement title; or the topic title and description. A UUID also matches the alert, invoice, supplier or agreement ID. name: search in: query responses: '200': description: >- Counts, distinct invoices, and amounts per currency and in the organization currency, using the same filters as the alert list. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: '#/components/schemas/AlertMetrics' '400': description: >- Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes). headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: '#/components/schemas/Error_validation_error' example: error: code: validation_error message: >- Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes). request_id: req_example '401': description: Missing or invalid bearer credential. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. 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: Missing or invalid bearer credential. request_id: req_example '403': description: >- Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: >- #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required example: error: code: forbidden message: >- Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions. 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 identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. 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 identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. 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: The IP or authenticated credential exceeded its request limit. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. 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: >- The IP or authenticated credential exceeded its request limit. 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 identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. 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: >- Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. 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: >- Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided. request_id: req_example security: - ApiKeyBearer: [] - ClerkSessionBearer: [] components: schemas: AlertMetrics: type: object properties: total_count: type: integer invoice_count: type: integer description: Distinct invoices among the matching alerts. counts: type: object properties: pending: type: integer minimum: 0 claimed: type: integer minimum: 0 dismissed: type: integer minimum: 0 credited: type: integer minimum: 0 required: - pending - claimed - dismissed - credited currencies: type: array items: type: object properties: currency_code: type: string alert_count: type: integer missing_amount_count: type: integer impact_amount: type: string pattern: ^-?\d+(?:\.\d+)?$ description: >- Sum of known alert impacts. Null impacts contribute zero; missing_amount_count records how many were omitted. required: - currency_code - alert_count - missing_amount_count - impact_amount organization_currency: type: object properties: currency_code: type: string description: The organization's reporting currency from its settings. impact_amount: type: string pattern: ^-?\d+(?:\.\d+)?$ missing_amount_count: type: integer impact_by_status: type: object properties: pending: type: string pattern: ^-?\d+(?:\.\d+)?$ claimed: type: string pattern: ^-?\d+(?:\.\d+)?$ credited: type: string pattern: ^-?\d+(?:\.\d+)?$ dismissed: type: string pattern: ^-?\d+(?:\.\d+)?$ required: - pending - claimed - credited - dismissed required: - currency_code - impact_amount - missing_amount_count - impact_by_status description: >- Impact converted with the rate stored on each alert. Alerts without a converted impact contribute zero and are counted in missing_amount_count. required: - total_count - invoice_count - counts - currencies - organization_currency 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. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission. ClerkSessionBearer: type: http scheme: bearer description: Clerk session with an active organization. ````