Export selected alerts

curl --request GET \
  --url https://api.watchdog.no/v1/alerts/export \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.watchdog.no/v1/alerts/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<string>

{
  "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"
  }
}

{
  "error": {
    "code": "invalid_token",
    "message": "The bearer token is missing or invalid.",
    "request_id": "req_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"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The resource does not exist in the current organization.",
    "request_id": "req_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"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Wait for the Retry-After delay before retrying.",
    "request_id": "req_example"
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "Unexpected server failure. Include the request ID when contacting support.",
    "request_id": "req_example"
  }
}

{
  "error": {
    "code": "service_unavailable",
    "message": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
    "request_id": "req_example"
  }
}

Export selected alerts

curl --request GET \
  --url https://api.watchdog.no/v1/alerts/export \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.watchdog.no/v1/alerts/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<string>

{
  "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"
  }
}

{
  "error": {
    "code": "invalid_token",
    "message": "The bearer token is missing or invalid.",
    "request_id": "req_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"
  }
}

{
  "error": {
    "code": "not_found",
    "message": "The resource does not exist in the current organization.",
    "request_id": "req_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"
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Wait for the Retry-After delay before retrying.",
    "request_id": "req_example"
  }
}

{
  "error": {
    "code": "internal_error",
    "message": "Unexpected server failure. Include the request ID when contacting support.",
    "request_id": "req_example"
  }
}

{
  "error": {
    "code": "service_unavailable",
    "message": "Temporarily unavailable. Retry after the Retry-After delay, when provided.",
    "request_id": "req_example"
  }
}

Authorizations

Authorization

string

header

required

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).

Headers

X-Organization-Id

string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Query Parameters

mine

enum<string>

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.

Available options:

true,

false

team_ids

string

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.

claim_ids

string

Match alerts in any of these claims; null matches alerts in no claim.

has_claim

enum<string>

Use false to select alerts that are not currently attached to any claim.

Available options:

true,

false

claim_statuses

string

Match alerts whose current claim has any of these statuses: pending, in_progress, completed, cancelled.

join_operator

enum<string>

Combine invoice, agreement, supplier, recipient and topic ID filters with AND (default) or OR. Tenant, validity, search and other filters always apply.

Available options:

and,

or

invoice_operator

enum<string>

Available options:

is,

is_not

agreement_operator

enum<string>

Available options:

is,

is_not

supplier_operator

enum<string>

Available options:

is,

is_not

recipient_operator

enum<string>

Available options:

is,

is_not

topic_operator

enum<string>

Available options:

is,

is_not

invoice_ids

string

Comma-separated, at most 50 values.

agreement_ids

string

Comma-separated, at most 50 values.

agreement_statuses

string

Match alerts whose agreement has any of these statuses: draft, active, archived.

supplier_ids

string

Comma-separated, at most 50 values.

recipient_ids

string

Comma-separated, at most 50 values.

tag_ids

string

Comma-separated, at most 50 values.

topic_ids

string

Match alerts in any selected topic; null matches uncategorized alerts.

has_topic

enum<string>

Use false to select uncategorized alerts.

Available options:

true,

false

verdicts

string

Match alerts with any of these verdicts, whatever their credit: pending, accepted, dismissed. pending means no decision yet.

credited

enum<string>

Match alerts with or without a credit, regardless of verdict.

Available options:

true,

false

credit_sources

string

Match credit provenance: credit_note, user. null selects alerts without a credit.

confidence_levels

string

Match any listed confidence level: certain, uncertain. null matches alerts without one.

currency_codes

string

Comma-separated, at most 50 values.

correction_types

string

Match any of these correction types: modify_item, modify_invoice, add_item.

changed_since_check

enum<string>

true matches alerts whose agreement or invoice changed after the check that found them; false matches alerts whose inputs are unchanged. Alerts that do not record what they assessed match neither.

Available options:

true,

false

validity

enum<string>

live (default) returns alerts that count; invalidated returns alerts that stopped counting, for example because their invoice no longer matches the agreement. Alerts in claims named by claim_ids are included either way.

Available options:

live,

invalidated,

all

impact_min

string

Minimum impact in the organization currency, inclusive. Alerts without an impact never match.

Maximum string length: 100

Pattern: ^-?\d+(?:\.\d+)?$

impact_max

string

Maximum impact in the organization currency, inclusive. Alerts without an impact never match.

Maximum string length: 100

Pattern: ^-?\d+(?:\.\d+)?$

issued_from

string

Invoice issued on or after this date.

Pattern: ^\d{4}-\d{2}-\d{2}$

issued_through

string

Invoice issued on or before this date.

Pattern: ^\d{4}-\d{2}-\d{2}$

created_from

string

Created on or after this calendar date in the organization's timezone.

Pattern: ^\d{4}-\d{2}-\d{2}$

created_through

string

Created on or before this calendar date in the organization's timezone.

Pattern: ^\d{4}-\d{2}-\d{2}$

string

Case-insensitive search across alert, invoice, supplier, agreement and topic text. A UUID matches the alert, invoice, supplier or agreement ID.

Required string length: 1 - 200

format

enum<string>

default:csv

xlsx adds a Topics sheet with the topics of the exported alerts.

Available options:

csv,

xlsx

Response

The export file. Content type follows format.

The response is of type file.

Start here

Understand your data

Endpoints

Export selected alerts

Authorizations

Headers

Query Parameters

Response