Acquia DAM (Widen)
How do I search for assets via the API?
Most searches performed in Acquia DAM can also be executed through the REST API. For basic queries, use the Asset Search endpoint.
To search across asset groups, categories, filenames, and tags, you can use search shortcuts to construct the search query parameter.
You can combine multiple queries in your search string. For example, to search for all assets with a category of "sales" and "event" in the filename:
cat:sales fn:event
Resulting query string:
https://api.widencollective.com/v2/assets/search?query=cat:sales%20fn:event
For searches targeting metadata fields, do not use search shortcuts. Metadata field display names can change, which can break the shortcut and search string.
Instead, use the unique field display key. Each metadata field has a permanent display key that does not change when the display name is edited. Using display keys ensures that your integration references the correct field.
Display keys are not accessible directly in the Acquia DAM user interface. To retrieve display keys, make an API request to the Viewable Metadata Fields endpoint using a REST client such as Postman.
You can include semantic Natural Language Search (NLS) results alongside standard keyword results in API queries by using the include_natural_language_results query parameter with the Asset List by Search Query endpoint (/v2/assets/search).
Parameter: include_natural_language_results
Type: boolean
Default: false
Natural Language Search must be enabled in your Acquia DAM instance before the API parameter returns NLS results. To enable this feature:
In Acquia DAM, navigate to the Admin menu.
Select Global settings.
Enable the Natural Language Search toggle.
For full endpoint specifications and response schemas, refer to the Acquia DAM API v2 Asset Search Documentation.
You can include semantic Natural Language Search (NLS) results alongside standard keyword results in API queries by using the include_natural_language_results query parameter with the Asset List by Search Query endpoint (/v2/assets/search).
Parameter: include_natural_language_results
Type: boolean
Default: false
Natural Language Search must be enabled in your Acquia DAM instance before the API parameter returns NLS results. To enable this feature:
In Acquia DAM, navigate to the Admin menu.
Select Global settings.
Enable the Natural Language Search toggle.
For full endpoint specifications and response schemas, refer to the Acquia DAM API v2 Asset Search Documentation.
If this content did not answer your questions, try searching or contacting our support team for further assistance.
If this content did not answer your questions, try searching or contacting our support team for further assistance.
Acquia DAM (Widen)