Match rate

GET /reports/match-rates
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

    statistics on the number of transactions that are matched, unmatched, and automatically matched.

    Hide response attributes Show response attributes object
    • totalCount integer(int64)

      Derived value: totalMatchCount + unmatchedCount. The number of transactions in the system.

    • autoMatchedCount integer(int64)

      The number of automatically matched transactions in the system.

    • manualMatchedCount integer(int64)

      The number of manually matched transactions in the system.

    • totalMatchedCount integer(int64)

      Derived value: auto + manual matched transactions.

    • unmatchedCount integer(int64)

      The number of unmatched transactions in the system.

    • matchRate integer(int32)

      Derived value: totalMatchedCount / totalCount. The percentage from 0 .. 100 of transactions that are matched.
GET /reports/match-rates 
curl \
 --request GET 'https://usaapi02.cadencyservices.trintech.com/test/api/reports/match-rates' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "totalCount": 42,
  "autoMatchedCount": 42,
  "manualMatchedCount": 42,
  "totalMatchedCount": 42,
  "unmatchedCount": 42,
  "matchRate": 42
}