DEdepict
Search
V3

Get Results

Changed on
post/v3/search/results

Request

  • Base URL
    https://api.depict.ai (the document declares no server; this is the origin it was published from)
  • URL
    https://api.depict.ai/v3/search/results
  • Auth
    none declared

Query parameters

portinteger nullable

Request body

cursorstring nullable

Used for cursor-based pagination. Set it to the cursor from the last response. If not set, will return the first results.

limitinteger nullable

Used for cursor-based pagination. Maximum number of results per response.

pageinteger nullable

Used for Page-based pagination. 1-based index

hits_per_pageinteger nullable

Used for Page-based pagination. If using page-based pagination, this is a required field.

marketstring required
session_idstring nullable

Session identifier

metadataobject nullable

Metadata that can be used to modify the behaviour of the search.

merchantstring required
localestring required
querystring nullable

The search query.

Response

Realtime-assembled pages include both serving-engine body fields. Legacy proxy pages preserve the upstream body. The response header identifies the serving engine on both paths; absence of both body field and header means unobserved.

OR

Changes

  • 9999b1c40f02Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added to the response body anyOf list for the response status