media

Returns the items in the campaign media library and, by default, the organisation media library. Items from another organisation are never returned. Use q to search the image analysis (description, alt text, tags, and visible text) and the other filters to narrow the list. Search and filters need the media library revamp; without it, a request with any filter other than scope returns an empty list, and scope picks the campaign library, the organisation library, or both.

For custom components:

RaiselyComponents.api.one('campaigns', '{campaign}').all('media').get(params = {}, headers = {}) => Promise<{result}>

See Restie Response Data for a more detailed overview of responses through the client wrapper

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

The uuid, path or domain of the campaign to associate with the request

Query Params
string
enum
Defaults to both

Which library to list. both merges the campaign and organisation libraries.

Allowed:
string
length ≤ 200

Words to find in the description, alt text, tags, or visible text

string

Comma-separated tags. Items must have every tag.

string

Comma-separated MIME types. A type family such as image/* matches every image. A leading ! leaves a type out, so !image/* lists every item that is not an image.

string
enum
Allowed:
integer
≥ 1

Smallest width in pixels

integer
≥ 1

Smallest height in pixels

string

Comma-separated analysis statuses: not_analysed, pending, complete, failed, skipped_no_consent, or unsupported

Responses

400

Invalid filter value

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