Search API

Find the assets you need

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This page shows the POST method, but you can also use GET.

The Search API returns a list of all the assets that match the search criteria. Each asset is an item that contains the information you requested in the fields parameter.

In addition, for users with the Search API - Allow search on all documents Security Function, the Search API returns the following information in the Global Information (GlobalInfo) object:

  • TotalCount: The total number of assets that match the criteria included in the query parameter.
  • QueryDurationinMilliseconds: The query duration in milliseconds.
  • Sort: The sort method used.
  • NextPage: A link to the search’s next page of results, based on the countperpage and pagenumber.
Body Params
string

Criteria and search terms that describe the attributes assets must have to be returned, in the format criterion:search_term. To include multiple criteria, separate each search term with the query operators NOT, AND, and OR. Use parentheses to perform advanced searches by applying one criterion to multiple other search terms.

For example, let’s say you want to find assets that:

  • Are tagged with the term Flower or Flowers.
  • Are tagged with the term Autumn.
  • Have the word “sunlit” in their description field.
  • Do not include the word “cold” in their description field.
  • Are images or videos.
You’d use the following query parameter:
keyword:(Flower OR Flowers) Autumn AND (CoreField.Description:sunlit NOT cold) AND (DocType:Image OR Video)

Notes:
  • You can use a space ( ) instead of AND.
  • For query construction details and a list of standard Orange Logic criteria, go to query construction.
  • To find the specific criteria available for your organization’s Orange Logic environment, use the List Criteria API call.
  • You can only include one query parameter in your call. Use operators to include multiple criteria or search terms.

string

The search words or phrase. This option uses Orange Logic’s AI search feature to perform the search. Orange Logic users with Link accounts can go to the AI search article to learn more.
When you use the semanticquery and query parameters at the same time, Orange Logic prioritizes search terms in this order:

  1. The text and title criteria in the query parameter (if applicable).
  2. The text in the semanticquery parameter.
  3. Other criteria in the query parameter (if applicable).
Notes:
  • When you use this parameter, only 100 results are returned.
  • This parameter is available for beginning in Orange Logic Ottawa. It is deactivated by default. To learn how to activate it, go to the AI search article.

string

The algorithm that determines the order in which search results are returned. You can choose from these options:

  • relevancy: Assets are sorted from most relevant to least relevant based on Orange Logic’s relevancy algorithm. This algorithm is based on a number of factors, such as tags in the context of the total number of tags applied to the asset, the title and description of the asset, keywords of the parent folder(s), tags extrapolated from the tag tree, and more. Each of these elements has different weightings applied to them.
  • newest first: Assets are sorted from newest to oldest, based on their Create Date.
  • oldest first: Assets are sorted from oldest to newest, based on their Create Date.
  • editor choice: Assets are sorted from highest rating to lowest rating, based on the Editor Choice field.
  • file name: Assets are sorted from A to Z, based on their filename.
  • file name DESC: Assets are sorted from Z to A, based on their filename.
  • file size: Assets are sorted from smallest to largest, based on their size.
  • file size DESC: Assets are sorted from largest to smallest, based on their size.
  • last changed: Assets are sorted from newest to oldest, based on their Date Last Edited.
  • last changed ASC: Assets are sorted from oldest to newest, based on their Date Last Edited.
  • indexed date DESC: Assets are sorted from newest to oldest, based on the date they were most recently indexed.
  • indexed date: Assets are sorted from oldest to newest, based on the date they were most recently indexed.
  • start date DESC: Assets are sorted from newest to oldest, based on the asset’s start date.
  • start date: Assets are sorted from oldest to newest, based on the asset’s start date.
  • manual order: Assets are displayed based on how you reordered them in the container.
  • most popular: Assets are sorted from most downloaded to least downloaded.
Notes:
  • When you use the sematicquery parameter, the returned values are ordered by the AI search’s relevancy score. If multiple assets have the same relevancy score, they are sorted based on the sort option selected here.
  • Your organization might use legacy values for the tag. Those values continue to work, but only currently supported values are listed here.

string

The fields to retrieve from each asset, separated by commas.
For example, let’s say you want to return an asset’s system identifier, title, and description. You’d use the following code as your field parameter: SystemIdentifier, Title, CaptionLong.
Notes:

  • The maximum length for a field value in the Search API is 2048 characters. If your fields have longer values, enter them into the body of the request.
  • To learn about asset paths in Orange Logic environments, go here.
  • To find the specific fields available for your organization’s Orange Logic environment, use the List Fields API call.

int32
Defaults to 100

Number of results returned per page.

int32
Defaults to 1

The page of results you want to retrieve, based on countperpage.
For example, to retrieve page 2 of the search results, you’d enter 2. If countperpage is 100, your search would return result number 100 through result number 199.

boolean
Defaults to false

Whether to return your query’s response details.
When true, the response includes detailed information on how your query was parsed. You can use this parameter to help you troubleshoot your query if you run a search and the results don’t match your expectations.

string

The email address that matches the Orange Logic account of the user to impersonate. This search returns the results the impersonated user would see if they ran the search.

However, when you impersonate another user, you can only view assets you have the Security Functions and Permissions to access. Therefore, if the user you’re impersonating has access to results that you do not have access to, those results are not returned.

boolean
Defaults to false

True: If an asset appears in your search and you’ve requested the path to a format of that asset that hasn’t been generated yet, Orange Logic generates and returns that format. Orange Logic does this for formats generated on demand, such as TRX, CSM1, CMS2, CMS3.
False: If an asset appears in your search and you’ve requested the path to a format of that asset that hasn’t been generated yet, the format is not generated.
For more information, go to the Generate formats on demand article.

boolean
Defaults to false

True: Path requests are returned as permanent asset link URLs.
False: Any Path requests in the fields parameter are returned as expirable URLs to the requested asset proxies. Learn more about the field parameter and asset formats generated on upload
Both types of links are public and distributed through a CDN.

boolean
Defaults to false

True: Returned URIs are unencoded. Note: If the response format is XML (rather than JSON), unencoded URIs are returned within a CData section.
False: Returned URIs are encoded. Use this option to create URIs that are rendered correctly in a web browser.

boolean
Defaults to false

True: Assets that have been soft-deleted are included in the search results.
False: Assets that have been soft-deleted are not included in the search results.
Note: Only users with the Search for Deleted Assets Security Function can retrieve soft-deleted assets.

boolean

True: Storage information is returned for existing asset formats specified in the fields parameter.
False: Storage information is not returned.
Notes:

boolean
Defaults to false

When you include a virtual folder in the path criterion:
True: Returns information about all assets within the folder structure, including assets referenced by virtual folders.
False: Returns information about assets whose primary parent is within the folder structure.
Notes:

  • This parameter is available beginning in Orange Logic Milan. In earlier releases, the Search API does not return information about asset references in virtual folders.

string
enum
Defaults to XML

Response format; can be XML or JSON.

Allowed:
string
Response

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json