Interactions Search
Learn about searching interactions.
This operation allows you to search interactions in the tenant data.
Request - You can use one of the following endpoints to search for interactions:
GET {TenantURL}/interactions
GET {TenantURL}/interactions/_search
POST {TenantURL}/interactions/_search
POST
method and pass the parameters through
the request body.Parameter | Name | Required | Details |
---|---|---|---|
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. |
select |
No | This is a comma-separated list of properties from interaction
structure that must be returned in a response. Allows you to return a
partial interaction object. Additional system properties are as follows:
select=URI,label,attributes._lookupCodes,attributes._lookupValues . |
|
max |
No | This parameter represents positive integer value to identify the
maximum number of interactions to return in a response. Can be used to
organize pagination in combination with the offset
parameter. The default value is 50. |
|
offset |
No | This parameter represents positive integer value to identify what
element in a result set must be returned in a response. Can be used to
organize pagination in combination with the max
parameter. The default value is 0.Note: The updated maximum value and offset
parameters, when combined, must not exceed the value of 10,000. Some
examples of valid combinations are:
|
|
sort |
No | Sort parameter is used with Order parameter. Sort
parameter points to the attribute or a list of attributes where ordering
must be applied. If you order the result set as ascending or descending
(reversed), you must use the Sort parameter to list the attributes that
must be used for ordering.Important: The sorting will not be
used if this parameter is not provided or the value is not
recognized. Sorting is available on multiple parameters combining
the parameters using & sign. The & symbol is
encoded as %26 in the request. Sorting priority of the parameters depends upon the order you have added the parameters in the request while using multiple sorting. For example,sort=attributes.FirstName sort=attributes.FirstName&attributes.LastName
. At first the resultset is sorted alphabetically by
Then the sorted
result set will be sorted again by
|
|
order |
No | This parameter indicates the order of sorting and is applicable only
in combination with the sort parameter. The possible
values are as follows:
asc . For example,
order=desc . |
|
options |
No | This is a comma-separated list. sendHidden is
disabled by default. The interaction's JSON contains hidden attributes
if this option is enabled. For example,
options=sendHidden . |
|
defaultMaxValues |
No | This parameter specifies the maximum number of values listed in the
attributes. This restriction is intended for UI convenience in the case
of very long lists of values in some attributes. For example,
defaultMaxValues=10 . |
|
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. Example:
|
Response
JSON array of interaction objects from the tenant (that match the filter request) in the format and order that is defined by the query parameters.
Request
GET {TenantURL}/interactions?filter=(equals(type,'configuration/interactionTypes/Order'))&max=2
Headers: Authorization: Bearer 204938ca-2cf7-44b0-b11a-1b4c59984512
Response
[ { "URI": "interactions/20", ... },
{ "URI": "interactions/142", ... } ]
Search by Members
You can search for members in the following ways:
- Search by members' IDs through all member types using
equals(members,7fpyJI3)
. - Search by members' IDs with the specified member type using
equals(members.Individual.id,7fpyJI3)
. - Search by members' types using
equals(members.types,'Organization')
.