{"type":"api","title":"Cellular Aggregation","meta":{"id":"/apps/pubhub/media/cisco-catalyst-sd-wan-api-guide-20-18/1c4807bcb76af36988ebb37dc2e455b1787a155e/d2f02ba2-fd0d-3a26-bcc5-feafc8f24d17","info":{"title":"Monitoring and Troubleshooting","description":"Includes API operations for the following:\n- Real-time monitoring\n- Accessing statistics APIs and statistics bulk APIs\n- Retrieving device state\n- Managing alarms and events\n","contact":{"email":"vmanage@cisco.com"},"version":"20.18 - 2025-08-15"},"openapi":"3.1.0","servers":[{"url":"/dataservice"}]},"spec":{"tags":["Monitoring - Cellular-EIOLTE"],"description":"Get aggregated data based on input query and filters. The data can be filtered on time and other unique parameters based upon necessity and intended usage","operationId":"cellularAggregation","requestBody":{"description":"Stats query string","content":{"application/json":{"schema":{"type":"object","properties":{"aggregation":{"type":"object","properties":{"field":{"type":"array","items":{"required":["property","size"],"type":"object","properties":{"order":{"type":"string","enum":["asc","desc"]},"orderType":{"type":"string","writeOnly":true,"enum":["key","count"]},"property":{"type":"object"},"sequence":{"type":"integer","format":"int32"},"size":{"type":"integer","format":"int32"},"type":{"type":"string"}},"$$ref":"#/components/schemas/DBQueryAggregationFieldObject"}},"histogram":{"required":["order","property","type"],"type":"object","properties":{"interval":{"type":"integer","format":"int32"},"mindoccount":{"type":"integer","format":"int64"},"order":{"type":"string","enum":["asc","desc"]},"property":{"type":"object"},"type":{"type":"string","enum":["YEAR","QUARTER","MONTH","WEEK","DAY","HOUR","MINUTE","SECOND"]}},"$$ref":"#/components/schemas/DBQueryAggregationHistogramObject"},"metrics":{"type":"array","items":{"required":["property","type"],"type":"object","properties":{"order":{"type":"string"},"property":{"type":"object"},"sequence":{"type":"string"},"size":{"type":"string"},"type":{"type":"string","enum":["AVG","AVG_IF","COUNT","SUM","MAX","MIN","uniq","TOP_HITS","argMax","GROUP_BIT_OR"]}},"$$ref":"#/components/schemas/DBQueryAggregationMetricObject"}}},"$$ref":"#/components/schemas/DBQueryAggregationObject"},"category":{"type":"string"},"fields":{"type":"array","items":{"type":"object"}},"plot_data":{"type":"array","items":{"type":"string"}},"query":{"required":["rules"],"type":"object","properties":{"condition":{"type":"string","enum":["AND","OR"]},"field":{"type":"object"},"operator":{"type":"string","enum":["between","in","not_in","equal","not_equal","less_or_equal","greater","greater_or_equal","less","last_n_hours","last_n_days","last_n_weeks","hasAny","starts_with","last_n_minutes"]},"rules":{"type":"array","items":{"type":"object","properties":{"condition":{"type":"string","enum":["AND","OR"]},"field":{"type":"object"},"operator":{"type":"string","enum":["between","in","not_in","equal","not_equal","less_or_equal","greater","greater_or_equal","less","last_n_hours","last_n_days","last_n_weeks","hasAny","starts_with","last_n_minutes"]},"rules":{"type":"array","items":{"$ref":"#/components/schemas/DBQueryRuleObject","$$ref":"#/components/schemas/DBQueryRuleObject"}},"type":{"type":"string","enum":["int","string","long","double","date","specialString","number","array","boolean"]},"value":{"type":"array","items":{"type":"string"}}},"$$ref":"#/components/schemas/DBQueryRuleObject"}},"type":{"type":"string","enum":["int","string","long","double","date","specialString","number","array","boolean"]},"value":{"type":"array","items":{"type":"string"}}},"$$ref":"#/components/schemas/DBQuerySpecObject"},"size":{"type":"integer","format":"int32"},"sort":{"type":"array","items":{"required":["field","order"],"type":"object","properties":{"field":{"type":"object"},"order":{"type":"string","enum":["asc","desc"]},"type":{"type":"string","enum":["int","string","long","double","date","specialString","number","array","boolean"]}},"$$ref":"#/components/schemas/DBQuerySortObject"}}},"description":"Statistics search DB Query JSON object","$$ref":"#/components/schemas/StatisticsDBQueryParam"},"examples":{"cellular aggregation":{"description":"cellular aggregation","value":{"query":{"condition":"AND","rules":[{"field":"entry_time","type":"date","value":["1"],"operator":"last_n_hours"},{"field":"rat","type":"string","value":["Unknown"],"operator":"not_equal"},{"field":"bandclass","type":"string","value":["Unknown"],"operator":"not_equal"}]},"aggregation":{"field":[{"sequence":1,"orderType":"count","size":5000,"property":"carrier","order":"desc"},{"sequence":2,"orderType":"count","size":5000,"property":"host_name","order":"desc"},{"sequence":1,"size":5000,"property":"vdevice_name","order":"desc"}]}}}}}},"required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object"},"examples":{"Carrier List":{"description":"Carrier List","value":{"data":[{"carrier":"Test PLMN 1-1","vdevice_name":"172.16.255.101","host_name":"pm1-Slot2","count":86}]}}}}}},"400":{"description":"Bad Request"},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}},"x-roles-required":"default,dca","method":"post","path":"/statistics/eiolte/cellularAggregation"}}