{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/search/:typetype","auth":"required","method":"get","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\t\n\"aggregations\":\t\n[\t\n{\t\n\"key\":\t\n\"webpage_resource\"\t\n,\t\n\"doc_count\":\t\n67764\t\n}\t\n,\t\n{\t\n\"key\":\t\n\"multiple_choice_question\"\t\n,\t\n  \"doc_count\":\t\n11286\t\n}\t\n,\t\n{\t\n\"key\":\t\n\"text_resource\"\t\n,\t\n\"doc_count\":\t\n9767\t\n}\t\n,\t\n{\t\n\"key\":\t\n\"true_false_question\"\t\n,\t\n\"doc_count\":\t\n4870\t\n}\t\n,\t\n{\t\n\"key\":\t\n\"interactive_resource\"\t\n,\t\n\"doc_count\":\t\n2724\t\n}\t\n,\t\n{\t\n\"key\":\t\n\"video_resource\"\t\n,\t\n\"doc_count\":\t\n1980\t\n}\t\n,\t\n{\t\n\"key\":\t\n\"fill_in_the_blank_question\"\t\n,\t\n\"doc_count\":\t\n713\t\n}\t\n,\t\n{\t\n\"key\":\t\n\"image_resource\"\t\n,\t\n\"doc_count\":\t\n700\t\n}\t\n,\t\n{\t\n\"key\":\t\n\"multiple_answer_question\"\t\n,\t\n\"doc_count\":\t\n414\t\n}\t\n,\t\n{\t\n\"key\":\t\n\"hot_text_reorder_question\"\t\n,\t\n\"doc_count\":\t\n91\t\n}\t\n]\t\n,\t\n\"executionTime\":\t\n16\t\n,\t\n\"query\":\t\n{\t\n\"rewrittenQueryString\":\t\n\"*\"\t\n,\t\n\"userQueryString\":\t\n\"*\"\t\n}\t\n,\t\n\"stats\":\t\n{\t\n\"totalHitCount\":\t\n100527\t\n}\t\n}","name":""},{"status":401,"language":"text","code":""},{"status":500,"language":"json","code":"{\t\n\"aggregations\":\t\n[\t\n{\t\n\"key\":\t\"webpage_resource\",\t\n\"doc_count\":\t67764\t\n}\t,\t\n{\t\n\"key\":\t\"multiple_choice_question\",\n\"doc_count\":\t11286\t\n},\t\n{\t\n\"key\":\t\"text_resource\"\t,\t\n\"doc_count\":\t9767\t\n}\t,\t\n{\t\n\"key\":\t\"true_false_question\",\t\n\"doc_count\":\t4870\t\n},\t\n{\t\n\"key\":\t\"interactive_resource\",\t\n\"doc_count\":\t2724\t\n},\t\n{\t\n\"key\":\t\"video_resource\",\t\n\"doc_count\":1980\t\n},\t\n{\t\n\"key\":\t\"fill_in_the_blank_question\",\t\n\"doc_count\":713\t\n},\t\n{\t\n\"key\":\t\"image_resource\",\t\n\"doc_count\":700\t\n},\t\n{\t\n\"key\":\"multiple_answer_question\",\t\n\"doc_count\":\t414\t\n},\t\n{\t\n\"key\":\t\"hot_text_reorder_question\"\t,\t\n\"doc_count\":\t91\t\n}\t\n]\t,\t\n\"executionTime\":\t16\t,\t\n\"query\":\t\n{\t\n\"rewrittenQueryString\":\t\"*\"\t,\t\n\"userQueryString\":\t\"*\"\t\n}\t,\t\n\"stats\":\t\n{\t\n\"totalHitCount\":\t100527\t\n}\t\n}\t"}]},"settings":"","params":[{"name":"type","type":"string","default":"resource","desc":"","required":true,"in":"path","ref":"","_id":"5d43d8a359366f004f0fa064"},{"name":"q","type":"string","default":"","desc":"Query *\t-to get overall\t aggregation  Query keywords - to get aggregation of matching documents.","required":true,"in":"body","ref":"","_id":"5d43d8a359366f004f0fa063"},{"name":"aggBy","type":"string","default":"","desc":"String Field name to aggregate on\tHere,“contentSubFormat”","required":true,"in":"body","ref":"","_id":"5d43d8a359366f004f0fa062"},{"name":"aggSize","type":"int","default":"10","desc":"Limit of aggregated  values to\treturn.","required":false,"in":"body","ref":"","_id":"5d43d8a359366f004f0fa061"},{"name":"Authorization","type":"string","default":"Header","desc":"Token [access_token]","required":true,"in":"header","ref":"","_id":"5d43d8a359366f004f0fa060"}]},"next":{"description":"","pages":[]},"title":"Resource\tSubtype Aggregation API","type":"endpoint","slug":"resourcesubtype-aggregation-api","excerpt":"","body":"[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"aggregations\",\n    \"0-1\": \"JSON Array\",\n    \"0-2\": \"Array of object\",\n    \"h-0\": \"Key\",\n    \"h-1\": \"Data Type\",\n    \"h-2\": \"Description\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]","updates":[],"order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5d43d8a359366f004f0fa05f","project":"56439dfe9eebf70d00490d54","version":{"version":"2","version_clean":"2.0.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["5864d2df79ce642d00f0fec8","5864d2df79ce642d00f0fec9","5864d2df79ce642d00f0feca","5864d2df79ce642d00f0fecb","5864d2df79ce642d00f0fecc","5864d2df79ce642d00f0fecd","5864d2df79ce642d00f0fece","5864d2df79ce642d00f0fecf","5864d2df79ce642d00f0fed0","5864d2df79ce642d00f0fed1","5864d2df79ce642d00f0fed2","5864d2df79ce642d00f0fed3","5864d2df79ce642d00f0fed4","5864d2df79ce642d00f0fed5","5864d2df79ce642d00f0fed6","5864d2df79ce642d00f0fed7","5864d2df79ce642d00f0fed8","5864d2df79ce642d00f0fed9","5864d2df79ce642d00f0feda","5864d2df79ce642d00f0fedb","5864d2df79ce642d00f0fedc","5864d2df79ce642d00f0fedd","5864d2df79ce642d00f0fede","598aa64f4b6e990019b7a2d2","599bc76bc03fa2000f83db2a","599bcc3c3c5bf7000f3434fc","5d427dc9fa56fa0011135058","5d429c616863d5003af785a7","5d429e0889418f00c5e95d3f","5d42b5f098b05e003acb08b4","5d43c16985775c00ebeede3b","5d43d15446d584003da91e6d","5d43d61a5bdac50011b6f234","5d43d7c2db365100640dbc58","5d43d954bffa8400ff7efa78","5d43e414cf4f03005944344c","5d43eb42db365100640dbe4a","5d43ee6c78121b0057bc1dbf","5d9a18b4afc33400126c4e6f","5dc4f96dbb5da3006c8f5660"],"_id":"5864d2df79ce642d00f0fec7","createdAt":"2016-12-29T09:09:51.074Z","project":"56439dfe9eebf70d00490d54","releaseDate":"2016-12-29T09:09:51.074Z","__v":18},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"Aggregation API","slug":"aggregation-api","order":32,"from_sync":false,"reference":false,"_id":"5d43d61a5bdac50011b6f234","project":"56439dfe9eebf70d00490d54","version":"5864d2df79ce642d00f0fec7","createdAt":"2019-08-02T06:20:10.706Z","__v":0},"user":"5d411a29005b9600113731fd","createdAt":"2019-08-02T06:30:59.108Z","__v":1,"parentDoc":null}

getResource Subtype Aggregation API


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

type:
required
stringresource

Body Params

q:
required
string
Query * -to get overall aggregation Query keywords - to get aggregation of matching documents.
aggBy:
required
string
String Field name to aggregate on Here,“contentSubFormat”
aggSize:
integer10
Limit of aggregated values to return.

Headers

Authorization:
required
stringHeader
Token [access_token]

Result Format


Documentation

[block:parameters] { "data": { "0-0": "aggregations", "0-1": "JSON Array", "0-2": "Array of object", "h-0": "Key", "h-1": "Data Type", "h-2": "Description" }, "cols": 3, "rows": 1 } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}