Get Interactions Total Count
Learn about retrieving the total count of the interactions.
This operation allows you to retrieve the total count of interactions in the tenant data.
Request - You can use one of the following endpoints to search for the total count of interactions:
GET {TenantURL}/interactions/_total
POST {TenantURL}/interactions/_total
POST
method and pass the parameters through
the request body.Parameter | Required | Description | |
---|---|---|---|
Headers | Authorization |
Yes | This parameter provides information about the authentication access
token using the format, Bearer <accessToken> (For
more information see Authentication API. |
Query | filter |
No | This parameter enables interactions filtering by a condition. The
format for filter query parameter is, filter=({Condition
Type}[AND/OR {Condition Type}]*) . For more information, see
Filtering. |
Body (Only for the POST
method) |
No | Indicates the JSON body that can have all the same fields as
supported in the query parameters. Note: The query parameters have
priority and override the body parameters. |
Response
JSON object with the total number of records matching the search filter.
GET and POST Requests
GET
Request
GET {TenantURL}/interactions/_total?filter=(equals(type,'configuration/interactionTypes/Order'))
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
Response
{ "total": 528435326}
POST
Request
POST {TenantURL}/interactions/_total
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
{
"filter": "equals(members,7fpyJI3)"
}
Response
{ "total": 251}