Getting started

POST /api/endpoint-management/report/$search
<!--NeedCopy-->

 {  
    "segment": "applications",  
    "joins": ["devices"],
    "filter" : {        
       "applications.name": {
         "$eq": "Secure Browse"
       },
       "devices.platform": {
         "$eq": "iOS"
       }           
    },
    "order": {
        "name": "$asc",
        "totalSuccess": "$desc"                  
    }
    "exclude": ["devices.platform" , "applications.version"],
    "limit": 10
  }
<!--NeedCopy-->

GET /api/endpoint-management/report/{SEGMENT}?s=`{JOINS}`&i={`INCLUSIONS`}&x={`EXCLUSIONS`}&l={`LIMIT`}
<!--NeedCopy-->

- ROOT_SEGMENT: `String`

  Main segment to query for.  One of: devices,applications,users,enrollments,delivery-groups
 
- JOINS: `JsonArray` 

  These are additional segments to join into the main segment. At least, one of: devices,applications,users,enrollments,delivery-groups (not equal to SEGMENT).

- FILTER: `JsonValue` 

  JSON formatted specification of filters. In multi-segment queries, these fields need to be properly qualified using the recommended dot-separated (U+002E FULL-STOP, “.”) field syntax (e.g. applications.name)

    Name | Alias
    ---- | ------------- 
    $ne  | Not equal
    $eq  | Equal     
    $lt  | Less than
    $le  | Less than or equal
    $gt  | Greater than
    $ge  | Greater than or equal
    $in  | Performs a logical OR
    $nin | Not In - Excludes data that is specified from results.
    $sw  | Starts with - Query data that start with the specified String
    $nsw | Not Starts with - Query data that not start with the specified String
 
- ORDER: `JsonValue` 
  
   JSON formatted list of hints of field/direction. In multi-segment queries, these fields need to be properly qualified using the recommended dot-separated (U+002E FULL-STOP, “.”) field syntax (e.g. applications.name)
   
   Name | Alias
   ------------ | ------------- 
   $asc | Ascending  
   $desc | Descending
   
- AGGREGATES: `JsonValue` 

   JSON formatted list of aggregate operations.  Each operator entry will dynamically create a new column in the report `<operator`Of`<fieldName>`. Example: *sum*Of*TotalDeployment*. In multi-segment queries, these fields need to be properly qualified using the recommended dot-separated (U+002E FULL-STOP, “.”) field syntax (e.g. applications.name)
   
    Name | Alias
    ------------ | ------------- 
    Sum | $sum
    Count distinct | $distinct
    Count | $count
    Average | $avg
    Max | $max
    Min | $min

- EXCLUSIONS: `JsonArray` 
  
  JSON formatted array of column names to exclude from the final output. In queries involving multiple segments, these fields need to be properly qualified using the recommended dot-separated (U+002E FULL-STOP, “.”) field syntax.
  
- LIMIT: `Integer` 

   Numerical value < [Max Result Set](#max-result-set)

<!--NeedCopy-->

{
   "items": [
      {
         name: "Secure Mail",
         platform: "Android",
         lastUserId: "luisat",
         type: "MDX"         
      },
      {
         name: "Slack",
         platform: "Android",
         lastUserId: "emmanuelc",
         type: "SaaS"         
      }
   ]
}
<!--NeedCopy-->

name,platform,lastUserId,type
Secure Mail,Android,luisat,MDX
Slack,Android,emmanuelc,SaaS 
<!--NeedCopy-->