Description
In the API Explorer, select fields in the Search and Analytics APIs will now contain dynamic auto-populating fields.
Analytics Queries
Note: Users must be logged in to an active account to use this feature.
Certain dimension types in the filter predicates will trigger auto-populating lists of organization entities in the corresponding value field. The dimension and value fields can be found in the request builder following these pseudo-paths:
-
top-level of request body -> filter -> predicates -> dimension
-
top-level of request body -> filter -> predicates -> value
An organization entity's name will appear in the dropdown, but the request builder will automatically convert the name to its corresponding UUID in the request body when called for. Entities populate for the following dimension types:
-
queueId
-
userId
-
divisionId
-
organizationPresenceId
-
systemPresence
-
mediaType
Search Fields
The Search API resources will now contain auto-populating dropdowns for search criteria fields. These dropdowns can be found in the request builder following the pseudo-path:
- top-level of request body -> query -> fields
###Change Category
API
Change Context
The existing Analytics queries in the new API Explorer do not provide organization-level entities for dropdown selection on applicable fields. Similarly, the Search resources do not provide lists of valid search fields in dropdown form.
Change Impact
This will improve the customer experience of request building with API Explorer. The dropdown with friendly names of organization entities will be an improvement over manually entering UUIDs, and similarly selecting from the list of valid search fields for the Search resources will be easier than manually entering search terms and hoping they are valid.
Date of Change
Oct 03, 2022
Impacted APIs
Most Analytics API resources following this pattern
• POST /api/v2/analytics/*/query
Most Search API resources following this pattern
• POST /api/v2/*/search
References
[DEVENGAGE-1018]
[DEVENGAGE-1020]