Displays the matching trends over the previous 12 months by default, or over the date range specified.

GET /reports/match-rate-trends

Oauth2

Query parameters

startDate string(date-time)

An optional start date of the report. If not specified, defaults to the first of the month, twelve months ago. If specified, end date is required and must be after the start date. For accuracy of reports which summarize by month, the start date should be the first day of the month. The range is inclusive of this date. Must be in ISO 8601 compliant format yyyy-MM-dd (for April first: 2025-04-01).
endDate string(date-time)

An optional end date of the report. If not specified, defaults to the first day of the current month. If specified, start date is required and must be before the end date. For accuracy of reports which summarize by month, the end date should be the first day of the month after the last month in the report.
The range is *EX*clusive of this date. Must be in ISO 8601 compliant format yyyy-MM-dd (for April first: 2025-04-01).

Responses

200 application/json

The match rate trends (auto vs. manual matches and unmatched) over the date range.
Hide response attributes Show response attributes object
- averageAutoMatchRate number
  
  The average auto match rate across all months.
- averageManualMatchRate number
  
  The average manual match rate across all months.
- averageTotalMatchRate number
  
  The average total match rate across all months.
- monthlyTrends array[object]
  
  Monthly breakdown of the the matching trends.
  
  Represents a time period (month/year) for the matching (manual vs. auto) trends over time.
  
  Hide monthlyTrends attributes Show monthlyTrends attributes object
  
  year integer(int32)
  
  The year of the transaction effective date.
  
  month integer(int32)
  
  The month of the transaction effective date (1 = JAN, 2 = FEB ... 12 = DEC).
  
  manualCount integer(int64)
  
  The number of transactions matched manually during this time period.
  
  autoCount integer(int64)
  
  The number of transactions matched automatically during this time period.
  
  unmatchedCount integer(int64)
  
  The number of transactions without a match during this time period.
  
  unmatchedRate number
  
  autoMatchRate number
  
  manualMatchRate number
  
  totalMatchRate number

GET /reports/match-rate-trends

curl \
 --request GET 'https://usaapi02.cadencyservices.trintech.com/test/api/reports/match-rate-trends' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "averageAutoMatchRate": 42.0,
  "averageManualMatchRate": 42.0,
  "averageTotalMatchRate": 42.0,
  "monthlyTrends": [
    {
      "year": 42,
      "month": 42,
      "manualCount": 42,
      "autoCount": 42,
      "unmatchedCount": 42,
      "unmatchedRate": 42.0,
      "autoMatchRate": 42.0,
      "manualMatchRate": 42.0,
      "totalMatchRate": 42.0
    }
  ]
}