Inspect

List artifacts

List or search published artifacts. Supports cursor pagination and optional text search.

Base URL
GET
/api/public/v1/artifacts

List or search published artifacts. Supports cursor pagination and optional text search.

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key authentication. Use your API key as the bearer token.

Query Parameters

first?integer

Number of results to return (max 100). Defaults to 50 when last is not set.

Formatint32
Range1 <= value <= 100
after?string

Cursor for pagination. Use meta.page.end_cursor from a previous response.

Lengthlength <= 1024
last?integer

Number of results to return when paginating backward (max 100). Use before to return results before a cursor. Mutually exclusive with first and after.

Formatint32
Range1 <= value <= 100
before?string

Cursor for backward pagination. Mutually exclusive with first and after.

Lengthlength <= 1024
aggregates?string

Comma-separated aggregates to include. Supported aggregates: total_count.

Match^\s*(total_count)?\s*(,\s*(total_count)?\s*)*$
Lengthlength <= 1024
query?string

Full-text search across title, URL, and description.

Length1 <= length <= 200
kind?string

Filter artifacts by kind.

Value in"link""doc""ticket""message""channel""dashboard""pdf""design""feature_flag""file""session_replay"

Response Body

List results for artifacts

application/json
  1. response
data*array<>
meta*
Example Request
curl -X GET 'https://your-org.inspect.com/api/public/v1/artifacts'
Example Response
{  "data": [    {      "id": "string",      "title": "string",      "url": "http://example.com",      "description": "string",      "kind": "link",      "metadata": {},      "created_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": {      "start_cursor": "string",      "end_cursor": "string",      "has_next_page": true,      "has_previous_page": true    },    "aggregates": {      "total_count": 0    }  }}