Revisit API design [PL-API10] about pelias

[riordan]

same as #41

[missinglink]

it would be nice to return the 'total matched results' despite the page length being set to 1-40, this is nice to have in order to derive a 'total pages' count and also for analytics, like 'how many mcdonalds in this bbox' (which is actually quite hard to do with other databases/engines)

eg.

• page length: 40
• results in this page: 40
• total pages: 12
• total results matched: 451

note: some of these values can be computed by the client and some can be returned from the server, the minimum the server should return is "total results" as the others can be inferred from the data and the query params/defaults.

[riordan]

+1 to @missinglink's suggestion

I think you've stubbed out what that would/should look like quite nicely and opens up some more questions like:

• How would one paginate from those maximum number of results? Would they reformulate a query and ask for that total number of results?
• Is that a fundamentally different kind of question from Geocoding? It's certainly a kind of question that our dataset should be capable of answering.
• Would we be able to surface the match count without much of a performance impact?

[missinglink]

we get the total count for free, no additional logic would be required outside the code to expose it in the API