Aggregation APi in Ibexa DXP by Adam Wójs
0 likes•669 views
The document provides an overview of the Aggregation API in Ibexa DXP, detailing its purpose for summarizing data and various use cases such as repository metrics, product reviews, tag clouds, and faceted search. It outlines the process for using the API, the types of aggregations available, and includes examples of queries for statistics and other functions. Additionally, it invites feedback and offers links for further information.
Aggregation APi in Ibexa DXP by Adam Wójs
- 1. December 9, 2020 www.ibexa.co Aggregation API in Ibexa DXP Presenters: Adam Wójs, Jani Tarvainen
- 2. Presenter Name Agenda 1. What is Aggregation API? 2. Use Case: Repository metrics 3. Use Case: Product reviews page 4. Use Case: Tag cloud 5. Use Case: Faceted search 6. Q&A
- 3. What is Aggregation API ? Aggregation API is API which allows you to summarize your data
- 4. How to use Aggregation API? 1. Build content/location search query 2. Attach one or more Aggregation Definitions to query 3. Execute 4. Process results
- 5. How to use Aggregation API? Sandboxdemo AppCommandSandboxCommand
- 6. Aggregations classification Aggregation result: • Stats aggregation • Term aggregation • Range aggregation Aggregation subject: • Content model based • Content info • Location • Field • Raw aggregations • ...
- 7. Aggregations naming convention eZPublishAPIRepositoryValuesContentQueryAggregation <Subject><Result Type>Aggregation Examples: ContentTypeTermAggregation, IntegerStatsAggregation, IntegerRangeAggregation
- 8. Use Case: Repository metrics
- 9. Use Case: Repository metrics Answer the following questions: • What is min/max/avg depth / priority of location in our content tree? • What is min/max/avg content object version of specified type ? • What is % of content translations for specific language ?
- 10. Use Case: Repository metrics Repository metrics demo AppCommandRepositoryMetricsCommand
- 11. Use Case: Product reviews page
- 12. Use Case: Product reviews page Display product information, 10 recent reviews with summary: number of reviews and average rate We assume that: • Review is content object with author name, rate and optional comment fields • Reviews are placed under Product main location
- 13. What is Stats aggregation? Calculates basic statistics metrics: min(value), max(value), avg(value), sum(value), count(value)
- 14. Stats aggregation as SQL statement SELECT min(field), max(field), avg(field), sum(field), count(field) FROM documents
- 15. Use Case: Product reviews page Product reviews demo
- 16. Use Case: Tag cloud
- 17. Use Case: Tag cloud Our goal is to render tag cloud based on keyword field We assume that: • Keywords are sorted alphabetically • The more occurrence of given keyword, then the bigger font size used to render keyword • Font size is always between some specified range e.g., 10px to 40px
- 18. What is Term aggregation? Groups documents by field and return number of documents for each unique value
- 19. Term aggregation as SQL statement SELECT value, count(value) FROM documents GROUP BY value
- 20. Use Case: Tag cloud Tag cloud demo
- 21. Use Case: Faceted search
- 22. Use Case: Faceted search Our goal is to allow user to narrow down search results by applying one or multiple filters. • Content type • Section • Creation date (1/7/14/30 days ago)
- 23. What is Range aggregation? For each specified range computes the number of documents containing value within this range.
- 24. Range aggregation as SQL statement SELECT count(value) FROM documents WHERE value >= A and value < B SELECT count(value) FROM documents WHERE value >= X and value < Y SELECT count(value) FROM documents WHERE value >= ...
- 25. Use Case: Faceted search Faceted search demo