GuidesChangelogAPI Reference
API Reference

/api/v5/asset/

get
https://percolate.com/api/v5/asset/

Get a list of assets by ids.

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

A CSV of unique Asset IDs to filter by.

string

A CSV of scope IDs to filter by.

boolean
Defaults to false

Look inside any child scopes in addition to the supplied ones.

string

Filter by root campaign ID (IMC).

string

A CSV of unique campaign IDs to filter by.

string

A CSV of unique object IDs to filter by.

string
Defaults to owned

Filter objects owned by the scope itself and/or shared from other scopes ^(owned|shared)$.

string

Filter objects by CSV of keywords.

{metadataSearch}
object

This is a dynamic query parameter name, used to filter endpoint response by its metadata field. The {schemaFieldId} template represents the schema id and field name concatenated together by a dot (.). In effect, it expands to the sub-template {schema-id}.{schema-field-name}. The {schema-id} template is the UID of a schema. The {schema-field-name} template is a path separated by the forward slash (/) (to allow for representation of nested objects).
The value of the query parameter is a CSV of strings appropriate for the given metadata field.
Valid options are:
metadata.{schemaFieldId}: string
 has_metadata.{schemaFieldId}: true - Filter by the existence of a metadata field.
metadata.{schemaFieldId}.from: string (date) - Filter by a metadata date field (inclusive)
 metadata.{schemaFieldId}.to: string (date) - Filter by a metadata date field (exclusive).

See the examples for each valid option:
metadata.schema:1.live_date_range
 has_metadata.schema:1.live_date_range
metadata.schema:1.live_date_range/from
 metadata.schema:1.live_date_range/to

integer

Limit the number of paginated results.

integer

A 0-based offset to adjust the pagination window.

string
enum

Apply this to any method that supports sorting.

Allowed:
string
enum

Control order direction.

Allowed:
date-time

Filter by created_at date (inclusive).

date-time

Filter by created_at date (exclusive).

date-time

Filter by updated_at date (inclusive).

date-time

Filter by updated_at date (exclusive).

enum

Filter by CSV of asset types.

string

Includes related items in the response. (creator_id|folder_id|shares).

string

Filter assets by CSV of content types.

string

Filter by CSV of creating user.

string

Filter by CSV of orientations (square|landscape|portrait).

string

Filter by CSV of sizes (small|medium|large|extra_large).

string

Filter by containing folder. The root folder (folder:primary) is assumed if no value is given. All query paramters apply to only the contents of a single folder unless the recursive parameter is also used. Use the value folder:trashcan to apply query parameters to deleted assets. Use folder:shared to apply query parameters to shared assets.

boolean

Perform a deep search if presented with the value true. Combine with the folder_id query parmeter to perform a deep search from a specific folder. The default is to search only the contents of the folder specified with the folder_id parameter or otherwise the root folder.

string

Exclude specific folder types. Current valid options are ingested. Passing ingested will exclude assets that are in the ingested folder from being returned.

Response

Updated over 2 years ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago