Search artifacts

Version 4.0.24.16

Search all key/value pairs in a namespace for matching criteria.

Returns an array of artifacts matching the specified search criteria.

Key search patterns use case-insensitive matching and can contain % and _ as SQL LIKE pattern match wildcard expressions.

The parameters min_size and max_size can be used individually or together.

  • min_size finds artifacts with sizes greater than or equal to its value
  • max_size finds artifacts with sizes less than or equal to its value
  • using both parameters restricts the minimum and maximum size range for artifacts

NOTE: Artifacts are always returned in alphanumeric order by key.

Get a single artifact by namespace and key with artifact

Note: The artifact storage API can only be used by Looker-built extensions.

Request

GET /artifact/{namespace}/search
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
namespace
string
Artifact storage namespace
query
HTTP Query
Expand HTTP Query definition...
fields
string
Comma-delimited names of fields to return in responses. Omit for all fields
key
string
Key pattern to match
user_ids
string
Ids of users who created or updated the artifact (comma-delimited list)
min_size
integer
Minimum storage size of the artifact
max_size
integer
Maximum storage size of the artifact
limit
integer
Number of results to return. (used with offset)
offset
integer
Number of results to skip before returning any. (used with limit)

Response

200: Artifacts

Datatype
Description
(array)
key
string
Key of value to store. Namespace + Key must be unique.
value
string
Value to store.
content_type
string
MIME type of content. This can only be used to override content that is detected as text/plain. Needed to set application/json content types, which are analyzed as plain text.
version
integer
Version number of the stored value. The version must be provided for any updates to an existing artifact.
namespace
string
Artifact storage namespace.
created_at
string
Timestamp when this artifact was created.
updated_at
string
Timestamp when this artifact was updated.
value_size
integer
Size (in bytes) of the stored value.
created_by_userid
string
User id of the artifact creator.
updated_by_userid
string
User id of the artifact updater.

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link