Aggregate Match Statistics API
AvailableScores up to 100 star pairs and returns the average, best and lowest, a count by verdict and every pair ranked.
Call it with POST /v1/matching/aggregate-match. Input: specific input. Output: JSON, as a direct response. Each successful call costs 1 credit.
- Endpoint
- POST /v1/matching/aggregate-match
- Input
- Specific input
- Output
- JSON
- Delivery
- Direct response
- Cost
- 1 credit
- Compute class
- Standard
Example response
Fields in data (inferred from the example)
pairs· integeraverage_total· numbermaximum· integeraverage_percentage· numberbest· objectlowest· objectverdicts· objectranked· array of object
Example response
Captured from the live engine with a sandbox key (so credits_used is 0) and trimmed: long arrays keep their first items and images are replaced by a placeholder.
Loading the example…
Request schema and every field: the Compatibility matching reference.
Aggregate Match Statistics API: common questions
What does the Aggregate Match Statistics API return?
Scores up to 100 star pairs and returns the average, best and lowest, a count by verdict and every pair ranked. The response's data object includes pairs, average_total, maximum, average_percentage, best, lowest, verdicts and ranked. See the reference for an example response.
What input does Aggregate Match Statistics need?
Specific input.
How much does a Aggregate Match Statistics call cost?
1 credit per successful call; a failed call is not charged. Plans and top-ups are on the pricing page.
Can I try it before paying?
Yes. Every account gets sandbox keys and trial credits, so you can call it from your own code before choosing a plan.