Documentation

Vendor Analytics

List aggregated vendor spend, invoice counts, average amounts, and last-seen timestamps.


GET/v1/analytics/vendorsPro

Vendor analytics are available on Pro and Business. The endpoint returns the vendor aggregate list for the authenticated workspace.

Request

Use GET /v1/analytics/vendors to retrieve the current aggregate list.

curl https://api.parsurai.com/v1/analytics/vendors \
  -H "X-API-Key: $PARSURAI_API_KEY"

The current public endpoint does not accept sorting, pagination, or vendor-detail path parameters.

Unsupported query parameters such as sort, order, cursor, or vendor-detail IDs are ignored by the current public router. Apply sorting and filtering in your client after receiving items.

Response

{
  "items": [
    {
      "vendor_profile_id": "6d1f95cd-8d8e-4ee1-a2ab-7f81413c7a9f",
      "display_name": "Supplier Inc.",
      "invoice_count": 14,
      "total_spend": {
        "amount": "14200.00",
        "currency": "EUR"
      },
      "avg_amount": {
        "amount": "1014.28",
        "currency": "EUR"
      },
      "last_seen_at": "2026-06-12T14:20:00Z"
    }
  ]
}

Response Field Reference

FieldTypeDescription
itemsarrayVendor aggregates
items[].vendor_profile_idUUID stringVendor profile identifier
items[].display_namestringBest display name for the vendor
items[].invoice_countintegerNumber of invoices associated with the vendor
items[].total_spend.amountstringCumulative spend as a decimal string
items[].total_spend.currencystringCurrency code
items[].avg_amountobjectAverage invoice amount
items[].last_seen_atISO datetimeMost recent invoice timestamp for this vendor