API to retrieve facets?

[colinrobinsonuib]

I see you can do faceted searches using the search api with srsearch but is it possible to to retrieve the facets that are generated for a search via an API?

[malberts]

This is not currently possible. Facets are generated only on the search page.

[colinrobinsonuib]

Thank you. I'm going to start working on this. I think it might be possible to use the existing elasticsearch API and call that directly. I'll post what I find here.

[colinrobinsonuib]

The search is for "john" with P1 (instance of) Q91 (human).

The aggregate is P55 (country of citizenship).

Here is an example of using the ES API directly to get the facet values.

curl -XPOST "elasticsearch:9200/_search" -H 'Content-Type: application/json' -d '{
    "size": 0,
    "query": {
      "bool": {
        "must": [
          { "match": { "all": "john" } },
          { "terms": { "wbfs_P1": [ "Q91" ] } }
        ]
      }
    },
    "aggs": {
      "P55": { "terms": { "field": "wbfs_P55", "size": 100 } }
    }
  }'

The ES API returns

{
   "took":8,
   "timed_out":false,
   "_shards":{
      "total":3,
      "successful":3,
      "skipped":0,
      "failed":0
   },
   "hits":{
      "total":{
         "value":14,
         "relation":"eq"
      },
      "max_score":null,
      "hits":[
         
      ]
   },
   "aggregations":{
      "P55":{
         "doc_count_error_upper_bound":0,
         "sum_other_doc_count":0,
         "buckets":[
            {
               "key":"Q365",
               "doc_count":6
            },
            {
               "key":"Q372",
               "doc_count":2
            },
            {
               "key":"Q366",
               "doc_count":1
            },
            {
               "key":"Q373",
               "doc_count":1
            },
            {
               "key":"Q389",
               "doc_count":1
            },
            {
               "key":"Q93",
               "doc_count":1
            }
         ]
      }
   }
}

The response is:

• 6 Q365 (United States)
• 2 Q372 (Australia)
• 1 Q366 (United Kingom)

exactly like is rendered on the search page

[colinrobinsonuib]

The API now exists. Moving conversations to the PR #279