API Usage Count object

You can use the API Usage Count object to query the number of APIs used in a specific time frame.

Structure

<APIUsageCount successCount="" errorCount="" processDate="" classification=""/>

Field	Type	Description
Filter	Filter	Filter
successCount	numeric	The count of successful process runs, where a successful run is one with a status of complete.
errorCount	numeric	The count of unsuccessful process runs, where the status is error or aborted.
processDate	dateTime (yyyy-MM-dd'T'HH:mm:ss'Z') — for example, 2017-09-01T00:00:00Z	The start time of the day, in UTC.
classification	string	The environment classification.

Supported operations

GET	QUERY	CREATE	UPDATE	DELETE	EXECUTE
Not supported	Supported	Not supported	Not supported	Not supported	Not supported

You can use the following fields as QUERY filters for the API Usage Count object:

Field	Allowed value
Filter	Filter
successCount	Total number of successful calls for the deployed APIs on the processDate.
errorCount	Total number of error calls for the deployed APIs on the processDate.
processDate	Date with the format yyyy-MM-dd'T'HH:mm:ss'Z' — for example, 2017-09-01T00:00:00Z.To specify a time block, use the BETWEEN operator with two arguments, one representing the start time and the other representing the end time. Boomi recommends specifying a time block in all queries, particularly for heavy users of Low Latency processes, as a means of preventing the return of excessively large amounts of data.
classification	PROD or TEST

SOAP implementation

The following example query returns APIs with their success and error counts.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/"<soapenv:Header/>
   <soapenv:Body>
      <api:query>
         <!--Optional:-->
         <api:objectType>ApiUsageCount</api:objectType>
         <!--Optional:-->
         <api:queryConfig>
            <api:QueryFilter>
            <api:expressionoperator="and"
                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:GroupingExpression"
                 <api:nestedExpressionoperator="GREATER_THAN" property="successCount"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression"
                   <api:argument>0</api:argument>
                 </api:nestedExpression>
                 <api:nestedExpressionoperator="GREATER_THAN" property="errorCount"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression"
                   <api:argument>0</api:argument>
                 </api:nestedExpression>
                  </api:expression>
            </api:QueryFilter>
         </api:queryConfig>
      </api:query>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/"<S:Body>
      <bns:queryResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"<bns:results numberOfResults="2"
            <bns:result xsi:type="bns:ApiUsageCount" successCount="1" errorCount="1" processDate="2017-02-07T05:00:00Z" classification="PROD"/>
            <bns:result xsi:type="bns:ApiUsageCount" successCount="12" errorCount="356" processDate="2017-02-08T05:00:00Z" classification="PROD"/>
         </bns:results>
      </bns:queryResponse>
   </S:Body>
</S:Envelope>

The maximum number of results returned per QUERY response is 100. This response includes a queryToken element, which means there are more than 100 results to retrieve. The Query paging topic describes how to use a queryMore call to retrieve more results.