Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - ApiUsageCount

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

ApiUsageCount

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

Required Privileges

Write access

  • N/A

Read access

  • API — Use the Boomi Platform API to access account data.
  • ACCOUNT_ADMIN — Account configuration and administration.

Queries for an ApiUsageCount object(s)

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: processDate, classification, successCount, errorCount

required
object
required
ApiUsageCountSimpleExpression (object) or ApiUsageCountGroupingExpression (object) (ApiUsageCountExpression)
One of
operator
required
string
Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS"
property
required
string
Enum: "processDate" "classification" "successCount" "errorCount"
argument
Array of strings

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (ApiUsageCount)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "@type": "QueryResult",
  • "result": [
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      },
    • {
      }
    ],
  • "numberOfResults": 6
}

Retrieves additional results for an ApiUsageCount query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (ApiUsageCount)

Response samples

Content type
{
  • "numberOfResults": 0,
  • "queryToken": "string",
  • "result": [
    • {
      }
    ]
}